| <!DOCTYPE html> |
| |
| |
| |
| <html lang="en"> |
| <head> |
| <!-- Global site tag (gtag.js) - Google Analytics --> |
| <script async src="https://www.googletagmanager.com/gtag/js?id=UA-61232409-1"></script> |
| <script> |
| window.dataLayer = window.dataLayer || []; |
| function gtag(){dataLayer.push(arguments);} |
| gtag('js', new Date()); |
| |
| gtag('config', 'UA-61232409-1'); |
| </script> |
| |
| |
| |
| <meta charset="UTF-8"> |
| <meta name="ignite-version" content="3.0.0-alpha" /> |
| <title>Getting Started Guide | Ignite Documentation</title> |
| |
| <link rel="canonical" href="/docs/3.0.0-alpha/quick-start/getting-started-guide" /> |
| <META NAME="ROBOTS" CONTENT="NOINDEX" /> |
| |
| |
| <link rel="stylesheet" href="/assets/css/styles.css?1610386844"> |
| <link rel="stylesheet" href="/assets/css/asciidoc-pygments.css"> |
| <link rel="shortcut icon" href="/favicon.ico"> |
| <meta name='viewport' content='width=device-width, height=device-height, initial-scale=1.0, minimum-scale=1.0'> |
| |
| <script type="text/javascript" src="/assets/js/anchor.min.js?1610386844"></script> |
| |
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" /> |
| |
| |
| </head> |
| <body> |
| <header> |
| <!--#include virtual="/includes/promotion_banner.html" --> |
| <div class="container"> |
| <button type='button' class='menu' title='Docs menu'> |
| <img src="/assets/images/menu-icon.svg"/> |
| </button> |
| <div class='home'> |
| <a href="/" class='home' title='Apache Ignite home'> |
| <img src="/assets/images/apache_ignite_logo.svg" alt="Apache Ignite logo" width="103" > |
| </a> |
| </div> |
| |
| |
| <select id="version-selector"> |
| <option value="3.0.0-alpha">3.0.0-alpha</option> |
| </select> |
| |
| <nav id="api-docs"> |
| <li><a href="#">APIs</a> |
| |
| <nav class='dropdown'> |
| <li class="dropdown-item"><a href="/releases/latest/javadoc/index.html">Java</a></li> |
| |
| <li class="dropdown-item"><a href="/releases/latest/dotnetdoc/api/">C#/.NET</a></li> |
| |
| <li class="dropdown-item"><a href="/releases/latest/cppdoc/index.html">C++</a></li> |
| |
| <li class="dropdown-item"><a href="/releases/latest/scaladoc/scalar/index.html#org.apache.ignite.scalar.scalar$">Scala</a></li> |
| |
| </nav> |
| </li> |
| |
| <li><a href="#">Examples</a> |
| <nav class="dropdown"> |
| <li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/examples" target="_blank" rel="noopener" title="Apache Ignite Java examples">Java</a></li> |
| |
| <li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/dotnet/examples" target="_blank" rel="noopener" title="Apache Ignite C#/.NET examples">C#/.NET</a></li> |
| |
| <li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/cpp/examples" target="_blank" rel="noopener" title="Apache Ignite C++ examples">C++</a></li> |
| |
| <li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/python/examples" target="_blank" rel="noopener" title="Apache Ignite Python examples">Python</a></li> |
| |
| <li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/nodejs/examples" target="_blank" rel="noopener" title="Apache Ignite NodeJS examples">NodeJS</a></li> |
| |
| <li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/php/examples" target="_blank" rel="noopener" title="Apache Ignite PHP examples">PHP</a></li> |
| </nav> |
| </li> |
| </nav> |
| |
| <form class='search'> |
| <button class="search-close" type='button'><img src='/assets/images/cancel.svg'></button> |
| <input type="search" placeholder="Search…" id="search-input"> |
| </form> |
| <button type='button' class='search-toggle'><img src='/assets/images/search.svg'></button> |
| |
| <nav id="lang-selector"> |
| <li><a href="#"><img src="/assets/images/icon_lang_en.png" alt="English language icon" /><span>▼</span></a> |
| <nav class="dropdown"> |
| <li class="dropdown-item"><a href="/docs/latest/" ><img src="/assets/images/icon_lang_en.png" alt="English language icon" /><span>English</span></a></li> |
| <li class="dropdown-item"><a href="https://www.ignite-service.cn/doc/java/" target="_blank" rel="noopener"><img src="/assets/images/icon_lang_cn.png" alt="Chinese language icon" /><span>Chinese</span></a></li> |
| </nav> |
| </li> |
| </nav> |
| |
| <button type='button' class='top-nav-toggle'>⋮</button> |
| |
| |
| |
| </div> |
| </header> |
| |
| |
| <link rel="stylesheet" href="/assets/css/docs.css"> |
| <section class='page-docs'> |
| |
| |
| |
| |
| |
| |
| <nav class='left-nav' data-swiftype-index='false'> |
| |
| |
| <li> |
| |
| |
| <a href="/docs/3.0.0-alpha/index" class='' >Documentation Overview</a> |
| |
| </li> |
| |
| <li> |
| |
| |
| <a href="/docs/3.0.0-alpha/quick-start/getting-started-guide" class='active' >Getting Started Guide</a> |
| |
| </li> |
| |
| <li> |
| |
| |
| <a href="/docs/3.0.0-alpha/ignite-cli-tool" class='' >Ignite CLI Tool</a> |
| |
| </li> |
| |
| </nav> |
| <div class="left-nav__overlay"></div> |
| |
| |
| <article data-swiftype-index='true'> |
| <a class='edit-link' href="https://github.com/apache/ignite/tree/IGNITE-7595/docs/_docs/quick-start/getting-started-guide.adoc" target="_blank">Edit</a> |
| |
| <h1>Getting Started Guide</h1> |
| |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>This guide provides essential details on how to start working with Ignite 3.0 by using the Ignite CLI tool, |
| including the following information:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>How to download and install the tool</p> |
| </li> |
| <li> |
| <p>How to manage nodes using the Ignite CLI tool</p> |
| </li> |
| <li> |
| <p>Additional information regarding the use of the tool</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="prerequisites">Prerequisites</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Ignite 3.0 was officially tested on:</p> |
| </div> |
| <table class="tableblock frame-all grid-all stripes-even stretch"> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 75%;"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">JDK</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">11 and later</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">OS</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Linux (Ubuntu 20.04), Windows (10 Home), macOS</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="installing-ignite-cli-tool">Installing Ignite CLI Tool</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>To download and install the Ignite CLI Tool, follow the steps below:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Create a folder. For example, use a Linux command similar to the following:</p> |
| <code-tabs><code-tab data-tab='Unix'><div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell"><span class="nb">mkdir </span>ignite3 <span class="o">&&</span> <span class="nb">cd </span>ignite3</code></pre> |
| </div> |
| </div></code-tab><code-tab data-tab='Windows (PowerShell)'><div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell"><span class="o">(</span><span class="nb">mkdir </span>ignite3<span class="o">)</span> <span class="nt">-AND</span> <span class="o">(</span><span class="nb">cd </span>ignite3<span class="o">)</span></code></pre> |
| </div> |
| </div></code-tab><code-tab data-tab='Windows (CMD)'><div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell"><span class="nb">mkdir </span>ignite3 & <span class="nb">cd </span>ignite3</code></pre> |
| </div> |
| </div></code-tab></code-tabs> |
| </li> |
| <li> |
| <p>Download the Ignite CLI tool and set required execute permissions:</p> |
| <code-tabs><code-tab data-tab='Unix'><div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">curl <span class="nt">-L</span> <span class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha1/ignite"</span> <span class="nt">-o</span> ignite <span class="o">&&</span> <span class="nb">chmod</span> +x ignite</code></pre> |
| </div> |
| </div></code-tab><code-tab data-tab='Windows (PowerShell)'><div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">curl <span class="nt">-L</span> <span class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha1/ignite.exe"</span> <span class="nt">-o</span> ignite.exe</code></pre> |
| </div> |
| </div></code-tab><code-tab data-tab='Windows (CMD)'><div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">curl <span class="nt">-L</span> <span class="s2">"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha1/ignite.exe"</span> <span class="nt">-o</span> ignite.exe</code></pre> |
| </div> |
| </div></code-tab></code-tabs> |
| </li> |
| <li> |
| <p>Add your installation directory to the PATH environment variable:</p> |
| <code-tabs><code-tab data-tab='Unix'><div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell"><span class="nb">echo</span> <span class="s1">'export PATH="'</span><span class="sb">`</span><span class="nb">pwd</span><span class="sb">`</span><span class="s1">':$PATH"'</span> <span class="o">>></span> ~/.bash_profile <span class="o">&&</span> <span class="nb">source</span> ~/.bash_profile</code></pre> |
| </div> |
| </div></code-tab><code-tab data-tab='Windows (PowerShell)'><div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell"><span class="nv">$ENV</span>:PATH +<span class="o">=</span> <span class="s2">";."</span></code></pre> |
| </div> |
| </div></code-tab><code-tab data-tab='Windows (CMD)'><div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="text">set PATH=%cd%;%PATH%</code></pre> |
| </div> |
| </div></code-tab></code-tabs> |
| </li> |
| </ol> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <div class="title">Note</div> |
| </td> |
| <td class="content"> |
| On Windows, this latter change is not permanent and will only affect the current terminal session. If you want the |
| <code>ignite</code> command to be available after terminal or system restart, use the <code>System Properties</code> dialog to |
| permanently update the <code>PATH</code> environment variable by adding a full path to the Ignite installation directory. |
| </td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="using-ignite-cli-tool">Using Ignite CLI Tool</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Ignite CLI is a single entry point for all the Ignite operations. For example, it allows you to perform the following |
| actions:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Manage existing nodes</p> |
| </li> |
| <li> |
| <p>Install new nodes</p> |
| </li> |
| <li> |
| <p>Update old nodes to new versions</p> |
| </li> |
| <li> |
| <p>Install or remove optional modules</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>Let’s use some of the <a href="#Ignite CLI Tool Commands">[Ignite CLI Tool Commands]</a>.</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Use the command below to see the full list:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">ignite</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Pass the <code>--help</code> parameter to the previous command to get its detailed description:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">ignite init <span class="nt">--help</span></code></pre> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="installing-ignite-artifacts-and-dependencies">Installing Ignite Artifacts and Dependencies</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Ignite CLI allows to install Ignite modules and 3rd party Maven dependencies.</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>To start an Ignite 3.0 cluster, you need to install Ignite core artifacts first:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">ignite init</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Use the <code>module add</code> command to download Guava from Maven and add it to the Ignite classpath:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">ignite module add mvn:com.google.guava:guava:23.0</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Confirm the library is added to the Ignite dependencies list:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">ignite module list</code></pre> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="starting-a-node">Starting a Node</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>This section explains how to start a node, how to stop, and perform other basic operations with it.</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Start a cluster node setting <code>myFirstNode</code> as a node unique identifier:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">ignite node start myFirstNode</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Confirm the node is started and running:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">ignite node list</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This command also displays the path to the log file.</p> |
| </div> |
| </li> |
| <li> |
| <p>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 <code>cat</code> command on a Unix operating system.</p> |
| </li> |
| </ol> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="working-with-the-cluster">Working With the Cluster</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The Ignite CLI tool also allows to perform some operations with a cluster using the <code>config</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See some of the examples below:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Read the cluster configuration:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">ignite config get</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>It can be performed either for the whole tree or filtered via the <code>--selector</code> option.</p> |
| </div> |
| </li> |
| <li> |
| <p>Update the baseline topology auto-adjustment timeout:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">ignite config <span class="nb">set </span>local.baseline.autoAdjust.timeout<span class="o">=</span>20000</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Confirm the change is applied:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">ignite config get <span class="nt">--selector</span><span class="o">=</span>local.baseline.autoAdjust.timeout</code></pre> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="stopping-the-cluster">Stopping the Cluster</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>To stop the node, use the command below passing <code>myFirstNode</code> as a node unique identifier:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="rouge highlight"><code data-lang="shell">ignite node stop myFirstNode</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="next-steps">Next Steps</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>From here, you may want to:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Check out the <a href="/docs/3.0.0-alpha/ignite-cli-tool">Ignite CLI Tool</a> page for more detail on supported commands.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="copyright"> |
| © 2021 The Apache Software Foundation.<br/> |
| Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation. |
| |
| </div> |
| |
| </article> |
| <nav class="right-nav" data-swiftype-index='false'> |
| <ul class="sectlevel1"> |
| <li><a href="#prerequisites">Prerequisites</a></li> |
| <li><a href="#installing-ignite-cli-tool">Installing Ignite CLI Tool</a></li> |
| <li><a href="#using-ignite-cli-tool">Using Ignite CLI Tool</a></li> |
| <li><a href="#installing-ignite-artifacts-and-dependencies">Installing Ignite Artifacts and Dependencies</a></li> |
| <li><a href="#starting-a-node">Starting a Node</a></li> |
| <li><a href="#working-with-the-cluster">Working With the Cluster</a></li> |
| <li><a href="#stopping-the-cluster">Stopping the Cluster</a></li> |
| <li><a href="#next-steps">Next Steps</a></li> |
| </ul> |
| |
| |
| <footer> |
| </footer> |
| |
| </nav> |
| |
| </section> |
| <script type='module' src='/assets/js/code-copy-to-clipboard.js' async crossorigin></script> |
| |
| <script> |
| // inits deep anchors -- needs to be done here because of https://www.bryanbraun.com/anchorjs/#dont-run-it-too-late |
| anchors.add('.page-docs h1, .page-docs h2, .page-docs h3:not(.discrete), .page-docs h4, .page-docs h5'); |
| anchors.options = { |
| placement: 'right', |
| visible: 'always' |
| }; |
| </script> |
| <!-- load google fonts async --> |
| <script type="text/javascript"> |
| WebFontConfig = { |
| google: { families: [ 'Open+Sans:300,400,600,700&display=swap' ] } |
| }; |
| (function() { |
| var wf = document.createElement('script'); |
| wf.src = 'https://ajax.googleapis.com/ajax/libs/webfont/1/webfont.js'; |
| wf.type = 'text/javascript'; |
| wf.async = 'true'; |
| var s = document.getElementsByTagName('script')[0]; |
| s.parentNode.insertBefore(wf, s); |
| })(); </script> |
| <script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script> |
| <script> |
| docsearch({ |
| // Your apiKey and indexName will be given to you once |
| // we create your config |
| apiKey: '3eee686c0ebe39eff3baeb18c56fa5f8', |
| indexName: 'apache_ignite', |
| // Replace inputSelector with a CSS selector |
| // matching your search input |
| inputSelector: '#search-input', |
| // algoliaOptions: { 'facetFilters': ["version:$VERSION"] }, |
| |
| // Set debug to true to inspect the dropdown |
| debug: false, |
| }); |
| </script> |
| <script type='module' src='/assets/js/index.js?1610386844' async crossorigin></script> |
| <script type='module' src='/assets/js/versioning.js?1610386844' async crossorigin></script> |
| </body> |
| |
| </html> |
