You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fluo.apache.org by mw...@apache.org on 2017/10/06 15:38:50 UTC
[fluo-website] branch asf-site updated: Jekyll build from
gh-pages:203a281
This is an automated email from the ASF dual-hosted git repository.
mwalch pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/fluo-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new bce04a0 Jekyll build from gh-pages:203a281
bce04a0 is described below
commit bce04a0d67926fd0365c7cdce96e83eae835d74d
Author: Mike Walch <mw...@apache.org>
AuthorDate: Fri Oct 6 11:38:31 2017 -0400
Jekyll build from gh-pages:203a281
Major refactor of Fluo docs (#99)
* Added docker and yarn instructions
* Split up applications page
* Create quick start
---
.../{index.html => administration/initialize.html} | 155 ++++++---
.../1.2/administration/manage-applications.html | 355 ++++++++++++++++++++
docs/fluo/1.2/administration/metrics.html | 40 +--
.../1.2/administration/run-fluo-in-docker.html | 363 +++++++++++++++++++++
.../run-fluo-in-yarn.html} | 222 ++++++-------
.../run-fluo-processes.html} | 109 ++++---
.../create-application.html} | 293 ++---------------
docs/fluo/1.2/getting-started/design.html | 40 +--
.../{install.html => install-fluo.html} | 56 ++--
.../quick-start.html} | 89 ++---
docs/fluo/1.2/index.html | 40 +--
feed.xml | 4 +-
12 files changed, 1142 insertions(+), 624 deletions(-)
diff --git a/docs/fluo/1.2/index.html b/docs/fluo/1.2/administration/initialize.html
similarity index 53%
copy from docs/fluo/1.2/index.html
copy to docs/fluo/1.2/administration/initialize.html
index c44185f..5317b51 100644
--- a/docs/fluo/1.2/index.html
+++ b/docs/fluo/1.2/administration/initialize.html
@@ -8,10 +8,10 @@
<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cosmo/bootstrap.min.css" rel="stylesheet" integrity="sha384-h21C2fcDk/eFsW9sC9h0dhokq5pDinLNklTKoxIZRUn3+hvmgQSffLLQ4G4l2eEr" crossorigin="anonymous">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
<link rel="stylesheet" href="/css/fluo.css">
- <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/index">
+ <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/administration/initialize">
<link rel="icon" type="image/png" href="/resources/favicon.png">
- <title>Apache Fluo documentation | Apache Fluo</title>
+ <title>Initialize Application | Apache Fluo</title>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
@@ -120,8 +120,6 @@
-
-
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
<a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="false" aria-controls="collapsegetting-started">
@@ -135,7 +133,11 @@
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/design">Design</a></div>
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install">Installation</a></div>
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/quick-start">Quick Start</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install-fluo">Install Fluo</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/create-application">Create Application</a></div>
</div>
</div>
@@ -148,24 +150,6 @@
- <div class="panel-heading" role="tab" id="headingOne">
- <h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsedevelopment" aria-expanded="false" aria-controls="collapsedevelopment">
- Development
- </a>
- </h4>
- </div>
- <div id="collapsedevelopment" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
- <div class="panel-body">
-
-
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/development/applications">Applications</a></div>
-
- </div>
- </div>
-
-
-
@@ -174,15 +158,25 @@
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseadministration" aria-expanded="false" aria-controls="collapseadministration">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseadministration" aria-expanded="true" aria-controls="collapseadministration">
Administration
</a>
</h4>
</div>
- <div id="collapseadministration" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div id="collapseadministration" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
<div class="panel-body">
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/initialize">Initialize Application</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-processes">Run Fluo processes</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn">Run Fluo in YARN</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-docker">Run Fluo in Docker</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/manage-applications">Manage Applications</a></div>
+
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/metrics">Metrics</a></div>
</div>
@@ -193,38 +187,117 @@
-
-
</div>
</div>
</div>
<div class="col-md-10">
+ <p>Fluo 1.2.0 documentation >> Administration >> Initialize Application</p>
+
- <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
+ <div class="alert alert-warning" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Apache Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
<div class="row">
- <div class="col-md-10"><h1>Apache Fluo documentation</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/index.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-10"><h1>Initialize Application</h1></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/initialize.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
- <p><!DOCTYPE html></p>
-<html lang="en-US">
-<meta charset="utf-8" />
-<title>Redirecting…</title>
-<link rel="canonical" href="getting-started/design" />
-<meta http-equiv="refresh" content="0; url=getting-started/design" />
-<h1>Redirecting…</h1>
-<a href="getting-started/design">Click here if you are not redirected.</a>
-<script>location="getting-started/design"</script>
-</html>
+ <h2 id="overview">Overview</h2>
+
+<p>Before a Fluo Application can run, it must be initialized. Below is an overview of what
+initialization does and some of the properties that may be set for initialization.</p>
+
+<ul>
+ <li><strong>Initialize ZooKeeper</strong> - Each application has its own area in ZooKeeper used for configuration,
+Oracle state, and worker coordination. All properties, except <code class="highlighter-rouge">fluo.connections.*</code>, are copied
+into ZooKeeper. For example, if <code class="highlighter-rouge">fluo.worker.num.threads=128</code> was set, then when a worker process
+starts it will read this from ZooKeeper.</li>
+ <li><strong>Copy Observer jars to DFS</strong> - Fluo workers processes need the jars containing observers. These
+are provided in one of the following ways.
+ <ul>
+ <li>Set the property <code class="highlighter-rouge">fluo.observer.init.dir</code> to a local directory containing observer jars. The
+jars in this directory are copied to DFS under <code class="highlighter-rouge"><fluo.dfs.root>/<app name></code>. When a worker is
+started, the jars are pulled from DFS and added to its classpath.</li>
+ <li>Set the property <code class="highlighter-rouge">fluo.observer.jars.url</code> to a directory in DFS containing observer jars. No
+copying is done. When a worker is started, the jars are pulled from this location and added to
+its classpath.</li>
+ <li>Do not set any of the properties above and have the mechanism that starts the worker process
+add the needed jars to the classpath.</li>
+ </ul>
+ </li>
+ <li><strong>Create Accumulo table</strong> - Each Fluo application creates and configures an Accumulo table. The
+<code class="highlighter-rouge">fluo.accumulo.*</code> properties determine which Accumulo instance is used. For performance reasons,
+Fluo runs its own code in Accumulo tablet servers. Fluo attempts to copy Fluo jars into DFS and
+configure Accumulo to use them. Fluo first checks the property <code class="highlighter-rouge">fluo.accumulo.jars</code> and if set,
+copies the jars listed there. If that property is not set, then Fluo looks on the classpath to
+find jars. Jars are copied to a location under <code class="highlighter-rouge"><fluo.dfs.root>/<app name></code>.</li>
+</ul>
+
+<h2 id="instructions">Instructions</h2>
+
+<p>Below are the steps to initialize an application from the command line. It is also possible to
+initialize an application using Fluo’s Java API.</p>
+
+<ol>
+ <li>
+ <p>Create a copy of <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-app.properties">fluo-app.properties</a> for your Fluo application.</p>
+
+ <div class="highlighter-rouge"><pre class="highlight"><code> cp $FLUO_HOME/conf/fluo-app.properties /path/to/myapp/fluo-app.properties
+</code></pre>
+ </div>
+ </li>
+ <li>
+ <p>Edit your copy of <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-app.properties">fluo-app.properties</a> and make sure to set the following:</p>
+
+ <ul>
+ <li>Class name of your ObserverProvider</li>
+ <li>Paths to your Fluo observer jars</li>
+ <li>Accumulo configuration</li>
+ <li>DFS configuration</li>
+ </ul>
+
+ <p>When configuring the observer section of fluo-app.properties, you can configure your instance for the
+<a href="https://github.com/astralway/phrasecount">phrasecount</a> application if you have not created your own application. See the <a href="https://github.com/astralway/phrasecount">phrasecount</a>
+example for instructions. You can also choose not to configure any observers but your workers will
+be idle when started.</p>
+ </li>
+ <li>
+ <p>Run the command below to initialize your Fluo application. Change <code class="highlighter-rouge">myapp</code> to your application name:</p>
+
+ <div class="highlighter-rouge"><pre class="highlight"><code> fluo init myapp /path/to/myapp/fluo-app.properties
+</code></pre>
+ </div>
+
+ <p>A Fluo application only needs to be initialized once. After initialization, the Fluo application
+name is used to start/stop the application and scan the Fluo table.</p>
+ </li>
+ <li>
+ <p>Run <code class="highlighter-rouge">fluo list</code> which connects to Fluo and lists applications to verify initialization.</p>
+ </li>
+ <li>
+ <p>Run <code class="highlighter-rouge">fluo config myapp</code> to see what configuration is stored in ZooKeeper.</p>
+ </li>
+</ol>
+
+<h2 id="next-steps">Next Steps</h2>
+
+<p>Run your Fluo application using one of the methods below:</p>
+
+<ul>
+ <li><a href="/docs/fluo/1.2/administration/run-fluo-processes/">Run Fluo processes</a></li>
+ <li><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn/">Run Fluo in YARN</a></li>
+ <li><a href="/docs/fluo/1.2/administration/run-fluo-in-docker/">Run Fluo in Docker</a> which enables running in Mesos and Kubernetes</li>
+</ul>
+
+<p>Also, learn how to <a href="/docs/fluo/1.2/administration/manage-applications/">manage Fluo applications</a>.</p>
+
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases in the <a href="/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/index.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/initialize.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
</div>
</div>
diff --git a/docs/fluo/1.2/administration/manage-applications.html b/docs/fluo/1.2/administration/manage-applications.html
new file mode 100644
index 0000000..e208b53
--- /dev/null
+++ b/docs/fluo/1.2/administration/manage-applications.html
@@ -0,0 +1,355 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+
+ <link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cosmo/bootstrap.min.css" rel="stylesheet" integrity="sha384-h21C2fcDk/eFsW9sC9h0dhokq5pDinLNklTKoxIZRUn3+hvmgQSffLLQ4G4l2eEr" crossorigin="anonymous">
+ <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
+ <link rel="stylesheet" href="/css/fluo.css">
+ <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/administration/manage-applications">
+ <link rel="icon" type="image/png" href="/resources/favicon.png">
+
+ <title>Manage Applications | Apache Fluo</title>
+
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+ <!-- Place your <script> tags here. -->
+
+<!-- Google Analytics -->
+<script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-55360307-1', 'auto');
+ ga('send', 'pageview');
+
+</script>
+
+<script>window.twttr = (function(d, s, id) {
+ var js, fjs = d.getElementsByTagName(s)[0],
+ t = window.twttr || {};
+ if (d.getElementById(id)) return t;
+ js = d.createElement(s);
+ js.id = id;
+ js.src = "https://platform.twitter.com/widgets.js";
+ fjs.parentNode.insertBefore(js, fjs);
+
+ t._e = [];
+ t.ready = function(f) {
+ t._e.push(f);
+ };
+
+ return t;
+}(document, "script", "twitter-wjs"));</script>
+
+ </head>
+ <body style="padding-top: 100px">
+ <nav id="fluo-nav" class="navbar navbar-default navbar-fixed-top">
+ <div class="container">
+ <div class="navbar-header">
+ <div class="navbar-toggle-wrapper visible-xs">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".js-navbar-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ </div>
+ <a href="/" class="navbar-brand"><img id="fluo-img" height="40px" src="/resources/fluo-logo-dark.png" alt="Apache Fluo"></a>
+ </div>
+ <div class="collapse navbar-collapse js-navbar-collapse" style="margin-top: 20px">
+ <ul class="navbar-nav nav">
+ <li><a href="/release/">Releases</a></li>
+ <li><a href="/tour/">Tour</a></li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Docs<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/docs/fluo/1.1.0-incubating/">Fluo</a></li>
+ <li><a href="/docs/fluo-recipes/1.1.0-incubating/">Fluo Recipes</a></li>
+ </ul>
+ </li>
+ <li><a href="/api/">API</a></li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Community<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/contactus/">Contact Us</a></li>
+ <li><a href="/news/">News Archive</a></li>
+ <li><a href="/people/">People</a></li>
+ <li><a href="/related-projects/">Related Projects</a></li>
+ <li><a href="/poweredby/">Powered By</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Contributing<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/how-to-contribute/">How To Contribute</a></li>
+ <li><a href="/release-process/">Release Process</a></li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="navbar-nav nav navbar-right">
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="https://www.apache.org">Apache Homepage</a></li>
+ <li><a href="https://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship">Sponsorship</i></a></li>
+ <li><a href="https://www.apache.org/security">Security</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks">Thanks</a></li>
+ <li><a href="https://www.apache.org/foundation/policies/conduct">Code of Conduct</a></li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </nav>
+ <div class="container">
+ <div class="row">
+ <div class="col-sm-12">
+ <div class="row">
+ <div class="col-md-2">
+ <div class="panel-group" id="accordion" role="tablist" aria-multiselectable="true" data-spy="affix">
+ <div class="panel panel-default">
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="false" aria-controls="collapsegetting-started">
+ Getting started
+ </a>
+ </h4>
+ </div>
+ <div id="collapsegetting-started" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/design">Design</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/quick-start">Quick Start</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install-fluo">Install Fluo</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/create-application">Create Application</a></div>
+
+ </div>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseadministration" aria-expanded="true" aria-controls="collapseadministration">
+ Administration
+ </a>
+ </h4>
+ </div>
+ <div id="collapseadministration" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/initialize">Initialize Application</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-processes">Run Fluo processes</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn">Run Fluo in YARN</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-docker">Run Fluo in Docker</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/manage-applications">Manage Applications</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/metrics">Metrics</a></div>
+
+ </div>
+ </div>
+
+
+
+
+
+
+
+ </div>
+ </div>
+ </div>
+ <div class="col-md-10">
+
+ <p>Fluo 1.2.0 documentation >> Administration >> Manage Applications</p>
+
+
+ <div class="alert alert-warning" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Apache Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
+
+
+ <div class="row">
+ <div class="col-md-10"><h1>Manage Applications</h1></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/manage-applications.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ </div>
+
+ <p>This page contains information on managing Fluo applications.</p>
+
+<h2 id="viewing-data">Viewing data</h2>
+
+<p>When you have data in your Fluo application, you can view it using the command <code class="highlighter-rouge">fluo scan myapp</code>.
+Pipe the output to <code class="highlighter-rouge">less</code> using the command <code class="highlighter-rouge">fluo scan myapp | less</code> if you want to page through the data.</p>
+
+<h2 id="get-status-of-all-applications">Get status of all applications</h2>
+
+<p>To list all Fluo applications, run <code class="highlighter-rouge">fluo list</code>.</p>
+
+<h2 id="running-application-code">Running application code</h2>
+
+<p>The <code class="highlighter-rouge">fluo exec <app name> <class> {arguments}</code> provides an easy way to execute application code. It
+will execute a class with a main method if a jar containing the class is included with the observer
+jars configured at initialization. When the class is run, Fluo classes and dependencies will be on
+the classpath. The <code class="highlighter-rouge">fluo exec</code> command can inject the applications configuration if the class is
+written in the following way. Defining the injection point is optional.</p>
+
+<div class="language-java highlighter-rouge"><pre class="highlight"><code><span class="kn">import</span> <span class="nn">javax.inject.Inject</span><span class="o">;</span>
+
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">AppCommand</span> <span class="o">{</span>
+
+ <span class="c1">//when run with fluo exec command, the applications configuration will be injected</span>
+ <span class="nd">@Inject</span>
+ <span class="kd">private</span> <span class="kd">static</span> <span class="n">FluoConfiguration</span> <span class="n">fluoConfig</span><span class="o">;</span>
+
+ <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>
+ <span class="k">try</span><span class="o">(</span><span class="n">FluoClient</span> <span class="n">fluoClient</span> <span class="o">=</span> <span class="n">FluoFactory</span><span class="o">.</span><span class="na">newClient</span><span class="o">(</span><span class="n">fluoConfig</span><span class="o">))</span> <span class="o">{</span>
+ <span class="c1">//do stuff with Fluo</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+<span class="o">}</span>
+</code></pre>
+</div>
+
+<h2 id="application-configuration">Application Configuration</h2>
+
+<p>For configuring observers, fluo provides a simple mechanism to set and access application specific
+configuration. See the javadoc on <a href="https://static.javadoc.io/org.apache.fluo/fluo-api/1.1.0-incubating/org/apache/fluo/api/client/FluoClient.html">FluoClient</a>.getAppConfiguration() for more details.</p>
+
+<h2 id="debugging-applications">Debugging Applications</h2>
+
+<p>While monitoring <a href="/docs/fluo/1.2/administration/metrics/">Fluo metrics</a> can detect problems (like too many transaction collisions)
+in a Fluo application, <a href="/docs/fluo/1.2/administration/metrics/">metrics</a> may not provide enough information to debug the root cause
+of the problem. To help debug Fluo applications, low-level logging of transactions can be turned on
+by setting the following loggers to TRACE:</p>
+
+<table>
+ <thead>
+ <tr>
+ <th>Logger</th>
+ <th>Level</th>
+ <th>Information</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>fluo.tx</td>
+ <td>TRACE</td>
+ <td>Provides detailed information about what transactions read and wrote</td>
+ </tr>
+ <tr>
+ <td>fluo.tx.summary</td>
+ <td>TRACE</td>
+ <td>Provides a one line summary about each transaction executed</td>
+ </tr>
+ <tr>
+ <td>fluo.tx.collisions</td>
+ <td>TRACE</td>
+ <td>Provides details about what data was involved When a transaction collides with another transaction</td>
+ </tr>
+ <tr>
+ <td>fluo.tx.scan</td>
+ <td>TRACE</td>
+ <td>Provides logging for each cell read by a scan. Scan summary logged at <code class="highlighter-rouge">fluo.tx</code> level. This allows suppression of <code class="highlighter-rouge">fluo.tx.scan</code> while still seeing summary.</td>
+ </tr>
+ </tbody>
+</table>
+
+<p>Below is an example log after setting <code class="highlighter-rouge">fluo.tx</code> to TRACE. The number following <code class="highlighter-rouge">txid: </code> is the
+transactions start timestamp from the Oracle.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>2015-02-11 18:24:05,341 [fluo.tx ] TRACE: txid: 3 begin() thread: 198
+2015-02-11 18:24:05,343 [fluo.tx ] TRACE: txid: 3 class: com.SimpleLoader
+2015-02-11 18:24:05,357 [fluo.tx ] TRACE: txid: 3 get(4333, stat count ) -> null
+2015-02-11 18:24:05,357 [fluo.tx ] TRACE: txid: 3 set(4333, stat count , 1)
+2015-02-11 18:24:05,441 [fluo.tx ] TRACE: txid: 3 commit() -> SUCCESSFUL commitTs: 4
+2015-02-11 18:24:05,341 [fluo.tx ] TRACE: txid: 5 begin() thread: 198
+2015-02-11 18:24:05,442 [fluo.tx ] TRACE: txid: 3 close()
+2015-02-11 18:24:05,343 [fluo.tx ] TRACE: txid: 5 class: com.SimpleLoader
+2015-02-11 18:24:05,357 [fluo.tx ] TRACE: txid: 5 get(4333, stat count ) -> 1
+2015-02-11 18:24:05,357 [fluo.tx ] TRACE: txid: 5 set(4333, stat count , 2)
+2015-02-11 18:24:05,441 [fluo.tx ] TRACE: txid: 5 commit() -> SUCCESSFUL commitTs: 6
+2015-02-11 18:24:05,442 [fluo.tx ] TRACE: txid: 5 close()
+</code></pre>
+</div>
+
+<p>The log above traces the following sequence of events.</p>
+
+<ul>
+ <li>Transaction T1 has a start timestamp of <code class="highlighter-rouge">3</code></li>
+ <li>Thread with id <code class="highlighter-rouge">198</code> is executing T1, its running code from the class <code class="highlighter-rouge">com.SimpleLoader</code></li>
+ <li>T1 reads row <code class="highlighter-rouge">4333</code> and column <code class="highlighter-rouge">stat count</code> which does not exist</li>
+ <li>T1 sets row <code class="highlighter-rouge">4333</code> and column <code class="highlighter-rouge">stat count</code> to <code class="highlighter-rouge">1</code></li>
+ <li>T1 commits successfully and its commit timestamp from the Oracle is <code class="highlighter-rouge">4</code>.</li>
+ <li>Transaction T2 has a start timestamp of <code class="highlighter-rouge">5</code> (because its <code class="highlighter-rouge">5</code> > <code class="highlighter-rouge">4</code> it can see what T1 wrote).</li>
+ <li>T2 reads a value of <code class="highlighter-rouge">1</code> for row <code class="highlighter-rouge">4333</code> and column <code class="highlighter-rouge">stat count</code></li>
+ <li>T2 sets row <code class="highlighter-rouge">4333</code> and column <code class="highlighter-rouge">stat count</code> to <code class="highlighter-rouge">2</code></li>
+ <li>T2 commits successfully with a commit timestamp of <code class="highlighter-rouge">6</code></li>
+</ul>
+
+<p>Below is an example log after only setting <code class="highlighter-rouge">fluo.tx.collisions</code> to TRACE. This setting will only log
+trace information when a collision occurs. Unlike the previous example, what the transaction read
+and wrote is not logged. This shows that a transaction with a start timestamp of <code class="highlighter-rouge">106</code> and a class
+name of <code class="highlighter-rouge">com.SimpleLoader</code> collided with another transaction on row <code class="highlighter-rouge">r1</code> and column <code class="highlighter-rouge">fam1 qual1</code>.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>2015-02-11 18:17:02,639 [tx.collisions] TRACE: txid: 106 class: com.SimpleLoader
+2015-02-11 18:17:02,639 [tx.collisions] TRACE: txid: 106 collisions: {r1=[fam1 qual1 ]}
+</code></pre>
+</div>
+
+<p>When applications read and write arbitrary binary data, this does not log so well. In order to make
+the trace logs human readable, non ASCII chars are escaped using hex. The convention used it <code class="highlighter-rouge">\xDD</code>
+where D is a hex digit. Also the <code class="highlighter-rouge">\</code> character is escaped to make the output unambiguous.</p>
+
+
+
+ <div class="row" style="margin-top: 20px;">
+ <div class="col-md-10"><strong>Find documentation for all Fluo releases in the <a href="/docs/">archive</strong></div>
+ <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/manage-applications.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ </div>
+ </div>
+</div>
+
+ </div>
+ </div>
+ <hr>
+ <div class="row footer">
+ <div class="col-sm-12 text-center">
+ <div class="center-block">
+ <a href="https://apache.org"><img src="/resources/feather.png" alt="Apache"></a>
+ Copyright © 2017 The Apache Software Foundation. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>
+ </div>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
diff --git a/docs/fluo/1.2/administration/metrics.html b/docs/fluo/1.2/administration/metrics.html
index 933ff2c..bf64509 100644
--- a/docs/fluo/1.2/administration/metrics.html
+++ b/docs/fluo/1.2/administration/metrics.html
@@ -120,8 +120,6 @@
-
-
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
<a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="false" aria-controls="collapsegetting-started">
@@ -135,7 +133,11 @@
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/design">Design</a></div>
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install">Installation</a></div>
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/quick-start">Quick Start</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install-fluo">Install Fluo</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/create-application">Create Application</a></div>
</div>
</div>
@@ -148,24 +150,6 @@
- <div class="panel-heading" role="tab" id="headingOne">
- <h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsedevelopment" aria-expanded="false" aria-controls="collapsedevelopment">
- Development
- </a>
- </h4>
- </div>
- <div id="collapsedevelopment" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
- <div class="panel-body">
-
-
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/development/applications">Applications</a></div>
-
- </div>
- </div>
-
-
-
@@ -183,6 +167,16 @@
<div class="panel-body">
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/initialize">Initialize Application</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-processes">Run Fluo processes</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn">Run Fluo in YARN</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-docker">Run Fluo in Docker</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/manage-applications">Manage Applications</a></div>
+
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/metrics">Metrics</a></div>
</div>
@@ -193,8 +187,6 @@
-
-
</div>
</div>
@@ -204,7 +196,7 @@
<p>Fluo 1.2.0 documentation >> Administration >> Metrics</p>
- <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
+ <div class="alert alert-warning" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Apache Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
<div class="row">
diff --git a/docs/fluo/1.2/administration/run-fluo-in-docker.html b/docs/fluo/1.2/administration/run-fluo-in-docker.html
new file mode 100644
index 0000000..a02a321
--- /dev/null
+++ b/docs/fluo/1.2/administration/run-fluo-in-docker.html
@@ -0,0 +1,363 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+
+ <link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cosmo/bootstrap.min.css" rel="stylesheet" integrity="sha384-h21C2fcDk/eFsW9sC9h0dhokq5pDinLNklTKoxIZRUn3+hvmgQSffLLQ4G4l2eEr" crossorigin="anonymous">
+ <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
+ <link rel="stylesheet" href="/css/fluo.css">
+ <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/administration/run-fluo-in-docker">
+ <link rel="icon" type="image/png" href="/resources/favicon.png">
+
+ <title>Run Fluo in Docker | Apache Fluo</title>
+
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+ <!-- Place your <script> tags here. -->
+
+<!-- Google Analytics -->
+<script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-55360307-1', 'auto');
+ ga('send', 'pageview');
+
+</script>
+
+<script>window.twttr = (function(d, s, id) {
+ var js, fjs = d.getElementsByTagName(s)[0],
+ t = window.twttr || {};
+ if (d.getElementById(id)) return t;
+ js = d.createElement(s);
+ js.id = id;
+ js.src = "https://platform.twitter.com/widgets.js";
+ fjs.parentNode.insertBefore(js, fjs);
+
+ t._e = [];
+ t.ready = function(f) {
+ t._e.push(f);
+ };
+
+ return t;
+}(document, "script", "twitter-wjs"));</script>
+
+ </head>
+ <body style="padding-top: 100px">
+ <nav id="fluo-nav" class="navbar navbar-default navbar-fixed-top">
+ <div class="container">
+ <div class="navbar-header">
+ <div class="navbar-toggle-wrapper visible-xs">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".js-navbar-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ </div>
+ <a href="/" class="navbar-brand"><img id="fluo-img" height="40px" src="/resources/fluo-logo-dark.png" alt="Apache Fluo"></a>
+ </div>
+ <div class="collapse navbar-collapse js-navbar-collapse" style="margin-top: 20px">
+ <ul class="navbar-nav nav">
+ <li><a href="/release/">Releases</a></li>
+ <li><a href="/tour/">Tour</a></li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Docs<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/docs/fluo/1.1.0-incubating/">Fluo</a></li>
+ <li><a href="/docs/fluo-recipes/1.1.0-incubating/">Fluo Recipes</a></li>
+ </ul>
+ </li>
+ <li><a href="/api/">API</a></li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Community<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/contactus/">Contact Us</a></li>
+ <li><a href="/news/">News Archive</a></li>
+ <li><a href="/people/">People</a></li>
+ <li><a href="/related-projects/">Related Projects</a></li>
+ <li><a href="/poweredby/">Powered By</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Contributing<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="/how-to-contribute/">How To Contribute</a></li>
+ <li><a href="/release-process/">Release Process</a></li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="navbar-nav nav navbar-right">
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation<span class="caret"></span></a>
+ <ul class="dropdown-menu">
+ <li><a href="https://www.apache.org">Apache Homepage</a></li>
+ <li><a href="https://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship">Sponsorship</i></a></li>
+ <li><a href="https://www.apache.org/security">Security</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks">Thanks</a></li>
+ <li><a href="https://www.apache.org/foundation/policies/conduct">Code of Conduct</a></li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </nav>
+ <div class="container">
+ <div class="row">
+ <div class="col-sm-12">
+ <div class="row">
+ <div class="col-md-2">
+ <div class="panel-group" id="accordion" role="tablist" aria-multiselectable="true" data-spy="affix">
+ <div class="panel panel-default">
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="false" aria-controls="collapsegetting-started">
+ Getting started
+ </a>
+ </h4>
+ </div>
+ <div id="collapsegetting-started" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/design">Design</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/quick-start">Quick Start</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install-fluo">Install Fluo</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/create-application">Create Application</a></div>
+
+ </div>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="panel-heading" role="tab" id="headingOne">
+ <h4 class="panel-title">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseadministration" aria-expanded="true" aria-controls="collapseadministration">
+ Administration
+ </a>
+ </h4>
+ </div>
+ <div id="collapseadministration" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
+ <div class="panel-body">
+
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/initialize">Initialize Application</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-processes">Run Fluo processes</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn">Run Fluo in YARN</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-docker">Run Fluo in Docker</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/manage-applications">Manage Applications</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/metrics">Metrics</a></div>
+
+ </div>
+ </div>
+
+
+
+
+
+
+
+ </div>
+ </div>
+ </div>
+ <div class="col-md-10">
+
+ <p>Fluo 1.2.0 documentation >> Administration >> Run Fluo in Docker</p>
+
+
+ <div class="alert alert-warning" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Apache Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
+
+
+ <div class="row">
+ <div class="col-md-10"><h1>Run Fluo in Docker</h1></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/run-fluo-in-docker.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ </div>
+
+ <h2 id="obtain-the-docker-image">Obtain the Docker image</h2>
+
+<p>To obtain the docker image created by this project, you can either pull it from DockerHub at
+<code class="highlighter-rouge">apache/fluo</code> or build it yourself. To pull the image from DockerHub, run the command below:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>docker pull apache/fluo
+</code></pre>
+</div>
+
+<p>While it is easier to pull from DockerHub, the image will default to the software versions below:</p>
+
+<table>
+ <thead>
+ <tr>
+ <th>Software</th>
+ <th>Version</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><a href="https://fluo.apache.org/">Fluo</a></td>
+ <td>1.2.0</td>
+ </tr>
+ <tr>
+ <td><a href="https://accumulo.apache.org/">Accumulo</a></td>
+ <td>1.8.1</td>
+ </tr>
+ <tr>
+ <td><a href="https://hadoop.apache.org/">Hadoop</a></td>
+ <td>2.7.3</td>
+ </tr>
+ <tr>
+ <td><a href="https://zookeeper.apache.org/">Zookeeper</a></td>
+ <td>3.4.9</td>
+ </tr>
+ </tbody>
+</table>
+
+<p>If these versions do not match what is running on your cluster, you should consider <a href="https://github.com/apache/fluo-docker/blob/master/README.md#build-the-docker-image">building
+your own image</a> with matching versions.</p>
+
+<h2 id="image-basics">Image basics</h2>
+
+<p>The entrypoint for the Fluo docker image is the <code class="highlighter-rouge">fluo</code> script. While the primary use
+case for this image is to start an oracle or worker, you can run other commands in the
+<code class="highlighter-rouge">fluo</code> script to test out the image:</p>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="c"># No arguments prints Fluo command usage</span>
+docker run apache/fluo
+<span class="c"># Print Fluo version</span>
+docker run apache/fluo version
+<span class="c"># Print Fluo classpath</span>
+docker run apache/fluo classpath
+</code></pre>
+</div>
+
+<h2 id="run-application-in-docker">Run application in Docker</h2>
+
+<p>Before starting a Fluo oracle and worker using the Fluo Docker image, [initialize your Fluo application][initialize].
+Next, choose a method below to run the oracle and worker(s) of your Fluo application. In the examples below, the Fluo
+application is named <code class="highlighter-rouge">myapp</code> and was initialized using a Zookeeper node on <code class="highlighter-rouge">zkhost</code>.</p>
+
+<h3 id="docker-engine">Docker engine</h3>
+
+<p>Use the <code class="highlighter-rouge">docker</code> command to start local docker containers.</p>
+
+<ol>
+ <li>
+ <p>Start a Fluo oracle for <code class="highlighter-rouge">myapp</code> application connecting to a Zookeeper at <code class="highlighter-rouge">zkhost</code>.</p>
+
+ <div class="highlighter-rouge"><pre class="highlight"><code> docker run -d --network="host" apache/fluo oracle -a myapp -o fluo.connection.zookeepers=zkhost/fluo
+</code></pre>
+ </div>
+
+ <p>The command above uses <code class="highlighter-rouge">-d</code> to run the container in the background and <code class="highlighter-rouge">--network="host"</code> to run the container
+ on the host’s network stack.</p>
+ </li>
+ <li>
+ <p>Start Fluo worker(s). Execute this command multiple times to start multiple workers.</p>
+
+ <div class="highlighter-rouge"><pre class="highlight"><code> docker run -d --network="host" apache/fluo worker -a myapp -o fluo.connection.zookeepers=zkhost/fluo
+</code></pre>
+ </div>
+ </li>
+</ol>
+
+<h3 id="marathon">Marathon</h3>
+
+<p>Using the <a href="https://mesosphere.github.io/marathon/">Marathon</a> UI, you can create applications using JSON configuration.</p>
+
+<p>The JSON below can be used to start a Fluo oracle.</p>
+
+<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
+ </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"myapp-fluo-oracle"</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"cmd"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fluo oracle -a myapp -o fluo.connection.zookeepers=zkhost/fluo"</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"cpus"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"mem"</span><span class="p">:</span><span class="w"> </span><span class="mi">256</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"disk"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"instances"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"container"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
+ </span><span class="nt">"docker"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
+ </span><span class="nt">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">"apache/fluo"</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"network"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HOST"</span><span class="w">
+ </span><span class="p">},</span><span class="w">
+ </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DOCKER"</span><span class="w">
+ </span><span class="p">}</span><span class="w">
+</span><span class="p">}</span><span class="w">
+</span></code></pre>
+</div>
+
+<p>The JSON below can be used to start Fluo worker(s). Modify instances to start multiple workers.</p>
+
+<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
+ </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"myapp-fluo-worker"</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"cmd"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fluo worker -a myapp -o fluo.connection.zookeepers=zkhost/fluo"</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"cpus"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"mem"</span><span class="p">:</span><span class="w"> </span><span class="mi">512</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"disk"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"instances"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"container"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
+ </span><span class="nt">"docker"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
+ </span><span class="nt">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">"apache/fluo"</span><span class="p">,</span><span class="w">
+ </span><span class="nt">"network"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HOST"</span><span class="w">
+ </span><span class="p">},</span><span class="w">
+ </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DOCKER"</span><span class="w">
+ </span><span class="p">}</span><span class="w">
+</span><span class="p">}</span><span class="w">
+</span></code></pre>
+</div>
+
+<h2 id="next-steps">Next Steps</h2>
+
+<p>Learn how to <a href="/docs/fluo/1.2/administration/manage-applications/">manage Fluo applications</a>.</p>
+
+
+
+ <div class="row" style="margin-top: 20px;">
+ <div class="col-md-10"><strong>Find documentation for all Fluo releases in the <a href="/docs/">archive</strong></div>
+ <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/run-fluo-in-docker.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ </div>
+ </div>
+</div>
+
+ </div>
+ </div>
+ <hr>
+ <div class="row footer">
+ <div class="col-sm-12 text-center">
+ <div class="center-block">
+ <a href="https://apache.org"><img src="/resources/feather.png" alt="Apache"></a>
+ Copyright © 2017 The Apache Software Foundation. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>
+ </div>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
diff --git a/docs/fluo/1.2/getting-started/install.html b/docs/fluo/1.2/administration/run-fluo-in-yarn.html
similarity index 52%
copy from docs/fluo/1.2/getting-started/install.html
copy to docs/fluo/1.2/administration/run-fluo-in-yarn.html
index 7e7b737..334f01f 100644
--- a/docs/fluo/1.2/getting-started/install.html
+++ b/docs/fluo/1.2/administration/run-fluo-in-yarn.html
@@ -8,10 +8,10 @@
<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cosmo/bootstrap.min.css" rel="stylesheet" integrity="sha384-h21C2fcDk/eFsW9sC9h0dhokq5pDinLNklTKoxIZRUn3+hvmgQSffLLQ4G4l2eEr" crossorigin="anonymous">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
<link rel="stylesheet" href="/css/fluo.css">
- <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/getting-started/install">
+ <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/administration/run-fluo-in-yarn">
<link rel="icon" type="image/png" href="/resources/favicon.png">
- <title>Installation | Apache Fluo</title>
+ <title>Run Fluo in YARN | Apache Fluo</title>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
@@ -120,22 +120,24 @@
-
-
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="true" aria-controls="collapsegetting-started">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="false" aria-controls="collapsegetting-started">
Getting started
</a>
</h4>
</div>
- <div id="collapsegetting-started" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
+ <div id="collapsegetting-started" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
<div class="panel-body">
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/design">Design</a></div>
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install">Installation</a></div>
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/quick-start">Quick Start</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install-fluo">Install Fluo</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/create-application">Create Application</a></div>
</div>
</div>
@@ -148,24 +150,6 @@
- <div class="panel-heading" role="tab" id="headingOne">
- <h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsedevelopment" aria-expanded="false" aria-controls="collapsedevelopment">
- Development
- </a>
- </h4>
- </div>
- <div id="collapsedevelopment" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
- <div class="panel-body">
-
-
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/development/applications">Applications</a></div>
-
- </div>
- </div>
-
-
-
@@ -174,15 +158,25 @@
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseadministration" aria-expanded="false" aria-controls="collapseadministration">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseadministration" aria-expanded="true" aria-controls="collapseadministration">
Administration
</a>
</h4>
</div>
- <div id="collapseadministration" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div id="collapseadministration" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
<div class="panel-body">
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/initialize">Initialize Application</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-processes">Run Fluo processes</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn">Run Fluo in YARN</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-docker">Run Fluo in Docker</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/manage-applications">Manage Applications</a></div>
+
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/metrics">Metrics</a></div>
</div>
@@ -193,33 +187,28 @@
-
-
</div>
</div>
</div>
<div class="col-md-10">
- <p>Fluo 1.2.0 documentation >> Getting started >> Installation</p>
+ <p>Fluo 1.2.0 documentation >> Administration >> Run Fluo in YARN</p>
- <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
+ <div class="alert alert-warning" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Apache Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
<div class="row">
- <div class="col-md-10"><h1>Installation</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/install.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-10"><h1>Run Fluo in YARN</h1></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/run-fluo-in-yarn.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
- <p>Instructions for installing Apache Fluo and starting a Fluo application on a cluster where
-Accumulo, Hadoop & Zookeeper are running. If you need help setting up these dependencies, see the
-<a href="https://fluo.apache.org/related-projects/">related projects page</a> for external projects that may help.</p>
+ <p>An Apache Fluo application can be started in Hadoop YARN using the Fluo YARN launcher.</p>
<h2 id="requirements">Requirements</h2>
-<p>Before you install Fluo, the following software must be installed and running on your local machine
-or cluster:</p>
+<p>The Fluo YARN launcher requires <a href="https://fluo.apache.org/">Apache Fluo</a> and <a href="https://hadoop.apache.org/">Hadoop YARN</a> to be installed:</p>
<table>
<thead>
@@ -231,55 +220,53 @@ or cluster:</p>
</thead>
<tbody>
<tr>
- <td><a href="https://accumulo.apache.org/">Accumulo</a></td>
- <td>1.7.2</td>
- <td>1.6.1</td>
+ <td><a href="https://fluo.apache.org/">Fluo</a></td>
+ <td>1.2.0</td>
+ <td>1.2.0</td>
</tr>
<tr>
- <td><a href="http://hadoop.apache.org/">Hadoop</a></td>
+ <td><a href="https://hadoop.apache.org/">YARN</a></td>
<td>2.7.2</td>
<td>2.6.0</td>
</tr>
- <tr>
- <td><a href="http://zookeeper.apache.org/">Zookeeper</a></td>
- <td>3.4.8</td>
- <td> </td>
- </tr>
- <tr>
- <td><a href="http://openjdk.java.net/">Java</a></td>
- <td>JDK 8</td>
- <td>JDK 8</td>
- </tr>
</tbody>
</table>
-<h2 id="obtain-a-distribution">Obtain a distribution</h2>
+<p>See the <a href="/related-projects/">related projects page</a> for external projects that may help in setting up these dependencies.</p>
+
+<h2 id="set-up-your-fluo-application">Set up your Fluo application</h2>
+
+<p>Before you can launch a Fluo application in YARN, you should <a href="/docs/fluo/1.2/getting-started/install-fluo/">install Fluo</a> and <a href="/docs/fluo/1.2/administration/initialize/">initialize your
+application</a>. After your application has been initialized, follow the instructions below to install
+the Fluo YARN launcher and run your application in YARN. Avoid using the <code class="highlighter-rouge">fluo</code> command to start local oracle
+and worker processes if you are running in YARN.</p>
-<p>Before you can install Fluo, you will need to obtain a distribution tarball. It is recommended that
-you download the <a href="https://fluo.apache.org/download/">latest release</a>. You can also build a distribution from the master
-branch by following these steps which create a tarball in <code class="highlighter-rouge">modules/distribution/target</code>:</p>
+<h2 id="install-and-configure-fluo-yarn-launcher">Install and Configure Fluo YARN launcher</h2>
-<div class="highlighter-rouge"><pre class="highlight"><code>git clone https://github.com/apache/fluo.git
-cd fluo/
+<p>Before you can install the Fluo YARN launcher, you will need to obtain a distribution tarball. It is
+recommended that you download the <a href="/download/">latest release</a>. You can also build a distribution from the
+master branch by following these steps which create a tarball in <code class="highlighter-rouge">distribution/target</code>:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>git clone https://github.com/apache/fluo-yarn.git
+cd fluo-yarn/
mvn package
</code></pre>
</div>
-<h2 id="install-fluo">Install Fluo</h2>
-
-<p>After you obtain a Fluo distribution tarball, follow these steps to install Fluo.</p>
+<p>After you obtain a Fluo YARN distribution tarball, follow these steps to install Fluo.</p>
<ol>
<li>
- <p>Choose a directory with plenty of space and untar the distribution:</p>
+ <p>Choose a directory with plenty of space, untar the distribution, and run <code class="highlighter-rouge">fetch.sh</code> to retrieve dependencies:</p>
- <div class="highlighter-rouge"><pre class="highlight"><code>tar -xvzf fluo-1.2.0-bin.tar.gz
-cd fluo-1.2.0
+ <div class="highlighter-rouge"><pre class="highlight"><code> tar -xvzf fluo-yarn-1.0.0-bin.tar.gz
+ cd fluo-yarn-1.0.0
+ ./lib/fetch.sh
</code></pre>
</div>
- <p>The distribution contains a <code class="highlighter-rouge">fluo</code> script in <code class="highlighter-rouge">bin/</code> that administers Fluo and the
-following configuration files in <code class="highlighter-rouge">conf/</code>:</p>
+ <p>The distribution contains a <code class="highlighter-rouge">fluo-yarn</code> script in <code class="highlighter-rouge">bin/</code> that administers Fluo and the
+ following configuration files in <code class="highlighter-rouge">conf/</code>:</p>
<table>
<thead>
@@ -290,102 +277,77 @@ following configuration files in <code class="highlighter-rouge">conf/</code>:</
</thead>
<tbody>
<tr>
- <td><a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-env.sh">fluo-env.sh</a></td>
- <td>Configures classpath for <code class="highlighter-rouge">fluo</code> script. Required for all commands.</td>
- </tr>
- <tr>
- <td><a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-conn.properties">fluo-conn.properties</a></td>
- <td>Configures connection to Fluo. Required for all commands.</td>
+ <td><a href="https://github.com/apache/fluo-yarn/blob/master/distribution/conf/fluo-yarn-env.sh">fluo-yarn-env.sh</a></td>
+ <td>Configures classpath for <code class="highlighter-rouge">fluo-yarn</code> script. Required for all commands.</td>
</tr>
<tr>
- <td><a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-app.properties">fluo-app.properties</a></td>
- <td>Template for configuration file passed to <code class="highlighter-rouge">fluo init</code> when initializing Fluo application.</td>
+ <td><a href="https://github.com/apache/fluo-yarn/blob/master/distribution/conf/fluo-yarn.properties">fluo-yarn.properties</a></td>
+ <td>Configures how application runs in YARN. Required for <code class="highlighter-rouge">start</code> command.</td>
</tr>
<tr>
- <td><a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/log4j.properties">log4j.properties</a></td>
+ <td><a href="https://github.com/apache/fluo-yarn/blob/master/distribution/conf/log4j.properties">log4j.properties</a></td>
<td>Configures logging</td>
</tr>
- <tr>
- <td><a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo.properties.deprecated">fluo.properties.deprecated</a></td>
- <td>Deprecated Fluo configuration file. Replaced by fluo-conn.properties and fluo-app.properties</td>
- </tr>
</tbody>
</table>
</li>
<li>
- <p>Configure <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-env.sh">fluo-env.sh</a> to set up your classpath using jars from the versions of Hadoop, Accumulo, and
-Zookeeper that you are using. Choose one of the two ways below to make these jars available to Fluo:</p>
+ <p>Configure <a href="https://github.com/apache/fluo-yarn/blob/master/distribution/conf/fluo-yarn-env.sh">fluo-yarn-env.sh</a></p>
<ul>
- <li>Set <code class="highlighter-rouge">HADOOP_PREFIX</code>, <code class="highlighter-rouge">ACCUMULO_HOME</code>, and <code class="highlighter-rouge">ZOOKEEPER_HOME</code> in your environment or configure
-these variables in <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-env.sh">fluo-env.sh</a>. Fluo will look in these locations for jars.</li>
- <li>
- <p>Run <code class="highlighter-rouge">./lib/fetch.sh ahz</code> to download Hadoop, Accumulo, and Zookeeper jars to <code class="highlighter-rouge">lib/ahz</code> and
-configure <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-env.sh">fluo-env.sh</a> to look in this directory. By default, this command will download the
-default versions set in <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/lib/ahz/pom.xml">lib/ahz/pom.xml</a>. If you are not using the default versions, you can
-override them:</p>
-
- <div class="highlighter-rouge"><pre class="highlight"><code> ./lib/fetch.sh ahz -Daccumulo.version=1.7.2 -Dhadoop.version=2.7.2 -Dzookeeper.version=3.4.8
-</code></pre>
- </div>
- </li>
+ <li>Set <code class="highlighter-rouge">FLUO_HOME</code> if it is not in your environment</li>
+ <li>Modify <code class="highlighter-rouge">FLUO_CONN_PROPS</code> if you don’t want use the default.</li>
</ul>
</li>
<li>
- <p>Fluo needs more dependencies than what is available from Hadoop, Accumulo, and Zookeeper. These
-extra dependencies need to be downloaded to <code class="highlighter-rouge">lib/</code> using the command below:</p>
+ <p>Configure <a href="https://github.com/apache/fluo-yarn/blob/master/distribution/conf/fluo-yarn.properties">fluo-yarn.properties</a> to set how your application will be launched in YARN:</p>
- <div class="highlighter-rouge"><pre class="highlight"><code> ./lib/fetch.sh extra
-</code></pre>
- </div>
+ <ul>
+ <li>YARN resource manager hostname</li>
+ <li>Number of oracle and worker instances</li>
+ <li>Max memory usage per oracle/worker</li>
+ </ul>
+
+ <p>If you are managing multiple Fluo applications in YARN, you can copy this file and configure it for
+each application.</p>
</li>
</ol>
-<p>You are now ready to use the <code class="highlighter-rouge">fluo</code> script.</p>
-
-<h2 id="fluo-command-script">Fluo command script</h2>
-
-<p>The Fluo command script is located at <code class="highlighter-rouge">bin/fluo</code> of your Fluo installation. All Fluo commands are
-invoked by this script.</p>
+<h2 id="start-fluo-application-in-yarn">Start Fluo application in YARN</h2>
-<p>Modify and add the following to your <code class="highlighter-rouge">~/.bashrc</code> if you want to be able to execute the fluo script
-from any directory:</p>
+<p>Follow the instructions below to start your application in YARN. If you have not done so already, you should <a href="/docs/fluo/1.2/administration/initialize/">initialize
+your Fluo application</a> before following these instructions.</p>
-<div class="highlighter-rouge"><pre class="highlight"><code>export PATH=/path/to/fluo-1.2.0/bin:$PATH
-</code></pre>
-</div>
-
-<p>Source your <code class="highlighter-rouge">.bashrc</code> for the changes to take effect and test the script</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>source ~/.bashrc
-fluo
-</code></pre>
-</div>
-
-<p>Running the script without any arguments prints a description of all commands.</p>
+<ol>
+ <li>
+ <p>Configure <a href="https://github.com/apache/fluo-yarn/blob/master/distribution/conf/fluo-yarn-env.sh">fluo-yarn-env.sh</a> and <a href="https://github.com/apache/fluo-yarn/blob/master/distribution/conf/fluo-yarn.properties">fluo-yarn.properties</a> if you have not already.</p>
+ </li>
+ <li>
+ <p>Run the commands below to start your Fluo application in YARN.</p>
-<div class="highlighter-rouge"><pre class="highlight"><code>./bin/fluo
+ <div class="highlighter-rouge"><pre class="highlight"><code> fluo-yarn start myapp conf/fluo-yarn.properties
</code></pre>
-</div>
+ </div>
-<h2 id="tuning-accumulo">Tuning Accumulo</h2>
+ <p>The commands will retrieve your application configuration and observer jars (using your application name) before
+starting the application in YARN. The command will output a YARN application ID that can be used to find your
+application in the YARN resource manager and view its logs.</p>
+ </li>
+</ol>
-<p>Fluo will reread the same data frequently when it checks conditions on mutations. When Fluo
-initializes a table it enables data caching to make this more efficient. However you may need to
-increase the amount of memory available for caching in the tserver by increasing
-<code class="highlighter-rouge">tserver.cache.data.size</code>. Increasing this may require increasing the maximum tserver java heap size
-in <code class="highlighter-rouge">accumulo-env.sh</code>.</p>
+<h2 id="manage-fluo-application-in-yarn">Manage Fluo application in YARN</h2>
-<p>Fluo will run many client threads, will want to ensure the tablet server has enough threads. Should
-probably increase the <code class="highlighter-rouge">tserver.server.threads.minimum</code> Accumulo setting.</p>
+<p>Except for stopping your application in YARN, the <code class="highlighter-rouge">fluo</code> script can be used to <a href="/docs/fluo/1.2/administration/manage-applications/">manage your application</a> using the
+<code class="highlighter-rouge">scan</code> and <code class="highlighter-rouge">wait</code> commands.</p>
-<p>Using at least Accumulo 1.6.1 is recommended because multiple performance bugs were fixed.</p>
+<p>When you want you stop your Fluo application, use the the YARN resource manager or the
+<code class="highlighter-rouge">yarn application -kill <App ID></code> to stop the application in YARN.</p>
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases in the <a href="/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/install.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/run-fluo-in-yarn.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
</div>
</div>
diff --git a/docs/fluo/1.2/index.html b/docs/fluo/1.2/administration/run-fluo-processes.html
similarity index 65%
copy from docs/fluo/1.2/index.html
copy to docs/fluo/1.2/administration/run-fluo-processes.html
index c44185f..dca963c 100644
--- a/docs/fluo/1.2/index.html
+++ b/docs/fluo/1.2/administration/run-fluo-processes.html
@@ -8,10 +8,10 @@
<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cosmo/bootstrap.min.css" rel="stylesheet" integrity="sha384-h21C2fcDk/eFsW9sC9h0dhokq5pDinLNklTKoxIZRUn3+hvmgQSffLLQ4G4l2eEr" crossorigin="anonymous">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
<link rel="stylesheet" href="/css/fluo.css">
- <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/index">
+ <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/administration/run-fluo-processes">
<link rel="icon" type="image/png" href="/resources/favicon.png">
- <title>Apache Fluo documentation | Apache Fluo</title>
+ <title>Run Fluo processes | Apache Fluo</title>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
@@ -120,8 +120,6 @@
-
-
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
<a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="false" aria-controls="collapsegetting-started">
@@ -135,7 +133,11 @@
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/design">Design</a></div>
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install">Installation</a></div>
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/quick-start">Quick Start</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install-fluo">Install Fluo</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/create-application">Create Application</a></div>
</div>
</div>
@@ -148,24 +150,6 @@
- <div class="panel-heading" role="tab" id="headingOne">
- <h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsedevelopment" aria-expanded="false" aria-controls="collapsedevelopment">
- Development
- </a>
- </h4>
- </div>
- <div id="collapsedevelopment" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
- <div class="panel-body">
-
-
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/development/applications">Applications</a></div>
-
- </div>
- </div>
-
-
-
@@ -174,15 +158,25 @@
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseadministration" aria-expanded="false" aria-controls="collapseadministration">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseadministration" aria-expanded="true" aria-controls="collapseadministration">
Administration
</a>
</h4>
</div>
- <div id="collapseadministration" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div id="collapseadministration" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
<div class="panel-body">
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/initialize">Initialize Application</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-processes">Run Fluo processes</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn">Run Fluo in YARN</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-docker">Run Fluo in Docker</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/manage-applications">Manage Applications</a></div>
+
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/metrics">Metrics</a></div>
</div>
@@ -193,38 +187,71 @@
-
-
</div>
</div>
</div>
<div class="col-md-10">
+ <p>Fluo 1.2.0 documentation >> Administration >> Run Fluo processes</p>
+
- <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
+ <div class="alert alert-warning" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Apache Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
<div class="row">
- <div class="col-md-10"><h1>Apache Fluo documentation</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/index.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-10"><h1>Run Fluo processes</h1></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/run-fluo-processes.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
- <p><!DOCTYPE html></p>
-<html lang="en-US">
-<meta charset="utf-8" />
-<title>Redirecting…</title>
-<link rel="canonical" href="getting-started/design" />
-<meta http-equiv="refresh" content="0; url=getting-started/design" />
-<h1>Redirecting…</h1>
-<a href="getting-started/design">Click here if you are not redirected.</a>
-<script>location="getting-started/design"</script>
-</html>
+ <p>An Apache Fluo application consists of an oracle process and multiple worker processes. These processes
+can be manually started by users on a single node or distributed across a cluster.</p>
+
+<h2 id="requirements">Requirements</h2>
+
+<p>Each node where Fluo is run must have <a href="/docs/fluo/1.2/getting-started/install-fluo/">Fluo installed</a>.</p>
+
+<h2 id="start-fluo-processes">Start Fluo processes</h2>
+
+<p>Follow the instructions below to start Fluo processes.</p>
+
+<ol>
+ <li>
+ <p>Configure <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-env.sh">fluo-env.sh</a> and <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-conn.properties">fluo-conn.properties</a> if you have not already.</p>
+ </li>
+ <li>
+ <p>Run Fluo application processes using the <code class="highlighter-rouge">fluo oracle</code> and <code class="highlighter-rouge">fluo worker</code> commands. Fluo applications
+are typically run with one oracle process and multiple worker processes. The commands below will start
+a Fluo oracle and two workers on your local machine:</p>
+
+ <div class="highlighter-rouge"><pre class="highlight"><code> fluo oracle myapp &> oracle.log &
+ fluo worker myapp &> worker1.log &
+ fluo worker myapp &> worker2.log &
+</code></pre>
+ </div>
+
+ <p>The commands will retrieve your application configuration and observer jars (using your
+application name) before starting the oracle or worker process.</p>
+ </li>
+</ol>
+
+<p>If you want to distribute the processes of your Fluo application across a cluster, you will need install
+Fluo on every node where you want to run a Fluo process. It is recommended that you use a cluster management
+tool like Salt, Ansible, or Chef to install and run Fluo on a cluster.</p>
+
+<h2 id="stop-fluo-processes">Stop Fluo processes</h2>
+
+<p>To stop your Fluo application, run <code class="highlighter-rouge">jps -m | grep Fluo</code> to find process IDs and use <code class="highlighter-rouge">kill</code> to stop them.</p>
+
+<h2 id="next-steps">Next Steps</h2>
+
+<p>Learn how to <a href="/docs/fluo/1.2/administration/manage-applications/">manage Fluo applications</a>.</p>
+
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases in the <a href="/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/index.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/run-fluo-processes.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
</div>
</div>
diff --git a/docs/fluo/1.2/development/applications.html b/docs/fluo/1.2/getting-started/create-application.html
similarity index 55%
rename from docs/fluo/1.2/development/applications.html
rename to docs/fluo/1.2/getting-started/create-application.html
index 3dce529..5d19ad3 100644
--- a/docs/fluo/1.2/development/applications.html
+++ b/docs/fluo/1.2/getting-started/create-application.html
@@ -8,10 +8,10 @@
<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cosmo/bootstrap.min.css" rel="stylesheet" integrity="sha384-h21C2fcDk/eFsW9sC9h0dhokq5pDinLNklTKoxIZRUn3+hvmgQSffLLQ4G4l2eEr" crossorigin="anonymous">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
<link rel="stylesheet" href="/css/fluo.css">
- <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/development/applications">
+ <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/getting-started/create-application">
<link rel="icon" type="image/png" href="/resources/favicon.png">
- <title>Applications | Apache Fluo</title>
+ <title>Create Application | Apache Fluo</title>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
@@ -120,22 +120,24 @@
-
-
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="false" aria-controls="collapsegetting-started">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="true" aria-controls="collapsegetting-started">
Getting started
</a>
</h4>
</div>
- <div id="collapsegetting-started" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div id="collapsegetting-started" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
<div class="panel-body">
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/design">Design</a></div>
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install">Installation</a></div>
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/quick-start">Quick Start</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install-fluo">Install Fluo</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/create-application">Create Application</a></div>
</div>
</div>
@@ -148,24 +150,6 @@
- <div class="panel-heading" role="tab" id="headingOne">
- <h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsedevelopment" aria-expanded="true" aria-controls="collapsedevelopment">
- Development
- </a>
- </h4>
- </div>
- <div id="collapsedevelopment" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
- <div class="panel-body">
-
-
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/development/applications">Applications</a></div>
-
- </div>
- </div>
-
-
-
@@ -183,6 +167,16 @@
<div class="panel-body">
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/initialize">Initialize Application</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-processes">Run Fluo processes</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn">Run Fluo in YARN</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-docker">Run Fluo in Docker</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/manage-applications">Manage Applications</a></div>
+
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/metrics">Metrics</a></div>
</div>
@@ -193,34 +187,25 @@
-
-
</div>
</div>
</div>
<div class="col-md-10">
- <p>Fluo 1.2.0 documentation >> Development >> Applications</p>
+ <p>Fluo 1.2.0 documentation >> Getting started >> Create Application</p>
- <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
+ <div class="alert alert-warning" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Apache Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
<div class="row">
- <div class="col-md-10"><h1>Applications</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/development/applications.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-10"><h1>Create Application</h1></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/create-application.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
- <p>Once you have Fluo installed and running on your cluster, you can run Fluo applications consisting
-of <a href="/docs/fluo/1.2/getting-started/design/">clients and observers</a>. This documentations will shows how to :</p>
-
-<ul>
- <li>Create a Fluo client</li>
- <li>Create a Fluo observer</li>
- <li>Initialize a Fluo Application</li>
- <li>Start and stop a Fluo application (which consists of Oracle and Worker processes)</li>
-</ul>
+ <p>Once you have <a href="/docs/fluo/1.2/getting-started/install-fluo/">Fluo installed</a>, you can create and run Fluo applications consisting
+of <a href="/docs/fluo/1.2/getting-started/design/">clients and observers</a>. This documentation shows how to create a Fluo client and observer.</p>
<h2 id="fluo-maven-dependencies">Fluo Maven Dependencies</h2>
@@ -339,237 +324,15 @@ will obtain the observed columns from the ObserverProvider and persist the colum
These columns persisted in Zookeeper are used by transactions to know when to trigger observers.</li>
</ol>
-<h2 id="initializing-a-fluo-application">Initializing a Fluo Application</h2>
-
-<p>Before a Fluo Application can run, it must be initiaized. Below is an overview of what
-initialization does and some of the properties that may be set for initialization.</p>
-
-<ul>
- <li><strong>Initialize ZooKeeper</strong> : Each application has its own area in ZooKeeper used for configuration,
-Oracle state, and worker coordination. All properties, except <code class="highlighter-rouge">fluo.connections.*</code>, are copied
-into ZooKeeper. For example, if <code class="highlighter-rouge">fluo.worker.num.threads=128</code> was set, then when a worker process
-starts it will read this from ZooKeeper.</li>
- <li><strong>Copy Observer jars to DFS</strong> : Fluo workers processes need the jars containing observers. These
-are provided in one of the following ways.
- <ul>
- <li>Set the property <code class="highlighter-rouge">fluo.observer.init.dir</code> to a local directory containing observer jars. The
-jars in this directory are copied to DFS under <code class="highlighter-rouge"><fluo.dfs.root>/<app name></code>. When a worker is
-started, the jars are pulled from DFS and added to its classpath.</li>
- <li>Set the property <code class="highlighter-rouge">fluo.observer.jars.url</code> to a directory in DFS containing observer jars. No
-copying is done. When a worker is started, the jars are pulled from this location and added to
-its classpath.</li>
- <li>Do not set any of the properties above and have the mechanism that starts the worker process
-add the needed jars to the classpath.</li>
- </ul>
- </li>
- <li><strong>Create Accumulo table</strong> : Each Fluo application creates and configures an Accumulo table. The
-<code class="highlighter-rouge">fluo.accumulo.*</code> properties determine which Accumulo instance is used. For performance reasons,
-Fluo runs its own code in Accumulo tablet servers. Fluo attempts to copy Fluo jars into DFS and
-configure Accumulo to use them. Fluo first checks the property <code class="highlighter-rouge">fluo.accumulo.jars</code> and if set,
-copies the jars listed there. If that property is not set, then Fluo looks on the classpath to
-find jars. Jars are copied to a location under <code class="highlighter-rouge"><fluo.dfs.root>/<app name></code>.</li>
-</ul>
-
-<p>Below are the steps to initialize an application from the command line. It is also possible to
-initialize an application using Fluo’s Java API.</p>
-
-<ol>
- <li>
- <p>Create a copy of <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-app.properties">fluo-app.properties</a> for your Fluo application.</p>
-
- <div class="highlighter-rouge"><pre class="highlight"><code> cp $FLUO_HOME/conf/fluo-app.properties /path/to/myapp/fluo-app.properties
-</code></pre>
- </div>
- </li>
- <li>
- <p>Edit your copy of <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-app.properties">fluo-app.properties</a> and make sure to set the following:</p>
-
- <ul>
- <li>Class name of your ObserverProvider</li>
- <li>Paths to your Fluo observer jars</li>
- <li>Accumulo configuration</li>
- <li>DFS configuration</li>
- </ul>
-
- <p>When configuring the observer section of fluo-app.properties, you can configure your instance for the
-<a href="https://github.com/astralway/phrasecount">phrasecount</a> application if you have not created your own application. See the <a href="https://github.com/astralway/phrasecount">phrasecount</a>
-example for instructions. You can also choose not to configure any observers but your workers will
-be idle when started.</p>
- </li>
- <li>
- <p>Run the command below to initialize your Fluo application. Change <code class="highlighter-rouge">myapp</code> to your application name:</p>
-
- <div class="highlighter-rouge"><pre class="highlight"><code> fluo init myapp /path/to/myapp/fluo-app.properties
-</code></pre>
- </div>
-
- <p>A Fluo application only needs to be initialized once. After initialization, the Fluo application
-name is used to start/stop the application and scan the Fluo table.</p>
- </li>
- <li>
- <p>Run <code class="highlighter-rouge">fluo list</code> which connects to Fluo and lists applications to verify initialization.</p>
- </li>
- <li>
- <p>Run <code class="highlighter-rouge">fluo config myapp</code> to see what configuration is stored in ZooKeeper.</p>
- </li>
-</ol>
-
-<h2 id="starting-your-fluo-application">Starting your Fluo application</h2>
-
-<p>Follow the instructions below to start a Fluo application which contains an oracle and multiple workers.</p>
-
-<ol>
- <li>
- <p>Configure <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-env.sh">fluo-env.sh</a> and <a href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-conn.properties">fluo-conn.properties</a> if you have not already.</p>
- </li>
- <li>
- <p>Run Fluo application processes using the <code class="highlighter-rouge">fluo oracle</code> and <code class="highlighter-rouge">fluo worker</code> commands. Fluo applications
-are typically run with one oracle process and multiple worker processes. The commands below will start
-a Fluo oracle and two workers on your local machine:</p>
-
- <div class="highlighter-rouge"><pre class="highlight"><code> fluo oracle myapp &> oracle.log &
- fluo worker myapp &> worker1.log &
- fluo worker myapp &> worker2.log &
-</code></pre>
- </div>
-
- <p>The commands will retrieve your application configuration and observer jars (using your
-application name) before starting the oracle or worker process.</p>
- </li>
-</ol>
-
-<p>If you want to distribute the processes of your Fluo application across a cluster, you will need install
-Fluo on every node where you want to run a Fluo process and follow the instructions above on each node.</p>
-
-<h2 id="managing-your-fluo-application">Managing your Fluo application</h2>
-
-<p>When you have data in your Fluo application, you can view it using the command <code class="highlighter-rouge">fluo scan myapp</code>.
-Pipe the output to <code class="highlighter-rouge">less</code> using the command <code class="highlighter-rouge">fluo scan myapp | less</code> if you want to page through the data.</p>
-
-<p>To list all Fluo applications, run <code class="highlighter-rouge">fluo list</code>.</p>
-
-<p>To stop your Fluo application, run <code class="highlighter-rouge">jps -m | grep Fluo</code> to find process IDs and use <code class="highlighter-rouge">kill</code> to stop them.</p>
-
-<h2 id="running-application-code">Running application code</h2>
-
-<p>The <code class="highlighter-rouge">fluo exec <app name> <class> {arguments}</code> provides an easy way to execute application code. It
-will execute a class with a main method if a jar containing the class is included with the observer
-jars configured at initialization. When the class is run, Fluo classes and dependencies will be on
-the classpath. The <code class="highlighter-rouge">fluo exec</code> command can inject the applications configuration if the class is
-written in the following way. Defining the injection point is optional.</p>
-
-<div class="language-java highlighter-rouge"><pre class="highlight"><code><span class="kn">import</span> <span class="nn">javax.inject.Inject</span><span class="o">;</span>
-
-<span class="kd">public</span> <span class="kd">class</span> <span class="nc">AppCommand</span> <span class="o">{</span>
-
- <span class="c1">//when run with fluo exec command, the applications configuration will be injected</span>
- <span class="nd">@Inject</span>
- <span class="kd">private</span> <span class="kd">static</span> <span class="n">FluoConfiguration</span> <span class="n">fluoConfig</span><span class="o">;</span>
-
- <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>
- <span class="k">try</span><span class="o">(</span><span class="n">FluoClient</span> <span class="n">fluoClient</span> <span class="o">=</span> <span class="n">FluoFactory</span><span class="o">.</span><span class="na">newClient</span><span class="o">(</span><span class="n">fluoConfig</span><span class="o">))</span> <span class="o">{</span>
- <span class="c1">//do stuff with Fluo</span>
- <span class="o">}</span>
- <span class="o">}</span>
-<span class="o">}</span>
-</code></pre>
-</div>
-
-<h2 id="application-configuration">Application Configuration</h2>
-
-<p>For configuring observers, fluo provides a simple mechanism to set and access application specific
-configuration. See the javadoc on <a href="https://static.javadoc.io/org.apache.fluo/fluo-api/1.1.0-incubating/org/apache/fluo/api/client/FluoClient.html">FluoClient</a>.getAppConfiguration() for more details.</p>
-
-<h2 id="debugging-applications">Debugging Applications</h2>
-
-<p>While monitoring <a href="/docs/fluo/1.2/administration/metrics/">Fluo metrics</a> can detect problems (like too many transaction collisions)
-in a Fluo application, <a href="/docs/fluo/1.2/administration/metrics/">metrics</a> may not provide enough information to debug the root cause
-of the problem. To help debug Fluo applications, low-level logging of transactions can be turned on
-by setting the following loggers to TRACE:</p>
-
-<table>
- <thead>
- <tr>
- <th>Logger</th>
- <th>Level</th>
- <th>Information</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>fluo.tx</td>
- <td>TRACE</td>
- <td>Provides detailed information about what transactions read and wrote</td>
- </tr>
- <tr>
- <td>fluo.tx.summary</td>
- <td>TRACE</td>
- <td>Provides a one line summary about each transaction executed</td>
- </tr>
- <tr>
- <td>fluo.tx.collisions</td>
- <td>TRACE</td>
- <td>Provides details about what data was involved When a transaction collides with another transaction</td>
- </tr>
- <tr>
- <td>fluo.tx.scan</td>
- <td>TRACE</td>
- <td>Provides logging for each cell read by a scan. Scan summary logged at <code class="highlighter-rouge">fluo.tx</code> level. This allows suppression of <code class="highlighter-rouge">fluo.tx.scan</code> while still seeing summary.</td>
- </tr>
- </tbody>
-</table>
-
-<p>Below is an example log after setting <code class="highlighter-rouge">fluo.tx</code> to TRACE. The number following <code class="highlighter-rouge">txid: </code> is the
-transactions start timestamp from the Oracle.</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>2015-02-11 18:24:05,341 [fluo.tx ] TRACE: txid: 3 begin() thread: 198
-2015-02-11 18:24:05,343 [fluo.tx ] TRACE: txid: 3 class: com.SimpleLoader
-2015-02-11 18:24:05,357 [fluo.tx ] TRACE: txid: 3 get(4333, stat count ) -> null
-2015-02-11 18:24:05,357 [fluo.tx ] TRACE: txid: 3 set(4333, stat count , 1)
-2015-02-11 18:24:05,441 [fluo.tx ] TRACE: txid: 3 commit() -> SUCCESSFUL commitTs: 4
-2015-02-11 18:24:05,341 [fluo.tx ] TRACE: txid: 5 begin() thread: 198
-2015-02-11 18:24:05,442 [fluo.tx ] TRACE: txid: 3 close()
-2015-02-11 18:24:05,343 [fluo.tx ] TRACE: txid: 5 class: com.SimpleLoader
-2015-02-11 18:24:05,357 [fluo.tx ] TRACE: txid: 5 get(4333, stat count ) -> 1
-2015-02-11 18:24:05,357 [fluo.tx ] TRACE: txid: 5 set(4333, stat count , 2)
-2015-02-11 18:24:05,441 [fluo.tx ] TRACE: txid: 5 commit() -> SUCCESSFUL commitTs: 6
-2015-02-11 18:24:05,442 [fluo.tx ] TRACE: txid: 5 close()
-</code></pre>
-</div>
-
-<p>The log above traces the following sequence of events.</p>
-
-<ul>
- <li>Transaction T1 has a start timestamp of <code class="highlighter-rouge">3</code></li>
- <li>Thread with id <code class="highlighter-rouge">198</code> is executing T1, its running code from the class <code class="highlighter-rouge">com.SimpleLoader</code></li>
- <li>T1 reads row <code class="highlighter-rouge">4333</code> and column <code class="highlighter-rouge">stat count</code> which does not exist</li>
- <li>T1 sets row <code class="highlighter-rouge">4333</code> and column <code class="highlighter-rouge">stat count</code> to <code class="highlighter-rouge">1</code></li>
- <li>T1 commits successfully and its commit timestamp from the Oracle is <code class="highlighter-rouge">4</code>.</li>
- <li>Transaction T2 has a start timestamp of <code class="highlighter-rouge">5</code> (because its <code class="highlighter-rouge">5</code> > <code class="highlighter-rouge">4</code> it can see what T1 wrote).</li>
- <li>T2 reads a value of <code class="highlighter-rouge">1</code> for row <code class="highlighter-rouge">4333</code> and column <code class="highlighter-rouge">stat count</code></li>
- <li>T2 sets row <code class="highlighter-rouge">4333</code> and column <code class="highlighter-rouge">stat count</code> to <code class="highlighter-rouge">2</code></li>
- <li>T2 commits successfully with a commit timestamp of <code class="highlighter-rouge">6</code></li>
-</ul>
-
-<p>Below is an example log after only setting <code class="highlighter-rouge">fluo.tx.collisions</code> to TRACE. This setting will only log
-trace information when a collision occurs. Unlike the previous example, what the transaction read
-and wrote is not logged. This shows that a transaction with a start timestamp of <code class="highlighter-rouge">106</code> and a class
-name of <code class="highlighter-rouge">com.SimpleLoader</code> collided with another transaction on row <code class="highlighter-rouge">r1</code> and column <code class="highlighter-rouge">fam1 qual1</code>.</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>2015-02-11 18:17:02,639 [tx.collisions] TRACE: txid: 106 class: com.SimpleLoader
-2015-02-11 18:17:02,639 [tx.collisions] TRACE: txid: 106 collisions: {r1=[fam1 qual1 ]}
-</code></pre>
-</div>
+<h2 id="next-steps">Next Steps</h2>
-<p>When applications read and write arbitrary binary data, this does not log so well. In order to make
-the trace logs human readable, non ASCII chars are escaped using hex. The convention used it <code class="highlighter-rouge">\xDD</code>
-where D is a hex digit. Also the <code class="highlighter-rouge">\</code> character is escaped to make the output unambiguous.</p>
+<p><a href="/docs/fluo/1.2/administration/initialize/">Initialize</a> your Fluo application before running it.</p>
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases in the <a href="/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/development/applications.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/create-application.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
</div>
</div>
diff --git a/docs/fluo/1.2/getting-started/design.html b/docs/fluo/1.2/getting-started/design.html
index 9581528..8f6ae2e 100644
--- a/docs/fluo/1.2/getting-started/design.html
+++ b/docs/fluo/1.2/getting-started/design.html
@@ -120,8 +120,6 @@
-
-
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
<a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="true" aria-controls="collapsegetting-started">
@@ -135,7 +133,11 @@
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/design">Design</a></div>
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install">Installation</a></div>
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/quick-start">Quick Start</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install-fluo">Install Fluo</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/create-application">Create Application</a></div>
</div>
</div>
@@ -148,24 +150,6 @@
- <div class="panel-heading" role="tab" id="headingOne">
- <h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsedevelopment" aria-expanded="false" aria-controls="collapsedevelopment">
- Development
- </a>
- </h4>
- </div>
- <div id="collapsedevelopment" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
- <div class="panel-body">
-
-
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/development/applications">Applications</a></div>
-
- </div>
- </div>
-
-
-
@@ -183,6 +167,16 @@
<div class="panel-body">
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/initialize">Initialize Application</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-processes">Run Fluo processes</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn">Run Fluo in YARN</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-docker">Run Fluo in Docker</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/manage-applications">Manage Applications</a></div>
+
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/metrics">Metrics</a></div>
</div>
@@ -193,8 +187,6 @@
-
-
</div>
</div>
@@ -204,7 +196,7 @@
<p>Fluo 1.2.0 documentation >> Getting started >> Design</p>
- <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
+ <div class="alert alert-warning" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Apache Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
<div class="row">
diff --git a/docs/fluo/1.2/getting-started/install.html b/docs/fluo/1.2/getting-started/install-fluo.html
similarity index 89%
rename from docs/fluo/1.2/getting-started/install.html
rename to docs/fluo/1.2/getting-started/install-fluo.html
index 7e7b737..4e853f4 100644
--- a/docs/fluo/1.2/getting-started/install.html
+++ b/docs/fluo/1.2/getting-started/install-fluo.html
@@ -8,10 +8,10 @@
<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cosmo/bootstrap.min.css" rel="stylesheet" integrity="sha384-h21C2fcDk/eFsW9sC9h0dhokq5pDinLNklTKoxIZRUn3+hvmgQSffLLQ4G4l2eEr" crossorigin="anonymous">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
<link rel="stylesheet" href="/css/fluo.css">
- <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/getting-started/install">
+ <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/getting-started/install-fluo">
<link rel="icon" type="image/png" href="/resources/favicon.png">
- <title>Installation | Apache Fluo</title>
+ <title>Install Fluo | Apache Fluo</title>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
@@ -120,8 +120,6 @@
-
-
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
<a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="true" aria-controls="collapsegetting-started">
@@ -135,7 +133,11 @@
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/design">Design</a></div>
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install">Installation</a></div>
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/quick-start">Quick Start</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install-fluo">Install Fluo</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/create-application">Create Application</a></div>
</div>
</div>
@@ -148,24 +150,6 @@
- <div class="panel-heading" role="tab" id="headingOne">
- <h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsedevelopment" aria-expanded="false" aria-controls="collapsedevelopment">
- Development
- </a>
- </h4>
- </div>
- <div id="collapsedevelopment" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
- <div class="panel-body">
-
-
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/development/applications">Applications</a></div>
-
- </div>
- </div>
-
-
-
@@ -183,6 +167,16 @@
<div class="panel-body">
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/initialize">Initialize Application</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-processes">Run Fluo processes</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn">Run Fluo in YARN</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-docker">Run Fluo in Docker</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/manage-applications">Manage Applications</a></div>
+
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/metrics">Metrics</a></div>
</div>
@@ -193,28 +187,26 @@
-
-
</div>
</div>
</div>
<div class="col-md-10">
- <p>Fluo 1.2.0 documentation >> Getting started >> Installation</p>
+ <p>Fluo 1.2.0 documentation >> Getting started >> Install Fluo</p>
- <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
+ <div class="alert alert-warning" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Apache Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
<div class="row">
- <div class="col-md-10"><h1>Installation</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/install.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-10"><h1>Install Fluo</h1></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/install-fluo.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
<p>Instructions for installing Apache Fluo and starting a Fluo application on a cluster where
Accumulo, Hadoop & Zookeeper are running. If you need help setting up these dependencies, see the
-<a href="https://fluo.apache.org/related-projects/">related projects page</a> for external projects that may help.</p>
+<a href="/related-projects/">related projects page</a> for external projects that may help.</p>
<h2 id="requirements">Requirements</h2>
@@ -256,7 +248,7 @@ or cluster:</p>
<h2 id="obtain-a-distribution">Obtain a distribution</h2>
<p>Before you can install Fluo, you will need to obtain a distribution tarball. It is recommended that
-you download the <a href="https://fluo.apache.org/download/">latest release</a>. You can also build a distribution from the master
+you download the <a href="/download/">latest release</a>. You can also build a distribution from the master
branch by following these steps which create a tarball in <code class="highlighter-rouge">modules/distribution/target</code>:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>git clone https://github.com/apache/fluo.git
@@ -385,7 +377,7 @@ probably increase the <code class="highlighter-rouge">tserver.server.threads.min
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases in the <a href="/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/install.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/install-fluo.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
</div>
</div>
diff --git a/docs/fluo/1.2/index.html b/docs/fluo/1.2/getting-started/quick-start.html
similarity index 74%
copy from docs/fluo/1.2/index.html
copy to docs/fluo/1.2/getting-started/quick-start.html
index c44185f..84a79fb 100644
--- a/docs/fluo/1.2/index.html
+++ b/docs/fluo/1.2/getting-started/quick-start.html
@@ -8,10 +8,10 @@
<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cosmo/bootstrap.min.css" rel="stylesheet" integrity="sha384-h21C2fcDk/eFsW9sC9h0dhokq5pDinLNklTKoxIZRUn3+hvmgQSffLLQ4G4l2eEr" crossorigin="anonymous">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
<link rel="stylesheet" href="/css/fluo.css">
- <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/index">
+ <link rel="canonical" href="https://fluo.apache.org//docs/fluo/1.2/getting-started/quick-start">
<link rel="icon" type="image/png" href="/resources/favicon.png">
- <title>Apache Fluo documentation | Apache Fluo</title>
+ <title>Quick Start | Apache Fluo</title>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
@@ -120,22 +120,24 @@
-
-
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="false" aria-controls="collapsegetting-started">
+ <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="true" aria-controls="collapsegetting-started">
Getting started
</a>
</h4>
</div>
- <div id="collapsegetting-started" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
+ <div id="collapsegetting-started" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
<div class="panel-body">
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/design">Design</a></div>
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install">Installation</a></div>
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/quick-start">Quick Start</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install-fluo">Install Fluo</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/create-application">Create Application</a></div>
</div>
</div>
@@ -148,24 +150,6 @@
- <div class="panel-heading" role="tab" id="headingOne">
- <h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsedevelopment" aria-expanded="false" aria-controls="collapsedevelopment">
- Development
- </a>
- </h4>
- </div>
- <div id="collapsedevelopment" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
- <div class="panel-body">
-
-
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/development/applications">Applications</a></div>
-
- </div>
- </div>
-
-
-
@@ -183,6 +167,16 @@
<div class="panel-body">
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/initialize">Initialize Application</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-processes">Run Fluo processes</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn">Run Fluo in YARN</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-docker">Run Fluo in Docker</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/manage-applications">Manage Applications</a></div>
+
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/metrics">Metrics</a></div>
</div>
@@ -193,38 +187,51 @@
-
-
</div>
</div>
</div>
<div class="col-md-10">
+ <p>Fluo 1.2.0 documentation >> Getting started >> Quick Start</p>
+
- <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
+ <div class="alert alert-warning" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Apache Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
<div class="row">
- <div class="col-md-10"><h1>Apache Fluo documentation</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/index.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-10"><h1>Quick Start</h1></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/quick-start.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
- <p><!DOCTYPE html></p>
-<html lang="en-US">
-<meta charset="utf-8" />
-<title>Redirecting…</title>
-<link rel="canonical" href="getting-started/design" />
-<meta http-equiv="refresh" content="0; url=getting-started/design" />
-<h1>Redirecting…</h1>
-<a href="getting-started/design">Click here if you are not redirected.</a>
-<script>location="getting-started/design"</script>
-</html>
+ <p>Follow the steps below to run a Fluo application:</p>
+
+<ol>
+ <li>
+ <p><a href="/docs/fluo/1.2/getting-started/install-fluo/">Install Fluo</a></p>
+ </li>
+ <li>
+ <p><a href="/docs/fluo/1.2/getting-started/create-application/">Create a Fluo application</a> or use <a href="/related-projects/">an example application</a>.</p>
+ </li>
+ <li>
+ <p><a href="/docs/fluo/1.2/administration/initialize/">Initialize your Fluo application</a></p>
+ </li>
+ <li>
+ <p>Pick a method below to run your Fluo application</p>
+
+ <ul>
+ <li><a href="/docs/fluo/1.2/administration/run-fluo-processes/">Run Fluo processes</a></li>
+ <li><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn/">Run Fluo in YARN</a></li>
+ <li><a href="/docs/fluo/1.2/administration/run-fluo-in-docker/">Run Fluo in Docker</a> which enables running in Mesos and Kubernetes</li>
+ </ul>
+ </li>
+</ol>
+
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases in the <a href="/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/index.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/quick-start.md" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
</div>
</div>
diff --git a/docs/fluo/1.2/index.html b/docs/fluo/1.2/index.html
index c44185f..c710919 100644
--- a/docs/fluo/1.2/index.html
+++ b/docs/fluo/1.2/index.html
@@ -120,8 +120,6 @@
-
-
<div class="panel-heading" role="tab" id="headingOne">
<h4 class="panel-title">
<a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsegetting-started" aria-expanded="false" aria-controls="collapsegetting-started">
@@ -135,7 +133,11 @@
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/design">Design</a></div>
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install">Installation</a></div>
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/quick-start">Quick Start</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/install-fluo">Install Fluo</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/getting-started/create-application">Create Application</a></div>
</div>
</div>
@@ -148,24 +150,6 @@
- <div class="panel-heading" role="tab" id="headingOne">
- <h4 class="panel-title">
- <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapsedevelopment" aria-expanded="false" aria-controls="collapsedevelopment">
- Development
- </a>
- </h4>
- </div>
- <div id="collapsedevelopment" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingOne">
- <div class="panel-body">
-
-
- <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/development/applications">Applications</a></div>
-
- </div>
- </div>
-
-
-
@@ -183,6 +167,16 @@
<div class="panel-body">
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/initialize">Initialize Application</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-processes">Run Fluo processes</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-yarn">Run Fluo in YARN</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/run-fluo-in-docker">Run Fluo in Docker</a></div>
+
+ <div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/manage-applications">Manage Applications</a></div>
+
<div class="row doc-sidebar-link"><a href="/docs/fluo/1.2/administration/metrics">Metrics</a></div>
</div>
@@ -193,8 +187,6 @@
-
-
</div>
</div>
@@ -202,7 +194,7 @@
<div class="col-md-10">
- <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
+ <div class="alert alert-warning" style="margin-bottom: 0px;" role="alert">This documentation is for a future release of Apache Fluo! <a href="/docs/fluo/1.1.0-incubating/">View documentation for the latest release</a>.</div>
<div class="row">
diff --git a/feed.xml b/feed.xml
index 9e710b8..87756ce 100644
--- a/feed.xml
+++ b/feed.xml
@@ -5,8 +5,8 @@
<description></description>
<link>https://fluo.apache.org//</link>
<atom:link href="https://fluo.apache.org//feed.xml" rel="self" type="application/rss+xml" />
- <pubDate>Fri, 06 Oct 2017 13:58:36 +0000</pubDate>
- <lastBuildDate>Fri, 06 Oct 2017 13:58:36 +0000</lastBuildDate>
+ <pubDate>Fri, 06 Oct 2017 15:38:27 +0000</pubDate>
+ <lastBuildDate>Fri, 06 Oct 2017 15:38:27 +0000</lastBuildDate>
<generator>Jekyll v3.3.1</generator>
--
To stop receiving notification emails like this one, please contact
['"commits@fluo.apache.org" <co...@fluo.apache.org>'].