PakhomovAlexander commented on code in PR #1251: URL: https://github.com/apache/ignite-3/pull/1251#discussion_r1011878026
########## docs/_docs/installation/deb-rpm.adoc: ########## @@ -0,0 +1,61 @@ +// 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 +//---- + +. 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-beta1/ignite3cli_3.beta1_all.deb"; -o ignite3cli_3.beta1_all.deb Review Comment: Double check the package naming, please https://issues.apache.org/jira/browse/IGNITE-18036 ########## docs/_docs/installation/deb-rpm.adoc: ########## @@ -0,0 +1,61 @@ +// 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 +//---- + +. 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-beta1/ignite3cli_3.beta1_all.deb"; -o ignite3cli_3.beta1_all.deb + +curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-beta1/ignite3db_3.beta1_all.deb"; -o ignite3db_3.beta1_all.deb +---- +-- + + + +Install the Apache Ignite package: Review Comment: Here is only DEB installation provided, do you plan to add RPM also? ########## docs/_docs/quick-start/getting-started-guide.adoc: ########## @@ -14,206 +14,83 @@ // limitations under the License. = Getting Started Guide -This guide provides essential details on how to start working with Ignite 3.0 Alpha 5 by using the Ignite CLI tool, including the following information: +This guide provides essential details on how to start working with Ignite 3.0 Beta by using the Ignite CLI tool, including the following information: -* 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 Alpha 5 was officially tested on: +Ignite 3.0 Beta was officially tested on: include::../includes/prereqs.adoc[] +== Starting Ignite Node -== Installing Ignite CLI Tool +In this guide we will use a link:../installation/installing-using-zip[zip] archive installation. To start an Ignite node, -To download and install the Ignite CLI Tool, follow the steps below: -. Download the archive with the Ignite CLI tool: -+ [tabs] -- -tab:Unix[] -[source,shell] +tab:Linux[] ---- -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 +sh ignite3db-3.0.0-beta1/bin/ignite3db.sh start ---- -tab:Windows (PowerShell)[] -[source,shell] +tab:Windows[] +NOTE: You need to install Java in Bash environment to run Ignite on Windows. ---- -include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0] +bash ignite3db-3.0.0-beta1\bin\ignite3db.sh start ---- - -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 ----- - -tab:Windows (PowerShell)[] -[source,shell] ----- -$ENV:PATH += ";." ----- - -tab:Windows (CMD)[] -[source,text] ----- -set PATH=%cd%;%PATH% ----- --- - -NOTE: On Windows, this latter change is not permanent and only affects the current terminal session. If you want the -`ignite` command to be available after terminal or system restart, use the `System Properties` dialog to -permanently update the `PATH` environment variable by adding a full path to the Ignite installation directory. == Using Ignite CLI Tool -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. - -Let's use some of the \<<Ignite CLI Tool Commands>>. - -. Use the command below to see the full list: -+ -[source, shell] ----- -ignite ----- - -. Pass the `--help` parameter to the previous command to get its detailed description: -+ -[source, shell] ----- -ignite bootstrap --help ----- - -== Installing Ignite Artifacts and Dependencies - -Ignite CLI allows to install Ignite modules and 3rd party Maven dependencies. - -WARNING: If you have installed one of the Ignite 3 Alpha releases before, please remove the `~/.ignitecfg` file before proceeding. This is a temporary step, the procedure will be improved in the future releases. - -. To start an Ignite 3.0 Alpha 5 cluster, you need to install Ignite core artifacts first: -+ -[source, shell] ----- -ignite init ----- - -. Use the `module add` command to download Guava from Maven and add it to the Ignite classpath: -+ -[source, shell] ----- -ignite module add mvn:com.google.guava:guava:23.0 ----- - -. Confirm the library is added to the Ignite dependencies list: -+ -[source, shell] ----- -ignite module list ----- - +Ignite CLI is a single entry point for all the Ignite operations. In this guide we will use it to start a cluster on a node you started on the previous step and execute a simple SQL query. -== Starting a Node +//* Manage existing nodes. +//* Install new nodes. +//* Update old nodes to new versions. +//* Install or remove optional modules. -This section explains how to start a node, how to stop, and perform other basic operations with it. - -. Start a cluster node setting `my-first-node` as a node unique identifier: -+ -[source, shell] +[tabs] +-- +tab:Linux[] ---- -ignite node start --config=examples/config/ignite-config.json my-first-node +sh ignite3cli-3.0.0-beta1\bin\ignite Review Comment: ignite3cli-3.0.0-beta1\bin\ignite3 ########## docs/_docs/quick-start/getting-started-guide.adoc: ########## @@ -14,206 +14,83 @@ // limitations under the License. = Getting Started Guide -This guide provides essential details on how to start working with Ignite 3.0 Alpha 5 by using the Ignite CLI tool, including the following information: +This guide provides essential details on how to start working with Ignite 3.0 Beta by using the Ignite CLI tool, including the following information: -* 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 Alpha 5 was officially tested on: +Ignite 3.0 Beta was officially tested on: include::../includes/prereqs.adoc[] +== Starting Ignite Node -== Installing Ignite CLI Tool +In this guide we will use a link:../installation/installing-using-zip[zip] archive installation. To start an Ignite node, -To download and install the Ignite CLI Tool, follow the steps below: -. Download the archive with the Ignite CLI tool: -+ [tabs] -- -tab:Unix[] -[source,shell] +tab:Linux[] ---- -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 +sh ignite3db-3.0.0-beta1/bin/ignite3db.sh start ---- -tab:Windows (PowerShell)[] -[source,shell] +tab:Windows[] +NOTE: You need to install Java in Bash environment to run Ignite on Windows. ---- -include::../includes/ignite-cli-download-windows.adoc[tag=command,indent=0] +bash ignite3db-3.0.0-beta1\bin\ignite3db.sh start Review Comment: just ignite3db-3.0.0-beta1\bin\ignite3db, without .sh. ########## docs/_docs/installation/installing-using-docker.adoc: ########## @@ -0,0 +1,77 @@ +// 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 Review Comment: I'm not sure if we are going to upload the docker image into the dockerhub. -- 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]
