blob: 911c1ae89bf8d2c3d02f60c36dae26c10aa491c3 [file] [log] [blame]
<!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>Submit Your 1st Application - 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 = "Submit Your 1st Application";
var mkdocs_page_input_path = "introduction/submit-your-1st-application.md";
var mkdocs_page_url = "/introduction/submit-your-1st-application/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=" current">
<a class="current" href="index.html">Submit Your 1st Application</a>
<ul class="subnav">
<li class="toctree-l3"><a href="#steps-to-submit-your-first-application">Steps to submit your first Application</a></li>
<ul>
<li><a class="toctree-l4" href="#step-1-submit-application">Step 1: Submit application</a></li>
<li><a class="toctree-l4" href="#step-2-congratulations-youve-submitted-your-first-application">Step 2: Congratulations, you've submitted your first application.</a></li>
</ul>
<li class="toctree-l3"><a href="#other-application-examples">Other Application Examples</a></li>
</ul>
</li>
<li class="">
<a class="" href="../commandline/index.html">Client Command Line</a>
</li>
<li class="">
<a class="" href="../basic-concepts/index.html">Basic Concepts</a>
</li>
<li class="">
<a class="" href="../features/index.html">Technical Highlights</a>
</li>
<li class="">
<a class="" href="../message-delivery/index.html">Reliable Message Delivery</a>
</li>
<li class="">
<a class="" href="../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/deployment-local/index.html">Local Mode</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-standalone/index.html">Standalone Mode</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-yarn/index.html">YARN Mode</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-docker/index.html">Docker Mode</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-ui-authentication/index.html">UI Authentication</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-ha/index.html">High Availability</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-msg-delivery/index.html">Reliable Message Delivery</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-configuration/index.html">Configuration</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-resource-isolation/index.html">Resource Isolation</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-security/index.html">YARN Security Guide</a>
</li>
<li class="">
<a class="" href="../../deployment/get-gearpump-distribution/index.html">How to Get Your Gearpump Distribution</a>
</li>
<li class="">
<a class="" href="../../deployment/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>
&nbsp;
</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> &raquo;</li>
<li>Introduction &raquo;</li>
<li>Submit Your 1st Application</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/apache/incubator-gearpump/edit/master/docs/contents/introduction/submit-your-1st-application.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Before you can submit and run your first Gearpump application, you will need a running Gearpump service.
There are multiple ways to run Gearpump <a href="../../deployment/deployment-local">Local mode</a>, <a href="../../deployment/deployment-standalone">Standalone mode</a>, <a href="../../deployment/deployment-yarn">YARN mode</a> or <a href="../../deployment/deployment-docker">Docker mode</a>.</p>
<p>The easiest way is to run Gearpump in <a href="../../deployment/deployment-local">Local mode</a>.
Any Linux, MacOSX or Windows desktop can be used with zero configuration.</p>
<p>In the example below, we assume your are running in <a href="../../deployment/deployment-local">Local mode</a>.
If you running Gearpump in one of the other modes, you will need to configure the Gearpump client to
connect to the Gearpump service by setting the <code>gear.conf</code> configuration path in classpath.
Within this file, you will need to change the parameter <code>gearpump.cluster.masters</code> to the correct Gearpump master(s).
See <a href="../../deployment/deployment-configuration">Configuration</a> for details.</p>
<h2 id="steps-to-submit-your-first-application">Steps to submit your first Application</h2>
<h3 id="step-1-submit-application">Step 1: Submit application</h3>
<p>After the cluster is started, you can submit an example wordcount application to the cluster</p>
<p>Open another shell,</p>
<pre class="codehilite"><code class="language-bash">### To run WordCount example
bin/gear app -jar examples/wordcount-2.11-0.8.4-assembly.jar org.apache.gearpump.streaming.examples.wordcount.WordCount</code></pre>
<h3 id="step-2-congratulations-youve-submitted-your-first-application">Step 2: Congratulations, you've submitted your first application.</h3>
<p>To view the application status and metrics, start the Web UI services, and browse to <a href="http://127.0.0.1:8090">http://127.0.0.1:8090</a> to check the status.
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>
<p><img alt="Dashboard" src="../../img/dashboard.gif" /></p>
<p><strong>NOTE:</strong> the UI port setting can be defined in configuration, please check section <a href="../../deployment/deployment-configuration">Configuration</a>.</p>
<h2 id="other-application-examples">Other Application Examples</h2>
<p>Besides wordcount, there are several other example applications. Please check the source tree <code>examples/</code> for detail information.</p>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../commandline/index.html" class="btn btn-neutral float-right" title="Client Command Line">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../../index.html" class="btn btn-neutral" title="Overview"><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="../../index.html" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../commandline/index.html" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script src="../../js/theme.js"></script>
</body>
</html>