| <!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 name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Client Command Line - Apache Gearpump(incubating)</title> |
| |
| |
| <link rel="shortcut icon" href="../../img/favicon.ico"> |
| |
| |
| <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 = "Client Command Line"; |
| </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> |
| <script src="../../js/theme.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> |
| <li class="toctree-l1 "> |
| <a class="" href="../../index.html">Overview</a> |
| |
| </li> |
| <li> |
| |
| <li> |
| <ul class="subnav"> |
| <li><span>Introduction</span></li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../submit-your-1st-application/index.html">Submit Your 1st Application</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 current"> |
| <a class="current" href="index.html">Client Command Line</a> |
| |
| <ul> |
| |
| <li class="toctree-l3"><a href="#creating-an-uber-jar">Creating an uber-jar</a></li> |
| |
| |
| <li class="toctree-l3"><a href="#submit-an-new-application">Submit an new application</a></li> |
| |
| |
| <li class="toctree-l3"><a href="#list-all-running-applications">List all running applications</a></li> |
| |
| |
| <li class="toctree-l3"><a href="#kill-a-running-application">Kill a running application</a></li> |
| |
| |
| <li class="toctree-l3"><a href="#submit-a-storm-application-to-gearpump-cluster">Submit a storm application to Gearpump Cluster</a></li> |
| |
| |
| <li class="toctree-l3"><a href="#start-gearpump-cluster-on-yarn">Start Gearpump Cluster on YARN</a></li> |
| |
| |
| <li class="toctree-l3"><a href="#start-a-local-cluster">Start a local cluster</a></li> |
| |
| |
| <li class="toctree-l3"><a href="#start-master-daemons">Start master daemons</a></li> |
| |
| |
| <li class="toctree-l3"><a href="#start-worker-daemons">Start worker daemons</a></li> |
| |
| |
| <li class="toctree-l3"><a href="#start-ui-server">Start UI server</a></li> |
| |
| |
| </ul> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../basic-concepts/index.html">Basic Concepts</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../features/index.html">Technical Highlights</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../message-delivery/index.html">Reliable Message Delivery</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../performance-report/index.html">Performance</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../gearpump-internals/index.html">Gearpump Internals</a> |
| |
| </li> |
| |
| |
| </ul> |
| <li> |
| |
| <li> |
| <ul class="subnav"> |
| <li><span>Deployment</span></li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/deployment-local/index.html">Local Mode</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/deployment-standalone/index.html">Standalone Mode</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/deployment-yarn/index.html">YARN Mode</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/deployment-docker/index.html">Docker Mode</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/deployment-ui-authentication/index.html">UI Authentication</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/deployment-ha/index.html">High Availability</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/deployment-msg-delivery/index.html">Reliable Message Delivery</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/deployment-configuration/index.html">Configuration</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/deployment-resource-isolation/index.html">Resource Isolation</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/deployment-security/index.html">YARN Security Guide</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/get-gearpump-distribution/index.html">How to Get Your Gearpump Distribution</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../deployment/hardware-requirement/index.html">Hardware Requirement</a> |
| |
| </li> |
| |
| |
| </ul> |
| <li> |
| |
| <li> |
| <ul class="subnav"> |
| <li><span>Programming Guide</span></li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../dev/dev-write-1st-app/index.html">Write Your 1st App</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../dev/dev-custom-serializer/index.html">Customized Message Passing</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../dev/dev-connectors/index.html">Gearpump Connectors</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../dev/dev-storm/index.html">Storm Compatibility</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../dev/dev-ide-setup/index.html">IDE Setup</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../dev/dev-non-streaming-example/index.html">Non Streaming Examples</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../dev/dev-rest-api/index.html">REST API</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../api/scala/index.html">Scala API</a> |
| |
| </li> |
| |
| |
| |
| <li class="toctree-l1 "> |
| <a class="" href="../../api/java/index.html">Java API</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>Introduction »</li> |
| |
| |
| |
| <li>Client Command Line</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="https://github.com/apache/incubator-gearpump" class="icon icon-github"> Edit on GitHub</a> |
| |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main"> |
| <div class="section"> |
| |
| <p>The commands can be found at: "bin" folder of Gearpump binary.</p> |
| <p><strong>NOTE:</strong> on MS Windows platform, please use window shell gear.bat script instead. bash script doesn't work well in cygwin/mingw.</p> |
| <h3 id="creating-an-uber-jar">Creating an uber-jar</h3> |
| <p>If you use Maven you can have a look <a href="https://maven.apache.org/plugins/maven-shade-plugin/">here</a> whereas SBT users may find <a href="https://github.com/sbt/sbt-assembly">this</a> useful.</p> |
| <h3 id="submit-an-new-application">Submit an new application</h3> |
| <p>You can use the command <code>gear</code> under the bin directory to submit, query and terminate an application:</p> |
| <pre class="codehilite"><code class="language-bash">gear app [-namePrefix <application name prefix>] [-executors <number of executors to launch>] [-conf <custom gearpump config file>] -jar xx.jar MainClass <arg1> <arg2> ...</code></pre> |
| |
| |
| <h3 id="list-all-running-applications">List all running applications</h3> |
| <p>To list all running applications:</p> |
| <pre class="codehilite"><code class="language-bash">gear info [-conf <custom gearpump config file>]</code></pre> |
| |
| |
| <h3 id="kill-a-running-application">Kill a running application</h3> |
| <p>To kill an application:</p> |
| <pre class="codehilite"><code class="language-bash">gear kill -appid <application id> [-conf <custom gearpump config file>]</code></pre> |
| |
| |
| <h3 id="submit-a-storm-application-to-gearpump-cluster">Submit a storm application to Gearpump Cluster</h3> |
| <p>For example, to submit a storm application jar:</p> |
| <pre class="codehilite"><code class="language-bash">storm -verbose -config storm.yaml -jar storm-starter-${STORM_VERSION}.jar storm.starter.ExclamationTopology exclamation</code></pre> |
| |
| |
| <p><a href="../../dev/dev-storm">Storm Compatibility Guide</a></p> |
| <h3 id="start-gearpump-cluster-on-yarn">Start Gearpump Cluster on YARN</h3> |
| <p>To start a Gearpump Cluster on YARN, you can:</p> |
| <pre class="codehilite"><code class="language-bash">yarnclient launch -package /usr/lib/gearpump/gearpump-2.11-0.8.3.zip</code></pre> |
| |
| |
| <p><code>/usr/lib/gearpump/gearpump-2.11-0.8.3.zip</code> should be available on HDFS.</p> |
| <p>Please check <a href="../../deployment/deployment-yarn">YARN Deployment Guide</a> for more information.</p> |
| <h3 id="start-a-local-cluster">Start a local cluster</h3> |
| <p>Masters and workers will be started in one machine:</p> |
| <pre class="codehilite"><code class="language-bash">local</code></pre> |
| |
| |
| <p>Check <a href="../../deployment/deployment-local">Deployment Guide for Local Cluster</a> for more information.</p> |
| <h3 id="start-master-daemons">Start master daemons</h3> |
| <pre class="codehilite"><code class="language-bash">master -ip <Ip address> -port <port where this master is hooking></code></pre> |
| |
| |
| <p>Please check <a href="../../deployment/deployment-standalone">Deployment for Standalone mode</a> for more information.</p> |
| <h3 id="start-worker-daemons">Start worker daemons</h3> |
| <pre class="codehilite"><code class="language-bash">worker</code></pre> |
| |
| |
| <p>Please check <a href="../../deployment/deployment-standalone">Deployment for Standalone mode</a> for more information.</p> |
| <h3 id="start-ui-server">Start UI server</h3> |
| <p>To start UI server, you can:</p> |
| <pre class="codehilite"><code class="language-bash">services [-master <host:port>]</code></pre> |
| |
| |
| <p>The default username and password is "admin:admin", you can check |
| <a href="../../deployment/deployment-ui-authentication">UI Authentication</a> to find how to manage users.</p> |
| |
| </div> |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../basic-concepts/index.html" class="btn btn-neutral float-right" title="Basic Concepts"/>Next <span class="icon icon-circle-arrow-right"></span></a> |
| |
| |
| <a href="../submit-your-1st-application/index.html" class="btn btn-neutral" title="Submit Your 1st Application"><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 class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a> |
| |
| |
| <span><a href="../submit-your-1st-application/index.html" style="color: #fcfcfc;">« Previous</a></span> |
| |
| |
| <span style="margin-left: 15px"><a href="../basic-concepts/index.html" style="color: #fcfcfc">Next »</a></span> |
| |
| </span> |
| </div> |
| |
| </body> |
| </html> |