PakhomovAlexander commented on code in PR #1251: URL: https://github.com/apache/ignite-3/pull/1251#discussion_r1009444919
########## docs/_docs/ignite-cli-tool.adoc: ########## @@ -31,26 +31,29 @@ The following commands can be executed in REPL mode of the command line tool: [cols="1,1,3",opts="header", stripes=none] |=== | Command| Parameters | Description -| `bootsrap` || Installs Ignite core modules locally. Previously `init`. +//| `bootsrap` || Installs Ignite core modules locally. Previously `init`. | `clear` || Clears the terminal. | `cli config` || Gets all CLI tool configuration values. | `cli config get` | `<config key-value>` | Gets the value of the specified CLI tool configuration. | `cli config set` | `<config key-value>` | Sets the value of the specified CLI tool configuration. +| `cli config show` | `<config key-value>` | Shows the cluster configuration. | `cluster init` | `[--cluster-url] <--meta-storage-node> [--cmg-node]`| Initializes the cluster on the specified URL. -| `cluster show` | `[--cluster-url]` | Displays the detailed status of the specified cluster. +| `cluster status` | `[--cluster-url]` | Displays the detailed status of the specified cluster. | `cluster config show` | `[--cluster-url] [--selector]` | Gets the configuration of the specified cluster. | `cluster config update` | `[--cluster-url] <config in HOCON format>` | Updates the configuration of the cluster with the provided configuration in HOCON format. +| `cluster topology physical` | `[--cluster-url]` | Shows physical cluster topology. +| `cluster topology logical` | `[--cluster-url]` | Shows logical cluster topology. | `connect` | [--cluster-url] | Connects to the specified cluster, or `localhost:3000` if no cluster url is specified. All subsequent commands use the specified cluster url. | `disconnect` || Disconnects from the cluster. | `exit` || Stops current interactive session. | `help` | `<command>` | Provides information on available commands, or for specific command if the `command` parameter is specified. | `node classpath` || Shows the current classpath used by Ignite nodes. | `node config show` | `[--node-url][--selector]` | Gets the local node configuration. |`node config update` | `[--node-url] <config in HOCON format>` | Updates the local node configuration with the provided configuration in HOCON format. -| `node list` || Shows the list of currently running local Ignite nodes. -| `node start` | `[--config] <nodeName>` | Starts an Ignite node locally. -| `node stop` | `<nodeName>` | Stops a locally running Ignite node. -| `status` | `--cluster-url` |Shows the status of the default cluster, or a different one if cluster-url is provided. +//| `node list` || Shows the list of currently running local Ignite nodes. +//| `node start` | `[--config] <nodeName>` | Starts an Ignite node locally. +//| `node stop` | `<nodeName>` | Stops a locally running Ignite node. +| `node status` | `--cluster-url` |Shows the status of the default cluster, or a different one if cluster-url is provided. Review Comment: all `node` commands have `--node-url` option, not `--cluster-url` ########## docs/_docs/installation/deb-rpm.adoc: ########## @@ -0,0 +1,62 @@ +// Licensed to the Apache Software Foundation (ASF) under one or more +// contributor license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright ownership. +// The ASF licenses this file to You under the Apache License, Version 2.0 +// (the "License"); you may not use this file except in compliance with +// the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. += Installing Using DEP and RPM Package + +Apache Ignite can be installed from the official link:https://www.apache.org/dist/ignite/rpm[RPM] or link:https://www.apache.org/dist/ignite/deb[DEB] repositories. + +== Installing Deb Package + +Configure the repository: + +[source, shell] +---- +sudo apt update +sudo apt install gnupg ca-certificates --no-install-recommends -y +---- + + +[source, shell] +---- +sudo bash -c 'cat <<EOF > /etc/apt/sources.list.d/ignite.list +deb http://apache.org/dist/ignite/deb/ apache-ignite main +EOF' +sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 0EE62FB37A00258D +sudo apt update +sudo apt install apache-ignite --no-install-recommends +---- + +Install the Apache Ignite package: + +[source, shell] +---- +sudo apt install apache-ignite --no-install-recommends Review Comment: I am not sure that the package name will be apache-ignite ########## docs/_docs/installation/installing-using-zip.adoc: ########## @@ -0,0 +1,100 @@ +// Licensed to the Apache Software Foundation (ASF) under one or more +// contributor license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright ownership. +// The ASF licenses this file to You under the Apache License, Version 2.0 +// (the "License"); you may not use this file except in compliance with +// the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. += Installing Using ZIP Archive + +== Prerequisites + +Ignite was tested on: + +include::../includes/prereqs.adoc[] + + +== Installing Using ZIP Archive + + +. Download the archive with the Ignite CLI tool: ++ +[tabs] +-- +tab:Unix[] +[source,shell] +---- +curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha5/apache-ignite-3.0.0-alpha5.zip"; -o apache-ignite-3.0.0-alpha5.zip +---- + +tab:Windows (PowerShell)[] +[source,shell] +---- +include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0] +---- + +tab:Windows (CMD)[] +[source,shell] +---- +include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0] +---- +-- + +. Unpack the archive: ++ +[tabs] +-- +tab:Unix[] +[source,shell] +---- +unzip apache-ignite-3.0.0-alpha5.zip && cd apache-ignite-3.0.0-alpha5 +---- + + +tab:Windows (PowerShell)[] +[source,shell] +---- +Expand-Archive apache-ignite-3.0.0-alpha5.zip -DestinationPath . ; cd apache-ignite-3.0.0-alpha5 +---- + +tab:Windows (CMD)[] +[source,shell] +---- +tar -xf apache-ignite-3.0.0-alpha5.zip & cd apache-ignite-3.0.0-alpha5 +---- +-- + +. Add your installation directory to the PATH environment variable: ++ +[tabs] +-- +tab:Unix[] +[source,shell] +---- +echo 'export PATH="'`pwd`':$PATH"' >> ~/.bash_profile && source ~/.bash_profile && source ignite_completion.sh Review Comment: I think zip flow has been changed since alpha5, you can look at some references in DEVNOTES ########## docs/_docs/installation/installing-using-zip.adoc: ########## @@ -0,0 +1,100 @@ +// Licensed to the Apache Software Foundation (ASF) under one or more +// contributor license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright ownership. +// The ASF licenses this file to You under the Apache License, Version 2.0 +// (the "License"); you may not use this file except in compliance with +// the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. += Installing Using ZIP Archive + +== Prerequisites + +Ignite was tested on: + +include::../includes/prereqs.adoc[] + + +== Installing Using ZIP Archive + + +. Download the archive with the Ignite CLI tool: ++ +[tabs] +-- +tab:Unix[] +[source,shell] +---- +curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha5/apache-ignite-3.0.0-alpha5.zip"; -o apache-ignite-3.0.0-alpha5.zip Review Comment: alpha5 -> beta1? ########## docs/_docs/installation/installing-using-docker.adoc: ########## @@ -0,0 +1,95 @@ +// Licensed to the Apache Software Foundation (ASF) under one or more +// contributor license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright ownership. +// The ASF licenses this file to You under the Apache License, Version 2.0 +// (the "License"); you may not use this file except in compliance with +// the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. += Installing Using Docker + +== Prerequisites + +Ignite was tested on: + +include::../includes/prereqs.adoc[] + +== Downloading Docker Image + +Assuming that you already have Docker installed on your machine, you can pull and run the Ignite Docker image by using the following commands\: +[source,shell] +---- +# Pull latest version +sudo docker pull apacheignite/ignite3 +---- + +== Running In-Memory Cluster + +Run Ignite in a docker container using the `docker run` command. + +[source,shell] +---- +# Run the latest version +sudo docker run -it --rm -p 10300:10300 apacheignite/ignite3 +---- + +This command will launch a single Ignite node. + +To run multiple nodes, instead use a docker-compose file: + +---- +version: "3.9" + +name: ignite3 + +x-ignite-def: + &ignite-def + image: apacheignite/ignite3:${IGNITE3_VERSION:-latest} + +services: + node1: + << : *ignite-def + command: --join node1:3344,node2:3344,node3:3344 --node-name node1 + ports: + - 10300:10300 + - 3344:3344 + node2: + << : *ignite-def + command: --join node1:3344,node2:3344,node3:3344 --node-name node2 + ports: + - 10301:10300 + - 3345:3344 + node3: + << : *ignite-def + command: --join node1:3344,node2:3344,node3:3344 --node-name node3 + ports: + - 10302:10300 + - 3346:3344 +---- + + + +== Environment Variables + +The following parameters can be passed as environment variables in the docker container: + +[cols="1,2,1", options="header"] +|=== +| Parameter Name |Description |Default +| `CONFIG_URI` | URL to the Ignite configuration file (can also be relative to the META-INF folder on the class path). +The downloaded config file is saved to ./ignite-config.xml | N/A + +| `OPTION_LIBS` | A list of link:setup#enabling-modules[modules] that will be enabled for the node. | ignite-log4j2, ignite-spring, ignite-indexing Review Comment: Im not sure that now you are able to enable modules in such a way. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
