This is an automated email from the ASF dual-hosted git repository. vkulichenko pushed a commit to branch ignite-3.0.0-alpha2 in repository https://gitbox.apache.org/repos/asf/ignite-3.git
commit 090e532fc8807c9af7939a822b88368718ea4d73 Author: IgGusev <[email protected]> AuthorDate: Wed Jun 30 19:46:21 2021 +0300 IGNITE-15022 - Updating docs for Ignite 3 alpha 2 release (#192) --- docs/_docs/ignite-cli-tool.adoc | 7 +- .../includes/ignite-cli-download-windows.adoc | 2 +- docs/_docs/index.adoc | 15 ++++ docs/_docs/quick-start/getting-started-guide.adoc | 82 +++++++++------------- 4 files changed, 54 insertions(+), 52 deletions(-) diff --git a/docs/_docs/ignite-cli-tool.adoc b/docs/_docs/ignite-cli-tool.adoc index 79ad4b1..9ac4a5b 100644 --- a/docs/_docs/ignite-cli-tool.adoc +++ b/docs/_docs/ignite-cli-tool.adoc @@ -28,12 +28,11 @@ Below is a list of Ignite CLI tool commands with short descriptions: | `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`| 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. |=== + +NOTE: While `config`, `config get`, `config set` commands are listed in command output, they do not work in alpha 2. \ No newline at end of file diff --git a/docs/_docs/includes/ignite-cli-download-windows.adoc b/docs/_docs/includes/ignite-cli-download-windows.adoc index e1a880e..ebab194 100644 --- a/docs/_docs/includes/ignite-cli-download-windows.adoc +++ b/docs/_docs/includes/ignite-cli-download-windows.adoc @@ -14,5 +14,5 @@ // limitations under the License. // tag::command[] -curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha1/ignite.exe"; -o ignite.exe +curl "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha2/apache-ignite-3.0.0-alpha2.zip"; -o apache-ignite-3.0.0-alpha2.zip // end::command[] diff --git a/docs/_docs/index.adoc b/docs/_docs/index.adoc index a1cb227..c38d7ba 100644 --- a/docs/_docs/index.adoc +++ b/docs/_docs/index.adoc @@ -39,3 +39,18 @@ which means that the schema is defined for a cache/table before its creation. * See a link:https://cwiki.apache.org/confluence/display/IGNITE/Proposals+for+Ignite+3.0[full list of improvements,window=_blank]. + +== New in Alpha 2 + +Apache Ignite Alpha 2 comes with the following new features: + +- Added replication infrastructure based on Raft. +- New in-memory atomic storage with the basic insert-read functionality. +- New schema management engine and API. + +== Known Issues + +Due to changes between alpha 1 and alpha 2, Ignite cluster configuration commands no longer work. This will be fixed in alpha 3. + +Affected commands: `config`, `config get`, `config set`. + diff --git a/docs/_docs/quick-start/getting-started-guide.adoc b/docs/_docs/quick-start/getting-started-guide.adoc index 5225014..e04dacd 100644 --- a/docs/_docs/quick-start/getting-started-guide.adoc +++ b/docs/_docs/quick-start/getting-started-guide.adoc @@ -14,17 +14,17 @@ // limitations under the License. = Getting Started Guide -This guide provides essential details on how to start working with Ignite 3.0 by using the Ignite CLI tool, -including the following information: +This guide provides essential details on how to start working with Ignite 3.0 alpha 2 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 -* Additional information regarding the use of the tool +* How to download and install the tool. +* How to use the Ignite CLI tool to manage nodes. +* How to run built-in examples. +* Additional information regarding the use of the tool. == Prerequisites -Ignite 3.0 was officially tested on: +Ignite 3.0 alpha 2 was officially tested on: include::../includes/prereqs.adoc[] @@ -34,49 +34,49 @@ include::../includes/prereqs.adoc[] To download and install the Ignite CLI Tool, follow the steps below: -. Create a folder. For example, use a Linux command similar to the following: +. Download the archive with the Ignite CLI tool: + [tabs] -- tab:Unix[] [source,shell] ---- -mkdir ignite3 && cd ignite3 +curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha2/apache-ignite-3.0.0-alpha2.zip"; -o apache-ignite-3.0.0-alpha2.zip ---- tab:Windows (PowerShell)[] [source,shell] ---- -(mkdir ignite3) -AND (cd ignite3) +include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0] ---- tab:Windows (CMD)[] [source,shell] ---- -mkdir ignite3 & cd ignite3 +include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0] ---- -- -. Download the Ignite CLI tool and set required execute permissions: +. Unpack the archive: + [tabs] -- tab:Unix[] [source,shell] ---- -curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha1/ignite"; -o ignite && chmod +x ignite +unzip apache-ignite-3.0.0-alpha2.zip && cd apache-ignite-3.0.0-alpha2 ---- tab:Windows (PowerShell)[] [source,shell] ---- -include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0] +Expand-Archive apache-ignite-3.0.0-alpha2.zip -DestinationPath . ; cd apache-ignite-3.0.0-alpha2 ---- tab:Windows (CMD)[] [source,shell] ---- -include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0] +tar -xf apache-ignite-3.0.0-alpha2.zip & cd apache-ignite-3.0.0-alpha2 ---- -- @@ -109,15 +109,14 @@ permanently update the `PATH` environment variable by adding a full path to the == Using Ignite CLI Tool -Ignite CLI 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. You can perform the following actions with it: -* Manage existing nodes -* Install new nodes -* Update old nodes to new versions -* Install or remove optional modules +* Manage existing nodes. +* Install new nodes. +* Update old nodes to new versions. +* Install or remove optional modules. -Let's use some of the <<Ignite CLI Tool Commands>>. +Let's use some of the \<<Ignite CLI Tool Commands>>. . Use the command below to see the full list: + @@ -137,7 +136,7 @@ ignite init --help Ignite CLI allows to install Ignite modules and 3rd party Maven dependencies. -. To start an Ignite 3.0 cluster, you need to install Ignite core artifacts first: +. To start an Ignite 3.0 alpha 2 cluster, you need to install Ignite core artifacts first: + [source, shell] ---- @@ -162,11 +161,11 @@ ignite module list This section explains how to start a node, how to stop, and perform other basic operations with it. -. Start a cluster node setting `myFirstNode` as a node unique identifier: +. Start a cluster node setting `node-1` as a node unique identifier: + [source, shell] ---- -ignite node start myFirstNode +ignite node start --config=examples/config/ignite-config.json node-1 ---- . Confirm the node is started and running: @@ -181,33 +180,21 @@ 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 on a Unix operating system. -== Working With the Cluster +== Built-in Examples -The Ignite CLI tool also allows to perform some operations with a cluster using the `config` command. +Ignite 3.0 alpha 2 comes with examples that are configured as a separate Maven project located in the `examples` folder. -See some of the examples below: +The project includes the following examples: -. Read the cluster configuration: -+ -[source, shell] ----- -ignite config get ----- -+ -It can be performed either for the whole tree or filtered via the `--selector` option. +* `TableExample` demonstrates the usage of the `org.apache.ignite.table.Table` API to create a table. It also shows how to get data from a table, or insert a line into a table. +* `KeyValueBinaryViewExample` - demonstrates the usage of the `org.apache.ignite.table.KeyValueBinaryView` API to insert a line into a table. + +To run an example: + +1. Import the `examples` folder into your IDE as a Maven project. + +2. Follow the steps in the specific example to start it. -. 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 @@ -217,6 +204,7 @@ To stop the node, use the command below passing `myFirstNode` as a node unique i ignite node stop myFirstNode ---- + == Next Steps From here, you may want to:
