This is an automated email from the ASF dual-hosted git repository. dmagda pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/ignite-3.git
The following commit(s) were added to refs/heads/main by this push: new 260a9fe Ignite 13740: documentation rewamp for Ignite 3.0 (#21) 260a9fe is described below commit 260a9fec26ec64550bbfdd73ad6f97333220dca3 Author: Nikita Safonov <73828260+nikita-tech-wri...@users.noreply.github.com> AuthorDate: Wed Dec 30 23:17:22 2020 +0300 Ignite 13740: documentation rewamp for Ignite 3.0 (#21) * IGNITE-13740: Create a "Getting Started" documentation page for Ignite 3.0 * IGNITE-13740: Updated version number * IGNITE-13740: Made a documentation rewamp for Ignite 3.0 * IGNITE-13740: Made a documentation rewamp for Ignite 3.0 * IGNITE-13740: Made a documentation rewamp for Ignite 3.0 --- docs/_data/toc.yaml | 2 - docs/_docs/includes/prereqs.adoc | 3 +- docs/_docs/quick-start/getting-started-guide.adoc | 178 +++++++++++++++++----- 3 files changed, 144 insertions(+), 39 deletions(-) diff --git a/docs/_data/toc.yaml b/docs/_data/toc.yaml index 8cfc052..e991cfb 100644 --- a/docs/_data/toc.yaml +++ b/docs/_data/toc.yaml @@ -16,6 +16,4 @@ url: index - title: Getting Started Guide url: quick-start/getting-started-guide -- title: Installation - url: installation/installing-using-exe diff --git a/docs/_docs/includes/prereqs.adoc b/docs/_docs/includes/prereqs.adoc index 013b732..0546cd7 100644 --- a/docs/_docs/includes/prereqs.adoc +++ b/docs/_docs/includes/prereqs.adoc @@ -15,5 +15,6 @@ [width="100%",cols="1,3"] |=== |JDK | 11 and later -|OS |Linux (Ubuntu 20.04), Windows (10 Home), MacOS +|OS |Linux (Ubuntu 20.04), Windows (10 Home), macOS |=== + diff --git a/docs/_docs/quick-start/getting-started-guide.adoc b/docs/_docs/quick-start/getting-started-guide.adoc index 3fa6bee..efa1f0f 100644 --- a/docs/_docs/quick-start/getting-started-guide.adoc +++ b/docs/_docs/quick-start/getting-started-guide.adoc @@ -14,12 +14,48 @@ // limitations under the License. = Getting Started Guide -== Configuration -Apache Ignite uses HOCON configuration format. -For more detail, please see the link:https://github.com/lightbend/config/blob/master/HOCON.md[HOCON documentation,window=_blank]. +This guide provides essential details on how to work with the Ignite CLI tool, including the following information: + +* How to download and install the tool +* How to manage nodes using the Ignite CLI tool +* Additional information regarding the use of the tool + +== Prerequisites + + +Ignite was tested on: + +include::../includes/prereqs.adoc[] + + +== Installing Ignite CLI Tool + + +To download and install the Ignite CLI Tool, follow the steps below: -== Ignite CLI tool +. Create a folder. For example, use a Linux command similar to the following: ++ +[source, shell] +---- +mkdir ignite3 && cd ignite3 +---- + +. Download the Ignite CLI tool and set permissions. Your command might look like this: ++ +[source, shell] +---- +wget https://dist.apache.org/repos/dist/dev/ignite/3.0.0-alpha1-rc1/ignite && chmod +x ignite +---- + +. Add the new folder to the PATH. Your command might look like this: ++ +[source, shell] +---- +echo 'export PATH="{your ignite3 folder}:$PATH"' >> ~/.bash_profile +---- + +== Work with 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: @@ -29,59 +65,129 @@ For example, it allows you to perform the following actions: * Update old nodes to new versions * Install or remove optional modules -The Ignite CLI tool uses REST API as a communication protocol between the node and the CLI, -allowing you to configure the node. +=== First Run -Below is a list of Ignite CLI tool commands with short descriptions: +Before starting to manage nodes, perform the following steps: -* `init`: Installs Ignite core modules locally. +. 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>> -* `module`: Manages optional Ignite modules and external artifacts. +. Use the `ignite init --help` command as an example of how to get help for a particular command. -- `list`: Shows the list of available optional Ignite modules. -- `add`: Adds an optional Ignite module or an external artifact. -- `remove`: Adds an optional Ignite module or an external artifact. +. Use the `ignite init` command to install Ignite core artifacts that are required to run nodes locally. -* `node`: Starts, stops and manages locally running Ignite nodes. +. [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: ++ +[source, shell] +---- +Ignite module add mvn:artifactId:groupId:version +---- ++ +It downloads the modules from Maven and adds a classpath to the server. -- `start`: Starts an Ignite node locally. -- `stop`: Stops a locally running Ignite node. -- `classpath`: Shows the current classpath used by the Ignite nodes. -- `list`: Shows the list of currently running local Ignite nodes. +=== Starting a Node -* `config`: Inspects and updates Ignite cluster configuration. +This section explains how to start a node, how to stop it, +and how to perform other basic operations with a node. -- `get`: Gets current Ignite cluster configuration values. -- `set`: Updates Ignite cluster configuration values. +. To start a node, use the command below: ++ +[source, shell] +---- +ignite node start +---- -== Optional modules +. To view the list of currently running nodes, use the following command: ++ +[source, shell] +---- +ignite node list +---- ++ +This command also displays the path to the log file. -Ignite ships with a number of modules that provide various functionality. You can enable modules one by one, as required. +. 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. -WARNING: In the current alpha release, modules functionality is disabled. -But you can still add Maven dependencies using the following command: +=== Managing a Cluster -`Ignite module add mvn:artifactId:groupId:version` -It downloads the modules from Maven and adds a classpath to the server. +The Ignite CLI tool also allows to perform some operations with a cluster using the `config` command. -== Work with a node +See some of the examples below: -The steps below illustrate basic node operations. +* To read the cluster configuration, use the command: ++ +[source, shell] +---- +ignite config get +---- ++ +It can be performed either for the whole tree or filtered via the `--selector` option. -. Use the `ignite init` command to start the configuration process. +* To update a property, follow the pattern below. Your command might look like this: ++ +[source, shell] +---- +ignite config set local.baseline.autoAdjust.timeout=20000 +---- -. To start a node, use the `ignite node start` command. -Specify the `consistent-id` parameter for a certain node. -. To stop a node, use the `ignite node stop` command. -Specify the `consistent-id` parameter for a certain node. +== Next Steps -. To view the list of active nodes, use the `ignite node list` command. 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` standard command for Linux. +From here, you may want to: + +* Check out the <<Ignite CLI Tool Commands>> section for more detail on supported commands. + +* Explore the <<Apache Ignite Configuration>> section to learn more about the configuration parameters. + + +== 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. + +Below is a list of Ignite CLI tool commands with short descriptions: + +[cols="1,3",opts="header", stripes=none] +|=== +| Command | Description +| `init` | Installs Ignite core modules locally. +| `module` | Manages optional Ignite modules and external artifacts. +| `module list` | Shows the list of available optional Ignite modules. +| `module add` | Adds an optional Ignite module or an external artifact. +| `module remove` | Adds an optional Ignite module or an external artifact. +| `node`| Starts, stops and manages locally running Ignite nodes. +| `node start` | Starts an Ignite node locally. +| `node stop` | Stops a locally running Ignite node. +| `node classpath` | Shows the current classpath used by the Ignite nodes. +| `node list` | Shows the list of currently running local Ignite nodes. +| `config`| Inspects and updates Ignite cluster configuration. +| `config get` | Gets current Ignite cluster configuration values. +| `config set` | Updates Ignite cluster configuration values. +|=== + + +== Apache Ignite Configuration + + +Apache Ignite uses HOCON configuration format. +For more detail, please see the link:https://github.com/lightbend/config/blob/master/HOCON.md[HOCON documentation,window=_blank]. +