Skip to content
Permalink
Browse files
ignite-13740: improving the getting started guide
  • Loading branch information
Denis Magda committed Dec 30, 2020
1 parent 260a9fe commit 657f079d0b385d8833e0d497c5d854034e8cef3d
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 46 deletions.
@@ -19,9 +19,9 @@ Apache Ignite is a distributed database for in-memory speed and high-performance
The technical documentation introduces you to the key capabilities, shows how to use certain features of the current Apache Ignite version.

NOTE: Though this alpha release version does not support most of the Apache Ignite functionality,
it introduces several new features, which are to be accompanied with other improvements from the link:https://cwiki.apache.org/confluence/display/IGNITE/Ignite+Enhancement+Proposal[Ignite Enhancement Proposal,window=_blank] list.
it introduces several new features, which are to be accompanied with other improvements from the link:https://cwiki.apache.org/confluence/display/IGNITE/Proposals+for+Ignite+3.0[Ignite Enhancement Proposal,window=_blank] list.

This version of Apache Ignite, incorporating all the best solutions over the past years,
This alpha version of Apache Ignite, incorporating all the best solutions over the past years,
possesses the highest level of usability thanks to the following improvements:

* Schema-first approach: This feature introduces one-to-one mapping between data schemas and caches/tables,
@@ -36,5 +36,5 @@ which means that the schema is defined for a cache/table before its creation.

* Ignite CLI tool: This tool functions as a single sign-on for any operational, management, and development needs.


* See a link:https://cwiki.apache.org/confluence/display/IGNITE/Proposals+for+Ignite+3.0[full list of improvements,window=_blank].

@@ -14,8 +14,8 @@
// limitations under the License.
= Getting Started Guide


This guide provides essential details on how to work with the Ignite CLI tool, including the following information:
This guide provides essential details on how to start working with Ignite 3.0 by using the Ignite CLI tool,
including the following information:

* How to download and install the tool
* How to manage nodes using the Ignite CLI tool
@@ -24,7 +24,7 @@ This guide provides essential details on how to work with the Ignite CLI tool, i
== Prerequisites


Ignite was tested on:
Ignite 3.0 was officially tested on:

include::../includes/prereqs.adoc[]

@@ -41,65 +41,81 @@ To download and install the Ignite CLI Tool, follow the steps below:
mkdir ignite3 && cd ignite3
----

. Download the Ignite CLI tool and set permissions. Your command might look like this:
. Download the Ignite CLI tool and set required execute permissions:
+
[source, shell]
----
wget https://dist.apache.org/repos/dist/dev/ignite/3.0.0-alpha1-rc1/ignite && chmod +x ignite
curl https://dist.apache.org/repos/dist/dev/ignite/3.0.0-alpha1-rc1/ignite -o ignite && chmod +x ignite
----

. Add the new folder to the PATH. Your command might look like this:
. Add your installation directory to the PATH environment variable:
+
[source, shell]
----
echo 'export PATH="{your ignite3 folder}:$PATH"' >> ~/.bash_profile
echo 'export PATH="'`pwd`':$PATH"' >> ~/.bash_profile && source ~/.bash_profile
----

== Work with Ignite CLI Tool
== Using Ignite CLI Tool

Ignite CLI tool is a single entry point for all the Ignite operations.
For example, it allows you to perform the following actions:
Ignite CLI is a single entry point for all the Ignite operations. For example, it allows you to perform the following
actions:

* Manage existing nodes
* Install new nodes
* Update old nodes to new versions
* Install or remove optional modules

=== First Run
. Use the command below to see the full list of the <<Ignite CLI Tool Commands>>:
+
[source, shell]
----
ignite
----

Before starting to manage nodes, perform the following steps:
. Pass the `--help` parameter to the previous command to get its detailed description:
+
[source, shell]
----
ignite init --help
----

. Use the `ignite` command to see the full list of commands.
To learn more about the Ignite CLI tool supported commands, see the <<Ignite CLI Tool Commands>>
== Installing Ignite Artifacts and Dependencies

. Use the `ignite init --help` command as an example of how to get help for a particular command.
To start an Ignite 3.0 cluster, you need to install Ignite core artifacts first:
+
[source, shell]
----
ignite init
----

. Use the `ignite init` command to install Ignite core artifacts that are required to run nodes locally.
Ignite CLI allows to install optional Ignite modules and 3rd party Maven dependencies. For instance, install
the Guava library by following the steps below.

. [Optional step] Add modules or dependencies.
The `module list` command eventually shows the list of optional Ignite modules, but none are available at the moment.
However, a Maven dependency can still be added using the command similar to the following:
. Use the `module add` command to download Guava from Maven and add it to the Ignite classpath:
+
[source, shell]
----
Ignite module add mvn:artifactId:groupId:version
ignite module add mvn:com.google.guava:guava:23.0
----
. Confirm the library is added to the Ignite dependencies list:
+
It downloads the modules from Maven and adds a classpath to the server.
[source, shell]
----
ignite module list
----

=== Starting a Node
== Starting a Node

This section explains how to start a node, how to stop it,
and how to perform other basic operations with a node.
This section explains how to start a node, how to stop, and perform other basic operations with it.

. To start a node, use the command below:
. Start a cluster node setting `myFirstNode` as a node unique identifier:
+
[source, shell]
----
ignite node start
ignite node start myFirstNode
----

. To view the list of currently running nodes, use the following command:
. Confirm the node is started and running:
+
[source, shell]
----
@@ -111,24 +127,13 @@ This command also displays the path to the log file.
. To view the log, use the log file path from the previous step result. To open the log file, use any suitable approach.
For example, use the `cat` command for Linux.

. To stop a node, use the command below:
+
[source, shell]
----
ignite node stop
----
+
Specify the `consistent-id` parameter for a certain node.


=== Managing a Cluster

== Working With the Cluster

The Ignite CLI tool also allows to perform some operations with a cluster using the `config` command.

See some of the examples below:

* To read the cluster configuration, use the command:
* Read the cluster configuration:
+
[source, shell]
----
@@ -137,16 +142,29 @@ ignite config get
+
It can be performed either for the whole tree or filtered via the `--selector` option.

* To update a property, follow the pattern below. Your command might look like this:
* Update the baseline topology auto-adjustment timeout:
+
[source, shell]
----
ignite config set local.baseline.autoAdjust.timeout=20000
----
* Confirm the change is applied:
+
[source, shell]
----
ignite config get --selector=local.baseline.autoAdjust.timeout
----

== Stopping the Cluster

== Next Steps
. To stop the node, use the command below passing `myFirstNode` as a node unique identifier:
+
[source, shell]
----
ignite node stop myFirstNode
----

== Next Steps

From here, you may want to:

@@ -157,7 +175,6 @@ From here, you may want to:

== Ignite CLI Tool Commands


The Ignite CLI tool uses REST API as a communication protocol between the node and the CLI,
allowing you to configure the node.

0 comments on commit 657f079

Please sign in to comment.