| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| |
| <link rel="shortcut icon" href="../../img/favicon.ico"> |
| <title>How to Get Your Gearpump Distribution - Apache Gearpump(incubating)</title> |
| <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> |
| |
| <link rel="stylesheet" href="../../css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" /> |
| <link rel="stylesheet" href="../../css/highlight.css"> |
| |
| <script> |
| // Current page data |
| var mkdocs_page_name = "How to Get Your Gearpump Distribution"; |
| var mkdocs_page_input_path = "deployment/get-gearpump-distribution.md"; |
| var mkdocs_page_url = "/deployment/get-gearpump-distribution/index.html"; |
| </script> |
| |
| <script src="../../js/jquery-2.1.1.min.js"></script> |
| <script src="../../js/modernizr-2.8.3.min.js"></script> |
| <script type="text/javascript" src="../../js/highlight.pack.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| <div class="wy-grid-for-nav"> |
| |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> |
| <div class="wy-side-nav-search"> |
| <a href="../../index.html" class="icon icon-home"> Apache Gearpump(incubating)</a> |
| <div role="search"> |
| <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| </form> |
| </div> |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| <ul class="current"> |
| |
| |
| <li class="toctree-l1"> |
| |
| <a class="" href="../../index.html">Overview</a> |
| </li> |
| |
| <li class="toctree-l1"> |
| |
| <span class="caption-text">Introduction</span> |
| <ul class="subnav"> |
| <li class=""> |
| |
| <a class="" href="../../introduction/submit-your-1st-application/index.html">Submit Your 1st Application</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../introduction/commandline/index.html">Client Command Line</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../introduction/basic-concepts/index.html">Basic Concepts</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../introduction/features/index.html">Technical Highlights</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../introduction/message-delivery/index.html">Reliable Message Delivery</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../introduction/performance-report/index.html">Performance</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li class="toctree-l1"> |
| |
| <span class="caption-text">Deployment</span> |
| <ul class="subnav"> |
| <li class=""> |
| |
| <a class="" href="../deployment-local/index.html">Local Mode</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../deployment-standalone/index.html">Standalone Mode</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../deployment-yarn/index.html">YARN Mode</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../deployment-docker/index.html">Docker Mode</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../deployment-ui-authentication/index.html">UI Authentication</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../deployment-ha/index.html">High Availability</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../deployment-msg-delivery/index.html">Reliable Message Delivery</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../deployment-configuration/index.html">Configuration</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../deployment-resource-isolation/index.html">Resource Isolation</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../deployment-security/index.html">YARN Security Guide</a> |
| </li> |
| <li class=" current"> |
| |
| <a class="current" href="index.html">How to Get Your Gearpump Distribution</a> |
| <ul class="subnav"> |
| |
| <li class="toctree-l3"><a href="#prepare-the-binary">Prepare the binary</a></li> |
| |
| <ul> |
| |
| <li><a class="toctree-l4" href="#download-release-binary">Download Release Binary</a></li> |
| |
| <li><a class="toctree-l4" href="#build-from-source-code">Build from Source code</a></li> |
| |
| </ul> |
| |
| |
| <li class="toctree-l3"><a href="#gearpump-package-structure">Gearpump package structure</a></li> |
| |
| |
| </ul> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../hardware-requirement/index.html">Hardware Requirement</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li class="toctree-l1"> |
| |
| <span class="caption-text">Programming Guide</span> |
| <ul class="subnav"> |
| <li class=""> |
| |
| <a class="" href="../../dev/dev-write-1st-app/index.html">Write Your 1st App</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../dev/dev-custom-serializer/index.html">Customized Message Passing</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../dev/dev-connectors/index.html">Gearpump Connectors</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../dev/dev-storm/index.html">Storm Compatibility</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../dev/dev-ide-setup/index.html">IDE Setup</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../dev/dev-non-streaming-example/index.html">Non Streaming Examples</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../dev/dev-rest-api/index.html">REST API</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../api/scala/index.html">Scala API</a> |
| </li> |
| <li class=""> |
| |
| <a class="" href="../../api/java/index.html">Java API</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li class="toctree-l1"> |
| |
| <span class="caption-text">Internals</span> |
| <ul class="subnav"> |
| <li class=""> |
| |
| <a class="" href="../../internals/gearpump-internals/index.html">Gearpump Internals</a> |
| </li> |
| </ul> |
| </li> |
| |
| </ul> |
| </div> |
| |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../index.html">Apache Gearpump(incubating)</a> |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../../index.html">Docs</a> »</li> |
| |
| |
| |
| <li>Deployment »</li> |
| |
| |
| |
| <li>How to Get Your Gearpump Distribution</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="https://github.com/apache/incubator-gearpump/edit/master/docs/contents/deployment/get-gearpump-distribution.md" |
| class="icon icon-github"> Edit on GitHub</a> |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main"> |
| <div class="section"> |
| |
| <h3 id="prepare-the-binary">Prepare the binary</h3> |
| <p>You can either download pre-build release package or choose to build from source code.</p> |
| <h4 id="download-release-binary">Download Release Binary</h4> |
| <p>If you choose to use pre-build package, then you don't need to build from source code. The release package can be downloaded from:</p> |
| <h5 id="download-page"><a href="http://gearpump.incubator.apache.org/downloads.html">Download page</a></h5> |
| <h4 id="build-from-source-code">Build from Source code</h4> |
| <p>If you choose to build the package from source code yourself, you can follow these steps:</p> |
| <p>1). Clone the Gearpump repository</p> |
| <pre class="codehilite"><code class="language-bash">git clone https://github.com/apache/incubator-gearpump.git</code></pre> |
| |
| |
| <p>cd gearpump</p> |
| <p>2). Build package</p> |
| <pre class="codehilite"><code class="language-bash">## Please use scala 2.11 |
| ## The target package path: output/target/gearpump-2.11-0.8.4.zip |
| sbt clean assembly packArchiveZip</code></pre> |
| |
| |
| <p>After the build, there will be a package file gearpump-2.11-0.8.4.zip generated under output/target/ folder.</p> |
| <p><strong>NOTE:</strong> |
| Please set JAVA_HOME environment before the build.</p> |
| <p>On linux:</p> |
| <pre class="codehilite"><code class="language-bash">export JAVA_HOME={path/to/jdk/root/path}</code></pre> |
| |
| |
| <p>On Windows:</p> |
| <pre class="codehilite"><code class="language-bash">set JAVA_HOME={path/to/jdk/root/path}</code></pre> |
| |
| |
| <p><strong>NOTE:</strong> |
| The build requires network connection. If you are behind an enterprise proxy, make sure you have set the proxy in your env before running the build commands. |
| For windows:</p> |
| <pre class="codehilite"><code class="language-bash">set HTTP_PROXY=http://host:port |
| set HTTPS_PROXY= http://host:port</code></pre> |
| |
| |
| <p>For Linux:</p> |
| <pre class="codehilite"><code class="language-bash">export HTTP_PROXY=http://host:port |
| export HTTPS_PROXY= http://host:port</code></pre> |
| |
| |
| <h3 id="gearpump-package-structure">Gearpump package structure</h3> |
| <p>You need to flatten the <code>.zip</code> file to use it. On Linux, you can</p> |
| <pre class="codehilite"><code class="language-bash">unzip gearpump-2.11-0.8.4.zip</code></pre> |
| |
| |
| <p>After decompression, the directory structure looks like picture 1.</p> |
| <p><img alt="Layout" src="../../img/layout.png" /></p> |
| <p>Under bin/ folder, there are script files for Linux(bash script) and Windows(.bat script).</p> |
| <table> |
| <thead> |
| <tr> |
| <th>script</th> |
| <th>function</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>local</td> |
| <td>You can start the Gearpump cluster in single JVM(local mode), or in a distributed cluster(cluster mode). To start the cluster in local mode, you can use the local /local.bat helper scripts, it is very useful for developing or troubleshooting.</td> |
| </tr> |
| <tr> |
| <td>master</td> |
| <td>To start Gearpump in cluster mode, you need to start one or more master nodes, which represent the global resource management center. master/master.bat is launcher script to boot the master node.</td> |
| </tr> |
| <tr> |
| <td>worker</td> |
| <td>To start Gearpump in cluster mode, you also need to start several workers, with each worker represent a set of local resources. worker/worker.bat is launcher script to start the worker node.</td> |
| </tr> |
| <tr> |
| <td>services</td> |
| <td>This script is used to start backend REST service and other services for frontend UI dashboard (Default user "admin, admin").</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>Please check <a href="../../introduction/commandline">Command Line Syntax</a> for more information for each script.</p> |
| |
| </div> |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../hardware-requirement/index.html" class="btn btn-neutral float-right" title="Hardware Requirement">Next <span class="icon icon-circle-arrow-right"></span></a> |
| |
| |
| <a href="../deployment-security/index.html" class="btn btn-neutral" title="YARN Security Guide"><span class="icon icon-circle-arrow-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <!-- Copyright etc --> |
| |
| </div> |
| |
| Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| <div class="rst-versions" role="note" style="cursor: pointer"> |
| <span class="rst-current-version" data-toggle="rst-current-version"> |
| |
| <a href="https://github.com/apache/incubator-gearpump" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> |
| |
| |
| <span><a href="../deployment-security/index.html" style="color: #fcfcfc;">« Previous</a></span> |
| |
| |
| <span style="margin-left: 15px"><a href="../hardware-requirement/index.html" style="color: #fcfcfc">Next »</a></span> |
| |
| </span> |
| </div> |
| <script src="../../js/theme.js"></script> |
| |
| </body> |
| </html> |
