You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@aurora.apache.org by dl...@apache.org on 2014/03/25 07:10:07 UTC
svn commit: r1581246 [2/6] - in /incubator/aurora/site: ./ publish/
publish/community/ publish/developers/ publish/docs/gettingstarted/
publish/docs/howtocontribute/ publish/documentation/
publish/documentation/latest/ publish/documentation/latest/clie...
Added: incubator/aurora/site/publish/documentation/latest/configurationtutorial/index.html
URL: http://svn.apache.org/viewvc/incubator/aurora/site/publish/documentation/latest/configurationtutorial/index.html?rev=1581246&view=auto
==============================================================================
--- incubator/aurora/site/publish/documentation/latest/configurationtutorial/index.html (added)
+++ incubator/aurora/site/publish/documentation/latest/configurationtutorial/index.html Tue Mar 25 06:10:05 2014
@@ -0,0 +1,1214 @@
+<html>
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Aurora</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="description" content="">
+ <meta name="author" content="">
+
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/bootstrap-responsive.min.css" rel="stylesheet">
+ <link href="/assets/css/main.css" rel="stylesheet">
+
+ <!-- JS -->
+ <script type="text/javascript" src="/assets/js/jquery-1.10.1.min.js"></script>
+ <script type="text/javascript" src="/assets/js/bootstrap-dropdown.js"></script>
+
+ <!-- Analytics -->
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-45879646-1']);
+ _gaq.push(['_setDomainName', 'apache.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+ </head>
+ <body>
+ <div class="navbar navbar-static-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a href="/" class="logo"><img src="/assets/img/aurora_logo.png" alt="Apache Aurora logo" /></a>
+ <ul class="nav">
+ <li><a href="/docs/gettingstarted/">Getting Started</a></li>
+ <li><a href="/documentation/latest/">Documentation</a></li>
+ <li><a href="/downloads/">Download</a></li>
+ <li><a href="/community">Community</a></li>
+ </ul>
+ </div>
+ </div>
+</div>
+
+<div class="container">
+<!-- magical breadcrumbs -->
+<ul class="breadcrumb">
+ <li>
+ <div class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation <b class="caret"></b></a>
+ <ul class="dropdown-menu" role="menu">
+ <li><a href="http://www.apache.org">Apache Homepage</a></li>
+ <li><a href="http://www.apache.org/licenses/">Apache License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ </ul>
+ </div>
+ </li>
+ <li><span class="divider">•</span></li>
+ <li><a href="http://incubator.apache.org">Apache Incubator</a></li>
+ <li><span class="divider">•</span></li>
+ <li><a href="http://aurora.incubator.apache.org">Apache Aurora</a></li>
+</ul>
+<!-- /breadcrumb -->
+
+ <div class="container">
+ <h1 id="aurora-configuration-tutorial">Aurora Configuration Tutorial</h1>
+
+<p>How to write Aurora configuration files, including feature descriptions
+and best practices. When writing a configuration file, make use of
+<code>aurora inspect</code>. It takes the same job key and configuration file
+arguments as <code>aurora create</code> or <code>aurora update</code>. It first ensures the
+configuration parses, then outputs it in human-readable form.</p>
+
+<p>You should read this after going through the general <a href="/documentation/latest/tutorial/">Aurora Tutorial</a>.</p>
+
+<p><a href="#Basics">The Basics</a>
+ <a href="#Bottom">Use Bottom-To-Top Object Ordering</a>
+<a href="#Example">An Example Configuration File</a>
+<a href="#Process">Defining Process Objects</a>
+<a href="#Sandbox">Getting Your Code Into The Sandbox</a>
+<a href="#Task">Defining Task Objects</a>
+ <a href="#Sequential"><code>SequentialTask</code></a>
+ <a href="#Simple"><code>SimpleTask</code></a>
+ <a href="#Concat"><code>Tasks.concat</code> and <code>Tasks.combine</code></a>
+<a href="#Job">Defining <code>Job</code> Objects</a>
+<a href="#jobs">Defining The <code>jobs</code> List</a>
+<a href="#Templating">Templating</a>
+<a href="#Binding">Templating 1: Binding in Pystachio</a>
+<a href="#Structurals">Structurals in Pystachio / Aurora</a>
+ <a href="#Mustaches">Mustaches Within Structurals</a>
+<a href="#Factories">Templating 2: Structurals Are Factories</a>
+ <a href="#Second">A Second Way of Templating</a>
+<a href="#AdvancedBinding">Advanced Binding</a>
+<a href="#BindSyntax">Bind Syntax</a>
+ <a href="#ComplexObjects">Binding Complex Objects</a>
+<a href="#StructuralBinding">Structural Binding</a>
+<a href="#Tips">Configuration File Writing Tips And Best Practices</a>
+ <a href="#Few">Use As Few <code>.aurora</code> Files As Possible</a>
+ <a href="#Boilerplate">Avoid Boilerplate</a>
+ <a href="#Bash">Thermos Uses bash, But Thermos Is Not bash</a>
+ <a href="#Functions">Rarely Use Functions In Your Configurations</a></p>
+
+<h2 id="the-basics">The Basics</h2>
+
+<p>To run a job on Aurora, you must specify a configuration file that tells
+Aurora what it needs to know to schedule the job, what Mesos needs to
+run the tasks the job is made up of, and what Thermos needs to run the
+processes that make up the tasks. This file must have
+a<code>.aurora</code> suffix.</p>
+
+<p>A configuration file defines a collection of objects, along with parameter
+values for their attributes. An Aurora configuration file contains the
+following three types of objects:</p>
+
+<ul>
+<li>Job</li>
+<li>Task</li>
+<li>Process</li>
+</ul>
+
+<p>A configuration also specifies a list of <code>Job</code> objects assigned
+to the variable <code>jobs</code>.</p>
+
+<ul>
+<li>jobs (list of defined Jobs to run)</li>
+</ul>
+
+<p>The <code>.aurora</code> file format is just Python. However, <code>Job</code>, <code>Task</code>,
+<code>Process</code>, and other classes are defined by a type-checked dictionary
+templating library called <em>Pystachio</em>, a powerful tool for
+configuration specification and reuse. Pystachio objects are tailored
+via {{}} surrounded templates.</p>
+
+<p>When writing your <code>.aurora</code> file, you may use any Pystachio datatypes, as
+well as any objects shown in the <a href="/documentation/latest/configurationreference/"><em>Aurora+Thermos Configuration
+Reference</em></a>, without <code>import</code> statements - the
+Aurora config loader injects them automatically. Other than that, an <code>.aurora</code>
+file works like any other Python script.</p>
+
+<p><a href="/documentation/latest/configurationreference/"><em>Aurora+Thermos Configuration Reference</em></a>
+has a full reference of all Aurora/Thermos defined Pystachio objects.</p>
+
+<h3 id="use-bottom-to-top-object-ordering">Use Bottom-To-Top Object Ordering</h3>
+
+<p>A well-structured configuration starts with structural templates (if
+any). Structural templates encapsulate in their attributes all the
+differences between Jobs in the configuration that are not directly
+manipulated at the <code>Job</code> level, but typically at the <code>Process</code> or <code>Task</code>
+level. For example, if certain processes are invoked with slightly
+different settings or input.</p>
+
+<p>After structural templates, define, in order, <code>Process</code>es, <code>Task</code>s, and
+<code>Job</code>s.</p>
+
+<p>Structural template names should be <em>UpperCamelCased</em> and their
+instantiations are typically <em>UPPER_SNAKE_CASED</em>. <code>Process</code>, <code>Task</code>,
+and <code>Job</code> names are typically <em>lower_snake_cased</em>. Indentation is typically 2
+spaces.</p>
+
+<h2 id="an-example-configuration-file">An Example Configuration File</h2>
+
+<p>The following is a typical configuration file. Don’t worry if there are
+parts you don’t understand yet, but you may want to refer back to this
+as you read about its individual parts. Note that names surrounded by
+curly braces {{}} are template variables, which the system replaces with
+bound values for the variables.</p>
+<pre class="highlight text"># --- templates here ---
+class Profile(Struct):
+ package_version = Default(String, 'live')
+ java_binary = Default(String, '/usr/lib/jvm/java-1.7.0-openjdk/bin/java')
+ extra_jvm_options = Default(String, '')
+ parent_environment = Default(String, 'prod')
+ parent_serverset = Default(String,
+ '/foocorp/service/bird/{{parent_environment}}/bird')
+
+# --- processes here ---
+main = Process(
+ name = 'application',
+ cmdline = '{{profile.java_binary}} -server -Xmx1792m '
+ '{{profile.extra_jvm_options}} '
+ '-jar application.jar '
+ '-upstreamService {{profile.parent_serverset}}'
+)
+
+# --- tasks ---
+base_task = SequentialTask(
+ name = 'application',
+ processes = [
+ Process(
+ name = 'fetch',
+ cmdline = 'curl -O
+ https://packages.foocorp.com/{{profile.package_version}}/application.jar'),
+ ]
+)
+
+ # not always necessary but often useful to have separate task
+ # resource classes
+ staging_task = base_task(resources =
+ Resources(cpu = 1.0,
+ ram = 2048*MB,
+ disk = 1*GB))
+production_task = base_task(resources =
+ Resources(cpu = 4.0,
+ ram = 2560*MB,
+ disk = 10*GB))
+
+# --- job template ---
+job_template = Job(
+ name = 'application',
+ role = 'myteam',
+ contact = 'myteam-team@foocorp.com',
+ instances = 20,
+ service = True,
+ task = production_task
+)
+
+# -- profile instantiations (if any) ---
+PRODUCTION = Profile()
+STAGING = Profile(
+ extra_jvm_options = '-Xloggc:gc.log',
+ parent_environment = 'staging'
+)
+
+# -- job instantiations --
+jobs = [
+ job_template(cluster = 'cluster1', environment = 'prod')
+ .bind(profile = PRODUCTION),
+
+ job_template(cluster = 'cluster2', environment = 'prod')
+ .bind(profile = PRODUCTION),
+
+ job_template(cluster = 'cluster1',
+ environment = 'staging',
+ service = False,
+ task = staging_task,
+ instances = 2)
+ .bind(profile = STAGING),
+]
+</pre>
+<h2 id="defining-process-objects">Defining Process Objects</h2>
+
+<p>Processes are handled by the Thermos system. A process is a single
+executable step run as a part of an Aurora task, which consists of a
+bash-executable statement.</p>
+
+<p>The key (and required) <code>Process</code> attributes are:</p>
+
+<ul>
+<li> <code>name</code>: Any string which is a valid Unix filename (no slashes,
+NULLs, or leading periods). The <code>name</code> value must be unique relative
+to other Processes in a <code>Task</code>.</li>
+<li> <code>cmdline</code>: A command line run in a bash subshell, so you can use
+bash scripts. Nothing is supplied for command-line arguments,
+so <code>$*</code> is unspecified.</li>
+</ul>
+
+<p>Many tiny processes make managing configurations more difficult. For
+example, the following is a bad way to define processes.</p>
+<pre class="highlight text">copy = Process(
+ name = 'copy',
+ cmdline = 'curl -O https://packages.foocorp.com/app.zip'
+)
+unpack = Process(
+ name = 'unpack',
+ cmdline = 'unzip app.zip'
+)
+remove = Process(
+ name = 'remove',
+ cmdline = 'rm -f app.zip'
+)
+run = Process(
+ name = 'app',
+ cmdline = 'java -jar app.jar'
+)
+run_task = Task(
+ processes = [copy, unpack, remove, run],
+ constraints = order(copy, unpack, remove, run)
+)
+</pre>
+<p>Since <code>cmdline</code> runs in a bash subshell, you can chain commands
+with <code>&&</code> or <code>||</code>.</p>
+
+<p>When defining a <code>Task</code> that is just a list of Processes run in a
+particular order, use <code>SequentialTask</code>, as described in the <a href="#Task"><em>Defining</em>
+<code>Task</code> <em>Objects</em></a> section. The following simplifies and combines the
+above multiple <code>Process</code> definitions into just two.</p>
+<pre class="highlight text">stage = Process(
+ name = 'stage',
+ cmdline = 'curl -O https://packages.foocorp.com/app.zip && '
+ 'unzip app.zip && rm -f app.zip')
+
+run = Process(name = 'app', cmdline = 'java -jar app.jar')
+
+run_task = SequentialTask(processes = [stage, run])
+</pre>
+<p><code>Process</code> also has five optional attributes, each with a default value
+if one isn’t specified in the configuration:</p>
+
+<ul>
+<li><p><code>max_failures</code>: Defaulting to <code>1</code>, the maximum number of failures
+(non-zero exit statuses) before this <code>Process</code> is marked permanently
+failed and not retried. If a <code>Process</code> permanently fails, Thermos
+checks the <code>Process</code> object’s containing <code>Task</code> for the task’s
+failure limit (usually 1) to determine whether or not the <code>Task</code>
+should be failed. Setting <code>max_failures</code>to <code>0</code> means that this
+process will keep retrying until a successful (zero) exit status is
+achieved. Retries happen at most once every <code>min_duration</code> seconds
+to prevent effectively mounting a denial of service attack against
+the coordinating scheduler.</p></li>
+<li><p><code>daemon</code>: Defaulting to <code>False</code>, if <code>daemon</code> is set to <code>True</code>, a
+successful (zero) exit status does not prevent future process runs.
+Instead, the <code>Process</code> reinvokes after <code>min_duration</code> seconds.
+However, the maximum failure limit (<code>max_failures</code>) still
+applies. A combination of <code>daemon=True</code> and <code>max_failures=0</code> retries
+a <code>Process</code> indefinitely regardless of exit status. This should
+generally be avoided for very short-lived processes because of the
+accumulation of checkpointed state for each process run. When
+running in Aurora, <code>max_failures</code> is capped at
+100.</p></li>
+<li><p><code>ephemeral</code>: Defaulting to <code>False</code>, if <code>ephemeral</code> is <code>True</code>, the
+<code>Process</code>‘ status is not used to determine if its bound <code>Task</code> has
+completed. For example, consider a <code>Task</code> with a
+non-ephemeral webserver process and an ephemeral logsaver process
+that periodically checkpoints its log files to a centralized data
+store. The <code>Task</code> is considered finished once the webserver process
+finishes, regardless of the logsaver’s current status.</p></li>
+<li><p><code>min_duration</code>: Defaults to <code>15</code>. Processes may succeed or fail
+multiple times during a single Task. Each result is called a
+<em>process run</em> and this value is the minimum number of seconds the
+scheduler waits before re-running the same process.</p></li>
+<li><p><code>final</code>: Defaulting to <code>False</code>, this is a finalizing <code>Process</code> that
+should run last. Processes can be grouped into two classes:
+<em>ordinary</em> and <em>finalizing</em>. By default, Thermos Processes are
+ordinary. They run as long as the <code>Task</code> is considered
+healthy (i.e. hasn’t reached a failure limit). But once all regular
+Thermos Processes have either finished or the <code>Task</code> has reached a
+certain failure threshold, Thermos moves into a <em>finalization</em> stage
+and runs all finalizing Processes. These are typically necessary for
+cleaning up after the <code>Task</code>, such as log checkpointers, or perhaps
+e-mail notifications of a completed Task. Finalizing processes may
+not depend upon ordinary processes or vice-versa, however finalizing
+processes may depend upon other finalizing processes and will
+otherwise run as a typical process schedule.</p></li>
+</ul>
+
+<h2 id="getting-your-code-into-the-sandbox">Getting Your Code Into The Sandbox</h2>
+
+<p>When using Aurora, you need to get your executable code into its “sandbox”, specifically
+the Task sandbox where the code executes for the Processes that make up that Task.</p>
+
+<p>Each Task has a sandbox created when the Task starts and garbage
+collected when it finishes. All of a Task’s processes run in its
+sandbox, so processes can share state by using a shared current
+working directory.</p>
+
+<p>Typically, you save this code somewhere. You then need to define a Process
+in your <code>.aurora</code> configuration file that fetches the code from that somewhere
+to where the slave can see it. For a public cloud, that can be anywhere public on
+the Internet, such as S3. For a private cloud internal storage, you need to put in
+on an accessible HDFS cluster or similar storage.</p>
+
+<p>The template for this Process is:</p>
+<pre class="highlight text"><name> = Process(
+ name = '<name>'
+ cmdline = '<command to copy and extract code archive into current working directory>'
+)
+</pre>
+<p>Note: Be sure the extracted code archive has an executable.</p>
+
+<h2 id="defining-task-objects">Defining Task Objects</h2>
+
+<p>Tasks are handled by Mesos. A task is a collection of processes that
+runs in a shared sandbox. It’s the fundamental unit Aurora uses to
+schedule the datacenter; essentially what Aurora does is find places
+in the cluster to run tasks.</p>
+
+<p>The key (and required) parts of a Task are:</p>
+
+<ul>
+<li><p><code>name</code>: A string giving the Task’s name. By default, if a Task is
+not given a name, it inherits the first name in its Process list.</p></li>
+<li><p><code>processes</code>: An unordered list of Process objects bound to the Task.
+The value of the optional <code>constraints</code> attribute affects the
+contents as a whole. Currently, the only constraint, <code>order</code>, determines if
+the processes run in parallel or sequentially.</p></li>
+<li><p><code>resources</code>: A <code>Resource</code> object defining the Task’s resource
+ footprint. A <code>Resource</code> object has three attributes:
+ - <code>cpu</code>: A Float, the fractional number of cores the Task
+ requires.
+ - <code>ram</code>: An Integer, RAM bytes the Task requires.
+ - <code>disk</code>: An integer, disk bytes the Task requires.</p></li>
+</ul>
+
+<p>A basic Task definition looks like:</p>
+<pre class="highlight text">Task(
+ name="hello_world",
+ processes=[Process(name = "hello_world", cmdline = "echo hello world")],
+ resources=Resources(cpu = 1.0,
+ ram = 1*GB,
+ disk = 1*GB))
+</pre>
+<p>There are four optional Task attributes:</p>
+
+<ul>
+<li><p><code>constraints</code>: A list of <code>Constraint</code> objects that constrain the
+Task’s processes. Currently there is only one type, the <code>order</code>
+constraint. For example the following requires that the processes
+run in the order <code>foo</code>, then <code>bar</code>.</p>
+<pre class="highlight text">constraints = [Constraint(order=['foo', 'bar'])]
+</pre>
+<p>There is an <code>order()</code> function that takes <code>order('foo', 'bar', 'baz')</code>
+and converts it into <code>[Constraint(order=['foo', 'bar', 'baz'])]</code>.
+<code>order()</code> accepts Process name strings <code>('foo', 'bar')</code> or the processes
+themselves, e.g. <code>foo=Process(name='foo', ...)</code>, <code>bar=Process(name='bar', ...)</code>,
+<code>constraints=order(foo, bar)</code></p>
+
+<p>Note that Thermos rejects tasks with process cycles.</p></li>
+<li><p><code>max_failures</code>: Defaulting to <code>1</code>, the number of failed processes
+needed for the <code>Task</code> to be marked as failed. Note how this
+interacts with individual Processes’ <code>max_failures</code> values. Assume a
+Task has two Processes and a <code>max_failures</code> value of <code>2</code>. So both
+Processes must fail for the Task to fail. Now, assume each of the
+Task’s Processes has its own <code>max_failures</code> value of <code>10</code>. If
+Process “A” fails 5 times before succeeding, and Process “B” fails
+10 times and is then marked as failing, their parent Task succeeds.
+Even though there were 15 individual failures by its Processes, only
+1 of its Processes was finally marked as failing. Since 1 is less
+than the 2 that is the Task’s <code>max_failures</code> value, the Task does
+not fail.</p></li>
+<li><p><code>max_concurrency</code>: Defaulting to <code>0</code>, the maximum number of
+concurrent processes in the Task. <code>0</code> specifies unlimited
+concurrency. For Tasks with many expensive but otherwise independent
+processes, you can limit the amount of concurrency Thermos schedules
+instead of artificially constraining them through <code>order</code>
+constraints. For example, a test framework may generate a Task with
+100 test run processes, but runs it in a Task with
+<code>resources.cpus=4</code>. Limit the amount of parallelism to 4 by setting
+<code>max_concurrency=4</code>.</p></li>
+<li><p><code>finalization_wait</code>: Defaulting to <code>30</code>, the number of seconds
+allocated for finalizing the Task’s processes. A Task starts in
+<code>ACTIVE</code> state when Processes run and stays there as long as the Task
+is healthy and Processes run. When all Processes finish successfully
+or the Task reaches its maximum process failure limit, it goes into
+<code>CLEANING</code> state. In <code>CLEANING</code>, it sends <code>SIGTERMS</code> to any still running
+Processes. When all Processes terminate, the Task goes into
+<code>FINALIZING</code> state and invokes the schedule of all processes whose
+final attribute has a True value. Everything from the end of <code>ACTIVE</code>
+to the end of <code>FINALIZING</code> must happen within <code>finalization_wait</code>
+number of seconds. If not, all still running Processes are sent
+<code>SIGKILL</code>s (or if dependent on yet to be completed Processes, are
+never invoked).</p></li>
+</ul>
+
+<h3 id="sequentialtask:-running-processes-in-parallel-or-sequentially">SequentialTask: Running Processes in Parallel or Sequentially</h3>
+
+<p>By default, a Task with several Processes runs them in parallel. There
+are two ways to run Processes sequentially:</p>
+
+<ul>
+<li><p>Include an <code>order</code> constraint in the Task definition’s <code>constraints</code>
+attribute whose arguments specify the processes' run order:</p>
+<pre class="highlight text">Task( ... processes=[process1, process2, process3],
+ constraints = order(process1, process2, process3), ...)
+</pre></li>
+<li><p>Use <code>SequentialTask</code> instead of <code>Task</code>; it automatically runs
+processes in the order specified in the <code>processes</code> attribute. No
+<code>constraint</code> parameter is needed:</p>
+<pre class="highlight text">SequentialTask( ... processes=[process1, process2, process3] ...)
+</pre></li>
+</ul>
+
+<h3 id="simpletask">SimpleTask</h3>
+
+<p>For quickly creating simple tasks, use the <code>SimpleTask</code> helper. It
+creates a basic task from a provided name and command line using a
+default set of resources. For example, in a .<code>aurora</code> configuration
+file:</p>
+<pre class="highlight text">SimpleTask(name="hello_world", command="echo hello world")
+</pre>
+<p>is equivalent to</p>
+<pre class="highlight text">Task(name="hello_world",
+ processes=[Process(name = "hello_world", cmdline = "echo hello world")],
+ resources=Resources(cpu = 1.0,
+ ram = 1*GB,
+ disk = 1*GB))
+</pre>
+<p>The simplest idiomatic Job configuration thus becomes:</p>
+<pre class="highlight text">import os
+hello_world_job = Job(
+ task=SimpleTask(name="hello_world", command="echo hello world"),
+ role=os.getenv('USER'),
+ cluster="cluster1")
+</pre>
+<p>When written to <code>hello_world.aurora</code>, you invoke it with a simple
+<code>aurora create cluster1/$USER/test/hello_world hello_world.aurora</code>.</p>
+
+<h3 id="combining-tasks">Combining tasks</h3>
+
+<p><code>Tasks.concat</code>(synonym,<code>concat_tasks</code>) and
+<code>Tasks.combine</code>(synonym,<code>combine_tasks</code>) merge multiple Task definitions
+into a single Task. It may be easier to define complex Jobs
+as smaller constituent Tasks. But since a Job only includes a single
+Task, the subtasks must be combined before using them in a Job.
+Smaller Tasks can also be reused between Jobs, instead of having to
+repeat their definition for multiple Jobs.</p>
+
+<p>With both methods, the merged Task takes the first Task’s name. The
+difference between the two is the result Task’s process ordering.</p>
+
+<ul>
+<li><p><code>Tasks.combine</code> runs its subtasks' processes in no particular order.
+The new Task’s resource consumption is the sum of all its subtasks'
+consumption.</p></li>
+<li><p><code>Tasks.concat</code> runs its subtasks in the order supplied, with each
+subtask’s processes run serially between tasks. It is analogous to
+the <code>order</code> constraint helper, except at the Task level instead of
+the Process level. The new Task’s resource consumption is the
+maximum value specified by any subtask for each Resource attribute
+(cpu, ram and disk).</p></li>
+</ul>
+
+<p>For example, given the following:</p>
+<pre class="highlight text">setup_task = Task(
+ ...
+ processes=[download_interpreter, update_zookeeper],
+ # It is important to note that {{Tasks.concat}} has
+ # no effect on the ordering of the processes within a task;
+ # hence the necessity of the {{order}} statement below
+ # (otherwise, the order in which {{download_interpreter}}
+ # and {{update_zookeeper}} run will be non-deterministic)
+ constraints=order(download_interpreter, update_zookeeper),
+ ...
+)
+
+run_task = SequentialTask(
+ ...
+ processes=[download_application, start_application],
+ ...
+)
+
+combined_task = Tasks.concat(setup_task, run_task)
+</pre>
+<p>The <code>Tasks.concat</code> command merges the two Tasks into a single Task and
+ensures all processes in <code>setup_task</code> run before the processes
+in <code>run_task</code>. Conceptually, the task is reduced to:</p>
+<pre class="highlight text">task = Task(
+ ...
+ processes=[download_interpreter, update_zookeeper,
+ download_application, start_application],
+ constraints=order(download_interpreter, update_zookeeper,
+ download_application, start_application),
+ ...
+)
+</pre>
+<p>In the case of <code>Tasks.combine</code>, the two schedules run in parallel:</p>
+<pre class="highlight text">task = Task(
+ ...
+ processes=[download_interpreter, update_zookeeper,
+ download_application, start_application],
+ constraints=order(download_interpreter, update_zookeeper) +
+ order(download_application, start_application),
+ ...
+)
+</pre>
+<p>In the latter case, each of the two sequences may operate in parallel.
+Of course, this may not be the intended behavior (for example, if
+the <code>start_application</code> Process implicitly relies
+upon <code>download_interpreter</code>). Make sure you understand the difference
+between using one or the other.</p>
+
+<h2 id="defining-job-objects">Defining Job Objects</h2>
+
+<p>A job is a group of identical tasks that Aurora can run in a Mesos cluster.</p>
+
+<p>A <code>Job</code> object is defined by the values of several attributes, some
+required and some optional. The required attributes are:</p>
+
+<ul>
+<li><p><code>task</code>: Task object to bind to this job. Note that a Job can
+only take a single Task.</p></li>
+<li><p><code>role</code>: Job’s role account; in other words, the user account to run
+the job as on a Mesos cluster machine. A common value is
+<code>os.getenv('USER')</code>; using a Python command to get the user who
+submits the job request. The other common value is the service
+account that runs the job, e.g. <code>www-data</code>.</p></li>
+<li><p><code>environment</code>: Job’s environment, typical values
+are <code>devel</code>, <code>test</code>, or <code>prod</code>.</p></li>
+<li><p><code>cluster</code>: Aurora cluster to schedule the job in, defined in
+<code>/etc/aurora/clusters.json</code> or <code>~/.clusters.json</code>. You can specify
+jobs where the only difference is the <code>cluster</code>, then at run time
+only run the Job whose job key includes your desired cluster’s name.</p></li>
+</ul>
+
+<p>You usually see a <code>name</code> parameter. By default, <code>name</code> inherits its
+value from the Job’s associated Task object, but you can override this
+default. For these four parameters, a Job definition might look like:</p>
+<pre class="highlight text">foo_job = Job( name = 'foo', cluster = 'cluster1',
+ role = os.getenv('USER'), environment = 'prod',
+ task = foo_task)
+</pre>
+<p>In addition to the required attributes, there are several optional
+attributes. The first (strongly recommended) optional attribute is:</p>
+
+<ul>
+<li> <code>contact</code>: An email address for the Job’s owner. For production
+jobs, it is usually a team mailing list.</li>
+</ul>
+
+<p>Two more attributes deal with how to handle failure of the Job’s Task:</p>
+
+<ul>
+<li><p><code>max_task_failures</code>: An integer, defaulting to <code>1</code>, of the maximum
+number of Task failures after which the Job is considered failed.
+<code>-1</code> allows for infinite failures.</p></li>
+<li><p><code>service</code>: A boolean, defaulting to <code>False</code>, which if <code>True</code>
+restarts tasks regardless of whether they succeeded or failed. In
+other words, if <code>True</code>, after the Job’s Task completes, it
+automatically starts again. This is for Jobs you want to run
+continuously, rather than doing a single run.</p></li>
+</ul>
+
+<p>Three attributes deal with configuring the Job’s Task:</p>
+
+<ul>
+<li><p><code>instances</code>: Defaulting to <code>1</code>, the number of
+instances/replicas/shards of the Job’s Task to create.</p></li>
+<li><p><code>priority</code>: Defaulting to <code>0</code>, the Job’s Task’s preemption priority,
+for which higher values may preempt Tasks from Jobs with lower
+values.</p></li>
+<li><p><code>production</code>: a Boolean, defaulting to <code>False</code>, specifying that this
+is a production job backed by quota. Tasks from production Jobs may
+preempt tasks from any non-production job, and may only be preempted
+by tasks from production jobs in the same role with higher
+priority. <strong>WARNING</strong>: To run Jobs at this level, the Job role must
+have the appropriate quota.</p></li>
+</ul>
+
+<p>The final three Job attributes each take an object as their value.</p>
+
+<ul>
+<li> <code>update_config</code>: An <code>UpdateConfig</code>
+object provides parameters for controlling the rate and policy of
+rolling updates. The <code>UpdateConfig</code> parameters are:
+
+<ul>
+<li> <code>batch_size</code>: An integer, defaulting to <code>1</code>, specifying the
+maximum number of shards to update in one iteration.</li>
+<li> <code>restart_threshold</code>: An integer, defaulting to <code>60</code>, specifying
+the maximum number of seconds before a shard must move into the
+<code>RUNNING</code> state before considered a failure.</li>
+<li> <code>watch_secs</code>: An integer, defaulting to <code>30</code>, specifying the
+minimum number of seconds a shard must remain in the <code>RUNNING</code>
+state before considered a success.</li>
+<li> <code>max_per_shard_failures</code>: An integer, defaulting to <code>0</code>,
+specifying the maximum number of restarts per shard during an
+update. When the limit is exceeded, it increments the total
+failure count.</li>
+<li> <code>max_total_failures</code>: An integer, defaulting to <code>0</code>, specifying
+the maximum number of shard failures tolerated during an update.
+Cannot be equal to or greater than the job’s total number of
+tasks.</li>
+</ul></li>
+<li> <code>health_check_config</code>: A <code>HealthCheckConfig</code> object that provides
+parameters for controlling a Task’s health checks via HTTP. Only
+used if a health port was assigned with a command line wildcard. The
+<code>HealthCheckConfig</code> parameters are:
+
+<ul>
+<li> <code>initial_interval_secs</code>: An integer, defaulting to <code>60</code>,
+specifying the initial delay for doing an HTTP health check.</li>
+<li> <code>interval_secs</code>: An integer, defaulting to <code>30</code>, specifying the
+number of seconds in the interval between checking the Task’s
+health.</li>
+<li> <code>timeout_secs</code>: An integer, defaulting to <code>1</code>, specifying the
+number of seconds the application must respond to an HTTP health
+check with <code>OK</code> before it is considered a failure.</li>
+<li> <code>max_consecutive_failures</code>: An integer, defaulting to <code>0</code>,
+specifying the maximum number of consecutive failures before a
+task is unhealthy.</li>
+</ul></li>
+<li> <code>constraints</code>: A <code>dict</code> Python object, specifying Task scheduling
+constraints. Most users will not need to specify constraints, as the
+scheduler automatically inserts reasonable defaults. Please do not
+set this field unless you are sure of what you are doing. See the
+section in the Aurora + Thermos Reference manual on <a href="/documentation/latest/configurationreference/">Specifying
+Scheduling Constraints</a> for more information.</li>
+</ul>
+
+<h2 id="the-jobs-list">The jobs List</h2>
+
+<p>At the end of your <code>.aurora</code> file, you need to specify a list of the
+file’s defined Jobs to run in the order listed. For example, the
+following runs first <code>job1</code>, then <code>job2</code>, then <code>job3</code>.</p>
+
+<p>jobs = [job1, job2, job3]</p>
+
+<h2 id="templating">Templating</h2>
+
+<p>The <code>.aurora</code> file format is just Python. However, <code>Job</code>, <code>Task</code>,
+<code>Process</code>, and other classes are defined by a templating library called
+<em>Pystachio</em>, a powerful tool for configuration specification and reuse.</p>
+
+<p><a href="/documentation/latest/configurationreference/">Aurora+Thermos Configuration Reference</a>
+has a full reference of all Aurora/Thermos defined Pystachio objects.</p>
+
+<p>When writing your <code>.aurora</code> file, you may use any Pystachio datatypes, as
+well as any objects shown in the <em>Aurora+Thermos Configuration
+Reference</em> without <code>import</code> statements - the Aurora config loader
+injects them automatically. Other than that the <code>.aurora</code> format
+works like any other Python script.</p>
+
+<h3 id="templating-1:-binding-in-pystachio">Templating 1: Binding in Pystachio</h3>
+
+<p>Pystachio uses the visually distinctive {{}} to indicate template
+variables. These are often called “mustache variables” after the
+similarly appearing variables in the Mustache templating system and
+because the curly braces resemble mustaches.</p>
+
+<p>If you are familiar with the Mustache system, templates in Pystachio
+have significant differences. They have no nesting, joining, or
+inheritance semantics. On the other hand, when evaluated, templates
+are evaluated iteratively, so this affords some level of indirection.</p>
+
+<p>Let’s start with the simplest template; text with one
+variable, in this case <code>name</code>;</p>
+<pre class="highlight text">Hello {{name}}
+</pre>
+<p>If we evaluate this as is, we’d get back:</p>
+<pre class="highlight text">Hello
+</pre>
+<p>If a template variable doesn’t have a value, when evaluated it’s
+replaced with nothing. If we add a binding to give it a value:</p>
+<pre class="highlight json"><span class="p">{</span><span class="w"> </span><span class="s2">"name"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"Tom"</span><span class="w"> </span><span class="p">}</span><span class="w">
+</span></pre>
+<p>We’d get back:</p>
+<pre class="highlight text">Hello Tom
+</pre>
+<p>We can also use {{}} variables as sectional variables. Let’s say we
+have:</p>
+<pre class="highlight text">{{#x}} Testing... {{/x}}
+</pre>
+<p>If <code>x</code> evaluates to <code>True</code>, the text between the sectional tags is
+shown. If there is no value for <code>x</code> or it evaluates to <code>False</code>, the
+between tags text is not shown. So, at a basic level, a sectional
+variable acts as a conditional.</p>
+
+<p>However, if the sectional variable evaluates to a list, array, etc. it
+acts as a <code>foreach</code>. For example,</p>
+<pre class="highlight text">{{#x}} {{name}} {{/x}}
+</pre>
+<p>with</p>
+<pre class="highlight json"><span class="p">{</span><span class="w"> </span><span class="s2">"x"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"name"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"tic"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"name"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"tac"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"name"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"toe"</span><span class="w"> </span><span class="p">}</span
><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="p">}</span><span class="w">
+</span></pre>
+<p>evaluates to</p>
+<pre class="highlight text">tic tac toe
+</pre>
+<p>Every Pystachio object has an associated <code>.bind</code> method that can bind
+values to {{}} variables. Bindings are not immediately evaluated.
+Instead, they are evaluated only when the interpolated value of the
+object is necessary, e.g. for performing equality or serializing a
+message over the wire.</p>
+
+<p>Objects with and without mustache templated variables behave
+differently:</p>
+<pre class="highlight text">>>> Float(1.5)
+Float(1.5)
+
+>>> Float('{{x}}.5')
+Float({{x}}.5)
+
+>>> Float('{{x}}.5').bind(x = 1)
+Float(1.5)
+
+>>> Float('{{x}}.5').bind(x = 1) == Float(1.5)
+True
+
+>>> contextual_object = String('{{metavar{{number}}}}').bind(
+... metavar1 = "first", metavar2 = "second")
+
+>>> contextual_object
+String({{metavar{{number}}}})
+
+>>> contextual_object.bind(number = 1)
+String(first)
+
+>>> contextual_object.bind(number = 2)
+String(second)
+</pre>
+<p>You usually bind simple key to value pairs, but you can also bind three
+other objects: lists, dictionaries, and structurals. These will be
+described in detail later.</p>
+
+<h3 id="structurals-in-pystachio-/-aurora">Structurals in Pystachio / Aurora</h3>
+
+<p>Most Aurora/Thermos users don’t ever (knowingly) interact with <code>String</code>,
+<code>Float</code>, or <code>Integer</code> Pystashio objects directly. Instead they interact
+with derived structural (<code>Struct</code>) objects that are collections of
+fundamental and structural objects. The structural object components are
+called <em>attributes</em>. Aurora’s most used structural objects are <code>Job</code>,
+<code>Task</code>, and <code>Process</code>:</p>
+<pre class="highlight text">class Process(Struct):
+ cmdline = Required(String)
+ name = Required(String)
+ max_failures = Default(Integer, 1)
+ daemon = Default(Boolean, False)
+ ephemeral = Default(Boolean, False)
+ min_duration = Default(Integer, 5)
+ final = Default(Boolean, False)
+</pre>
+<p>Construct default objects by following the object’s type with (). If you
+want an attribute to have a value different from its default, include
+the attribute name and value inside the parentheses.</p>
+<pre class="highlight text">>>> Process()
+Process(daemon=False, max_failures=1, ephemeral=False,
+ min_duration=5, final=False)
+</pre>
+<p>Attribute values can be template variables, which then receive specific
+values when creating the object.</p>
+<pre class="highlight text">>>> Process(cmdline = 'echo {{message}}')
+Process(daemon=False, max_failures=1, ephemeral=False, min_duration=5,
+ cmdline=echo {{message}}, final=False)
+
+>>> Process(cmdline = 'echo {{message}}').bind(message = 'hello world')
+Process(daemon=False, max_failures=1, ephemeral=False, min_duration=5,
+ cmdline=echo hello world, final=False)
+</pre>
+<p>A powerful binding property is that all of an object’s children inherit its
+bindings:</p>
+<pre class="highlight text">>>> List(Process)([
+... Process(name = '{{prefix}}_one'),
+... Process(name = '{{prefix}}_two')
+... ]).bind(prefix = 'hello')
+ProcessList(
+ Process(daemon=False, name=hello_one, max_failures=1, ephemeral=False, min_duration=5, final=False),
+ Process(daemon=False, name=hello_two, max_failures=1, ephemeral=False, min_duration=5, final=False)
+ )
+</pre>
+<p>Remember that an Aurora Job contains Tasks which contain Processes. A
+Job level binding is inherited by its Tasks and all their Processes.
+Similarly a Task level binding is available to that Task and its
+Processes but is <em>not</em> visible at the Job level (inheritance is a
+one-way street.)</p>
+
+<h4 id="mustaches-within-structurals">Mustaches Within Structurals</h4>
+
+<p>When you define a <code>Struct</code> schema, one powerful, but confusing, feature
+is that all of that structure’s attributes are Mustache variables within
+the enclosing scope <em>once they have been populated</em>.</p>
+
+<p>For example, when <code>Process</code> is defined above, all its attributes such as
+{{<code>name</code>}}, {{<code>cmdline</code>}}, {{<code>max_failures</code>}} etc., are all immediately
+defined as Mustache variables, implicitly bound into the <code>Process</code>, and
+inherit all child objects once they are defined.</p>
+
+<p>Thus, you can do the following:</p>
+<pre class="highlight text">>>> Process(name = "installer", cmdline = "echo {{name}} is running")
+Process(daemon=False, name=installer, max_failures=1, ephemeral=False, min_duration=5,
+ cmdline=echo installer is running, final=False)
+</pre>
+<p>WARNING: This binding only takes place in one direction. For example,
+the following does NOT work and does not set the <code>Process</code> <code>name</code>
+attribute’s value.</p>
+<pre class="highlight text">>>> Process().bind(name = "installer")
+Process(daemon=False, max_failures=1, ephemeral=False, min_duration=5, final=False)
+</pre>
+<p>The following is also not possible and results in an infinite loop that
+attempts to resolve <code>Process.name</code>.</p>
+<pre class="highlight text">>>> Process(name = '{{name}}').bind(name = 'installer')
+</pre>
+<p>Do not confuse Structural attributes with bound Mustache variables.
+Attributes are implicitly converted to Mustache variables but not vice
+versa.</p>
+
+<h3 id="templating-2:-structurals-are-factories">Templating 2: Structurals Are Factories</h3>
+
+<h4 id="a-second-way-of-templating">A Second Way of Templating</h4>
+
+<p>A second templating method is both as powerful as the aforementioned and
+often confused with it. This method is due to automatic conversion of
+Struct attributes to Mustache variables as described above.</p>
+
+<p>Suppose you create a Process object:</p>
+<pre class="highlight text">>>> p = Process(name = "process_one", cmdline = "echo hello world")
+
+>>> p
+Process(daemon=False, name=process_one, max_failures=1, ephemeral=False, min_duration=5,
+ cmdline=echo hello world, final=False)
+</pre>
+<p>This <code>Process</code> object, “<code>p</code>”, can be used wherever a <code>Process</code> object is
+needed. It can also be reused by changing the value(s) of its
+attribute(s). Here we change its <code>name</code> attribute from <code>process_one</code> to
+<code>process_two</code>.</p>
+<pre class="highlight text">>>> p(name = "process_two")
+Process(daemon=False, name=process_two, max_failures=1, ephemeral=False, min_duration=5,
+ cmdline=echo hello world, final=False)
+</pre>
+<p>Template creation is a common use for this technique:</p>
+<pre class="highlight text">>>> Daemon = Process(daemon = True)
+>>> logrotate = Daemon(name = 'logrotate', cmdline = './logrotate conf/logrotate.conf')
+>>> mysql = Daemon(name = 'mysql', cmdline = 'bin/mysqld --safe-mode')
+</pre>
+<h3 id="advanced-binding">Advanced Binding</h3>
+
+<p>As described above, <code>.bind()</code> binds simple strings or numbers to
+Mustache variables. In addition to Structural types formed by combining
+atomic types, Pystachio has two container types; <code>List</code> and <code>Map</code> which
+can also be bound via <code>.bind()</code>.</p>
+
+<h4 id="bind-syntax">Bind Syntax</h4>
+
+<p>The <code>bind()</code> function can take Python dictionaries or <code>kwargs</code>
+interchangeably (when “<code>kwargs</code>” is in a function definition, <code>kwargs</code>
+receives a Python dictionary containing all keyword arguments after the
+formal parameter list).</p>
+<pre class="highlight text">>>> String('{{foo}}').bind(foo = 'bar') == String('{{foo}}').bind({'foo': 'bar'})
+True
+</pre>
+<p>Bindings done “closer” to the object in question take precedence:</p>
+<pre class="highlight text">>>> p = Process(name = '{{context}}_process')
+>>> t = Task().bind(context = 'global')
+>>> t(processes = [p, p.bind(context = 'local')])
+Task(processes=ProcessList(
+ Process(daemon=False, name=global_process, max_failures=1, ephemeral=False, final=False,
+ min_duration=5),
+ Process(daemon=False, name=local_process, max_failures=1, ephemeral=False, final=False,
+ min_duration=5)
+))
+</pre>
+<h4 id="binding-complex-objects">Binding Complex Objects</h4>
+
+<h5 id="lists">Lists</h5>
+<pre class="highlight text">>>> fibonacci = List(Integer)([1, 1, 2, 3, 5, 8, 13])
+>>> String('{{fib[4]}}').bind(fib = fibonacci)
+String(5)
+</pre>
+<h5 id="maps">Maps</h5>
+<pre class="highlight text">>>> first_names = Map(String, String)({'Kent': 'Clark', 'Wayne': 'Bruce', 'Prince': 'Diana'})
+>>> String('{{first[Kent]}}').bind(first = first_names)
+String(Clark)
+</pre>
+<h5 id="structurals">Structurals</h5>
+<pre class="highlight text">>>> String('{{p.cmdline}}').bind(p = Process(cmdline = "echo hello world"))
+String(echo hello world)
+</pre>
+<h3 id="structural-binding">Structural Binding</h3>
+
+<p>Use structural templates when binding more than two or three individual
+values at the Job or Task level. For fewer than two or three, standard
+key to string binding is sufficient.</p>
+
+<p>Structural binding is a very powerful pattern and is most useful in
+Aurora/Thermos for doing Structural configuration. For example, you can
+define a job profile. The following profile uses <code>HDFS</code>, the Hadoop
+Distributed File System, to designate a file’s location. <code>HDFS</code> does
+not come with Aurora, so you’ll need to either install it separately
+or change the way the dataset is designated.</p>
+<pre class="highlight text">class Profile(Struct):
+ version = Required(String)
+ environment = Required(String)
+ dataset = Default(String, hdfs://home/aurora/data/{{environment}}')
+
+PRODUCTION = Profile(version = 'live', environment = 'prod')
+DEVEL = Profile(version = 'latest',
+ environment = 'devel',
+ dataset = 'hdfs://home/aurora/data/test')
+TEST = Profile(version = 'latest', environment = 'test')
+
+JOB_TEMPLATE = Job(
+ name = 'application',
+ role = 'myteam',
+ cluster = 'cluster1',
+ environment = '{{profile.environment}}',
+ task = SequentialTask(
+ name = 'task',
+ resources = Resources(cpu = 2, ram = 4*GB, disk = 8*GB),
+ processes = [
+ Process(name = 'main', cmdline = 'java -jar application.jar -hdfsPath
+ {{profile.dataset}}')
+ ]
+ )
+ )
+
+jobs = [
+ JOB_TEMPLATE(instances = 100).bind(profile = PRODUCTION),
+ JOB_TEMPLATE.bind(profile = DEVEL),
+ JOB_TEMPLATE.bind(profile = TEST),
+ ]
+</pre>
+<p>In this case, a custom structural “Profile” is created to self-document
+the configuration to some degree. This also allows some schema
+“type-checking”, and for default self-substitution, e.g. in
+<code>Profile.dataset</code> above.</p>
+
+<p>So rather than a <code>.bind()</code> with a half-dozen substituted variables, you
+can bind a single object that has sensible defaults stored in a single
+place.</p>
+
+<h2 id="configuration-file-writing-tips-and-best-practices">Configuration File Writing Tips And Best Practices</h2>
+
+<h3 id="use-as-few-.aurora-files-as-possible">Use As Few .aurora Files As Possible</h3>
+
+<p>When creating your <code>.aurora</code> configuration, try to keep all versions of
+a particular job within the same <code>.aurora</code> file. For example, if you
+have separate jobs for <code>cluster1</code>, <code>cluster1</code> staging, <code>cluster1</code>
+testing, and<code>cluster2</code>, keep them as close together as possible.</p>
+
+<p>Constructs shared across multiple jobs owned by your team (e.g.
+team-level defaults or structural templates) can be split into separate
+<code>.aurora</code>files and included via the <code>include</code> directive.</p>
+
+<h3 id="avoid-boilerplate">Avoid Boilerplate</h3>
+
+<p>If you see repetition or find yourself copy and pasting any parts of
+your configuration, it’s likely an opportunity for templating. Take the
+example below:</p>
+
+<p><code>redundant.aurora</code> contains:</p>
+<pre class="highlight text">download = Process(
+ name = 'download',
+ cmdline = 'wget http://www.python.org/ftp/python/2.7.3/Python-2.7.3.tar.bz2',
+ max_failures = 5,
+ min_duration = 1)
+
+unpack = Process(
+ name = 'unpack',
+ cmdline = 'rm -rf Python-2.7.3 && tar xzf Python-2.7.3.tar.bz2',
+ max_failures = 5,
+ min_duration = 1)
+
+build = Process(
+ name = 'build',
+ cmdline = 'pushd Python-2.7.3 && ./configure && make && popd',
+ max_failures = 1)
+
+email = Process(
+ name = 'email',
+ cmdline = 'echo Success | mail feynman@tmc.com',
+ max_failures = 5,
+ min_duration = 1)
+
+build_python = Task(
+ name = 'build_python',
+ processes = [download, unpack, build, email],
+ constraints = [Constraint(order = ['download', 'unpack', 'build', 'email'])])
+</pre>
+<p>As you’ll notice, there’s a lot of repetition in the <code>Process</code>
+definitions. For example, almost every process sets a <code>max_failures</code>
+limit to 5 and a <code>min_duration</code> to 1. This is an opportunity for factoring
+into a common process template.</p>
+
+<p>Furthermore, the Python version is repeated everywhere. This can be
+bound via structural templating as described in the <a href="#AdvancedBinding">Advanced Binding</a>
+section.</p>
+
+<p><code>less_redundant.aurora</code> contains:</p>
+<pre class="highlight text">class Python(Struct):
+ version = Required(String)
+ base = Default(String, 'Python-{{version}}')
+ package = Default(String, '{{base}}.tar.bz2')
+
+ReliableProcess = Process(
+ max_failures = 5,
+ min_duration = 1)
+
+download = ReliableProcess(
+ name = 'download',
+ cmdline = 'wget http://www.python.org/ftp/python/{{python.version}}/{{python.package}}')
+
+unpack = ReliableProcess(
+ name = 'unpack',
+ cmdline = 'rm -rf {{python.base}} && tar xzf {{python.package}}')
+
+build = ReliableProcess(
+ name = 'build',
+ cmdline = 'pushd {{python.base}} && ./configure && make && popd',
+ max_failures = 1)
+
+email = ReliableProcess(
+ name = 'email',
+ cmdline = 'echo Success | mail {{role}}@foocorp.com')
+
+build_python = SequentialTask(
+ name = 'build_python',
+ processes = [download, unpack, build, email]).bind(python = Python(version = "2.7.3"))
+</pre>
+<h3 id="thermos-uses-bash,-but-thermos-is-not-bash">Thermos Uses bash, But Thermos Is Not bash</h3>
+
+<h4 id="bad">Bad</h4>
+
+<p>Many tiny Processes makes for harder to manage configurations.</p>
+<pre class="highlight text">copy = Process(
+ name = 'copy',
+ cmdline = 'rcp user@my_machine:my_application .'
+ )
+
+ unpack = Process(
+ name = 'unpack',
+ cmdline = 'unzip app.zip'
+ )
+
+ remove = Process(
+ name = 'remove',
+ cmdline = 'rm -f app.zip'
+ )
+
+ run = Process(
+ name = 'app',
+ cmdline = 'java -jar app.jar'
+ )
+
+ run_task = Task(
+ processes = [copy, unpack, remove, run],
+ constraints = order(copy, unpack, remove, run)
+ )
+</pre>
+<h4 id="good">Good</h4>
+
+<p>Each <code>cmdline</code> runs in a bash subshell, so you have the full power of
+bash. Chaining commands with <code>&&</code> or <code>||</code> is almost always the right
+thing to do.</p>
+
+<p>Also for Tasks that are simply a list of processes that run one after
+another, consider using the <code>SequentialTask</code> helper which applies a
+linear ordering constraint for you.</p>
+<pre class="highlight text">stage = Process(
+ name = 'stage',
+ cmdline = 'rcp user@my_machine:my_application . && unzip app.zip && rm -f app.zip')
+
+run = Process(name = 'app', cmdline = 'java -jar app.jar')
+
+run_task = SequentialTask(processes = [stage, run])
+</pre>
+<h3 id="rarely-use-functions-in-your-configurations">Rarely Use Functions In Your Configurations</h3>
+
+<p>90% of the time you define a function in a <code>.aurora</code> file, you’re
+probably Doing It Wrong™.</p>
+
+<h4 id="bad">Bad</h4>
+<pre class="highlight text">def get_my_task(name, user, cpu, ram, disk):
+ return Task(
+ name = name,
+ user = user,
+ processes = [STAGE_PROCESS, RUN_PROCESS],
+ constraints = order(STAGE_PROCESS, RUN_PROCESS),
+ resources = Resources(cpu = cpu, ram = ram, disk = disk)
+ )
+
+ task_one = get_my_task('task_one', 'feynman', 1.0, 32*MB, 1*GB)
+ task_two = get_my_task('task_two', 'feynman', 2.0, 64*MB, 1*GB)
+</pre>
+<h4 id="good">Good</h4>
+
+<p>This one is more idiomatic. Forced keyword arguments prevents accidents,
+e.g. constructing a task with “32*MB” when you mean 32MB of ram and not
+disk. Less proliferation of task-construction techniques means
+easier-to-read, quicker-to-understand, and a more composable
+configuration.</p>
+<pre class="highlight text">TASK_TEMPLATE = SequentialTask(
+ user = 'wickman',
+ processes = [STAGE_PROCESS, RUN_PROCESS],
+)
+
+task_one = TASK_TEMPLATE(
+ name = 'task_one',
+ resources = Resources(cpu = 1.0, ram = 32*MB, disk = 1*GB) )
+
+task_two = TASK_TEMPLATE(
+ name = 'task_two',
+ resources = Resources(cpu = 2.0, ram = 64*MB, disk = 1*GB)
+)
+</pre>
+ </div>
+ <div class="container">
+ <hr>
+ <footer class="footer">
+ <div class="row-fluid">
+ <div class="span2 text-left">
+ <h3>Links</h3>
+ <ul class="unstyled">
+ <li><a href="/docs/gettingstarted/">Getting Started</a></li>
+ <li><a href="/downloads/">Downloads</a></li>
+ <li><a href="/developers/">Developers</a></li>
+ </ul>
+ </div>
+ <div class="span3 text-left">
+ <h3>Community</h3>
+ <ul class="unstyled">
+ <li><a href="/community/">Mailing Lists</a></li>
+ <li><a href="http://issues.apache.org/jira/browse/aurora">Issue Tracking</a></li>
+ <li><a href="/docs/howtocontribute/">How To Contribute</a></li>
+ </ul>
+ </div>
+ <div class="span7 text-left">
+ <h3>Apache Software Foundation</h3>
+
+ <div class="span8">
+ Copyright 2014 <a href="http://www.apache.org/">Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/">Apache License v2.0</a>. Apache, Apache Thrift, and the Apache feather logo are trademarks of The Apache Software Foundation. Currently part of the <a href="http://incubator.apache.org">Apache Incubator</a>.
+ </div>
+ <div class=" pull-right">
+ <a href="http://incubator.apache.org" class="logo"><img src="/assets/img/apache_incubator_logo.png" alt="Apache Incubator" class="pull-right"/></a>
+ </div>
+ </div>
+
+ </div>
+
+ </footer>
+</div>
+
+ </body>
+</html>
+
Added: incubator/aurora/site/publish/documentation/latest/contributing/index.html
URL: http://svn.apache.org/viewvc/incubator/aurora/site/publish/documentation/latest/contributing/index.html?rev=1581246&view=auto
==============================================================================
--- incubator/aurora/site/publish/documentation/latest/contributing/index.html (added)
+++ incubator/aurora/site/publish/documentation/latest/contributing/index.html Tue Mar 25 06:10:05 2014
@@ -0,0 +1,166 @@
+<html>
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Aurora</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="description" content="">
+ <meta name="author" content="">
+
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/bootstrap-responsive.min.css" rel="stylesheet">
+ <link href="/assets/css/main.css" rel="stylesheet">
+
+ <!-- JS -->
+ <script type="text/javascript" src="/assets/js/jquery-1.10.1.min.js"></script>
+ <script type="text/javascript" src="/assets/js/bootstrap-dropdown.js"></script>
+
+ <!-- Analytics -->
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-45879646-1']);
+ _gaq.push(['_setDomainName', 'apache.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+ </head>
+ <body>
+ <div class="navbar navbar-static-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a href="/" class="logo"><img src="/assets/img/aurora_logo.png" alt="Apache Aurora logo" /></a>
+ <ul class="nav">
+ <li><a href="/docs/gettingstarted/">Getting Started</a></li>
+ <li><a href="/documentation/latest/">Documentation</a></li>
+ <li><a href="/downloads/">Download</a></li>
+ <li><a href="/community">Community</a></li>
+ </ul>
+ </div>
+ </div>
+</div>
+
+<div class="container">
+<!-- magical breadcrumbs -->
+<ul class="breadcrumb">
+ <li>
+ <div class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation <b class="caret"></b></a>
+ <ul class="dropdown-menu" role="menu">
+ <li><a href="http://www.apache.org">Apache Homepage</a></li>
+ <li><a href="http://www.apache.org/licenses/">Apache License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ </ul>
+ </div>
+ </li>
+ <li><span class="divider">•</span></li>
+ <li><a href="http://incubator.apache.org">Apache Incubator</a></li>
+ <li><span class="divider">•</span></li>
+ <li><a href="http://aurora.incubator.apache.org">Apache Aurora</a></li>
+</ul>
+<!-- /breadcrumb -->
+
+ <div class="container">
+ <h2 id="getting-your-reviewboard-account">Getting your ReviewBoard Account</h2>
+
+<p>Go to <a href="https://reviews.apache.org">https://reviews.apache.org</a> and create an account.</p>
+
+<h2 id="setting-up-your-email-account-(committers)">Setting up your email account (committers)</h2>
+
+<p>Once your Apache ID has been set up you can configure your account and add ssh keys and
+setup an email forwarding address at</p>
+
+<p><a href="http://id.apache.org">http://id.apache.org</a></p>
+
+<p>Additional instructions for setting up your new committer email can be found at</p>
+
+<p><a href="http://www.apache.org/dev/user-email.html">http://www.apache.org/dev/user-email.html</a></p>
+
+<p>The recommended setup is to configure all services (mailing lists, JIRA, ReviewBoard) to
+send emails to your @apache.org email address.</p>
+
+<h2 id="setting-up-your-reviewboard-environment">Setting up your ReviewBoard Environment</h2>
+
+<p>Run <code>./rbt status</code>. The first time this runs it will bootstrap and you will be asked to login.
+Subsequent runs will cache your login credentials.</p>
+
+<h2 id="submitting-a-patch-for-review">Submitting a Patch for Review</h2>
+
+<p>Post a review with <code>rbt</code>, fill out the fields in your browser and hit Publish.</p>
+<pre class="highlight text">./rbt post -o -g
+</pre>
+<h2 id="updating-an-existing-review">Updating an Existing Review</h2>
+
+<p>Incorporate review feedback, make some more commits, update your existing review, fill out the
+fields in your browser and hit Publish.</p>
+<pre class="highlight text">./rbt post -o -r <RB_ID>
+</pre>
+<h2 id="merging-your-own-review-(committers)">Merging Your Own Review (Committers)</h2>
+
+<p>Once you have shipits from the right committers, merge your changes in a single commit and mark
+the review as submitted. The typical workflow is:</p>
+<pre class="highlight text">git checkout master
+git pull origin master
+./rbt patch -c <RB_ID> # Verify the automatically-generated commit message looks sane,
+ # editing if necessary.
+git show master # Verify everything looks sane
+git push origin master
+./rbt close <RB_ID>
+</pre>
+<p>Note that even if you’re developing using feature branches you will not use <code>git merge</code> - each
+commit will be an atomic change accompanied by a ReviewBoard entry.</p>
+
+<h2 id="merging-someone-else's-review">Merging Someone Else’s Review</h2>
+
+<p>Sometimes you’ll need to merge someone else’s RB. The typical workflow for this is</p>
+<pre class="highlight text">git checkout master
+git pull origin master
+./rbt patch -c <RB_ID>
+git show master # Verify everything looks sane, author is correct
+git push origin master
+</pre>
+ </div>
+ <div class="container">
+ <hr>
+ <footer class="footer">
+ <div class="row-fluid">
+ <div class="span2 text-left">
+ <h3>Links</h3>
+ <ul class="unstyled">
+ <li><a href="/docs/gettingstarted/">Getting Started</a></li>
+ <li><a href="/downloads/">Downloads</a></li>
+ <li><a href="/developers/">Developers</a></li>
+ </ul>
+ </div>
+ <div class="span3 text-left">
+ <h3>Community</h3>
+ <ul class="unstyled">
+ <li><a href="/community/">Mailing Lists</a></li>
+ <li><a href="http://issues.apache.org/jira/browse/aurora">Issue Tracking</a></li>
+ <li><a href="/docs/howtocontribute/">How To Contribute</a></li>
+ </ul>
+ </div>
+ <div class="span7 text-left">
+ <h3>Apache Software Foundation</h3>
+
+ <div class="span8">
+ Copyright 2014 <a href="http://www.apache.org/">Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/">Apache License v2.0</a>. Apache, Apache Thrift, and the Apache feather logo are trademarks of The Apache Software Foundation. Currently part of the <a href="http://incubator.apache.org">Apache Incubator</a>.
+ </div>
+ <div class=" pull-right">
+ <a href="http://incubator.apache.org" class="logo"><img src="/assets/img/apache_incubator_logo.png" alt="Apache Incubator" class="pull-right"/></a>
+ </div>
+ </div>
+
+ </div>
+
+ </footer>
+</div>
+
+ </body>
+</html>
+
Added: incubator/aurora/site/publish/documentation/latest/deploying-aurora-scheduler/index.html
URL: http://svn.apache.org/viewvc/incubator/aurora/site/publish/documentation/latest/deploying-aurora-scheduler/index.html?rev=1581246&view=auto
==============================================================================
--- incubator/aurora/site/publish/documentation/latest/deploying-aurora-scheduler/index.html (added)
+++ incubator/aurora/site/publish/documentation/latest/deploying-aurora-scheduler/index.html Tue Mar 25 06:10:05 2014
@@ -0,0 +1,247 @@
+<html>
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Aurora</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="description" content="">
+ <meta name="author" content="">
+
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/bootstrap-responsive.min.css" rel="stylesheet">
+ <link href="/assets/css/main.css" rel="stylesheet">
+
+ <!-- JS -->
+ <script type="text/javascript" src="/assets/js/jquery-1.10.1.min.js"></script>
+ <script type="text/javascript" src="/assets/js/bootstrap-dropdown.js"></script>
+
+ <!-- Analytics -->
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-45879646-1']);
+ _gaq.push(['_setDomainName', 'apache.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+ </head>
+ <body>
+ <div class="navbar navbar-static-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a href="/" class="logo"><img src="/assets/img/aurora_logo.png" alt="Apache Aurora logo" /></a>
+ <ul class="nav">
+ <li><a href="/docs/gettingstarted/">Getting Started</a></li>
+ <li><a href="/documentation/latest/">Documentation</a></li>
+ <li><a href="/downloads/">Download</a></li>
+ <li><a href="/community">Community</a></li>
+ </ul>
+ </div>
+ </div>
+</div>
+
+<div class="container">
+<!-- magical breadcrumbs -->
+<ul class="breadcrumb">
+ <li>
+ <div class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation <b class="caret"></b></a>
+ <ul class="dropdown-menu" role="menu">
+ <li><a href="http://www.apache.org">Apache Homepage</a></li>
+ <li><a href="http://www.apache.org/licenses/">Apache License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ </ul>
+ </div>
+ </li>
+ <li><span class="divider">•</span></li>
+ <li><a href="http://incubator.apache.org">Apache Incubator</a></li>
+ <li><span class="divider">•</span></li>
+ <li><a href="http://aurora.incubator.apache.org">Apache Aurora</a></li>
+</ul>
+<!-- /breadcrumb -->
+
+ <div class="container">
+ <p>The Aurora scheduler is responsible for scheduling new jobs, rescheduling failed jobs, and killing
+old jobs.</p>
+
+<h1 id="installing-aurora">Installing Aurora</h1>
+
+<p>Aurora is a standalone Java server. As part of the build process it creates a bundle of all its
+dependencies, with the notable exceptions of the JVM and libmesos. Each target server should have
+a JVM (Java 7 or higher) and libmesos (0.17.0) installed.</p>
+
+<h2 id="creating-the-distribution-.zip-file-(optional)">Creating the Distribution .zip File (Optional)</h2>
+
+<p>To create a distribution for installation you will need build tools installed. On Ubuntu this can be
+done with <code>sudo apt-get install build-essential default-jdk</code>.</p>
+<pre class="highlight text">git clone http://git-wip-us.apache.org/repos/asf/incubator-aurora.git
+cd incubator-aurora
+./gradlew distZip
+</pre>
+<p>Copy the generated <code>dist/distributions/aurora-scheduler-*.zip</code> to each node that will run a scheduler.</p>
+
+<h2 id="installing-aurora">Installing Aurora</h2>
+
+<p>Extract the aurora-scheduler zip file. The example configurations assume it is extracted to
+<code>/usr/local/aurora-scheduler</code>.</p>
+<pre class="highlight text">sudo unzip dist/distributions/aurora-scheduler-*.zip -d /usr/local
+sudo ln -nfs "$(ls -dt /usr/local/aurora-scheduler-* | head -1)" /usr/local/aurora-scheduler
+</pre>
+<h1 id="configuring-aurora">Configuring Aurora</h1>
+
+<h2 id="a-note-on-configuration">A Note on Configuration</h2>
+
+<p>Like Mesos, Aurora uses command-line flags for runtime configuration. As such the Aurora
+“configuration file” is typically a <code>scheduler.sh</code> shell script of the form.</p>
+<pre class="highlight shell"><span class="c">#!/bin/bash</span>
+<span class="nv">AURORA_HOME</span><span class="o">=</span>/usr/local/aurora-scheduler
+
+<span class="c"># Flags controlling the JVM.</span>
+<span class="nv">JAVA_OPTS</span><span class="o">=(</span>
+ -Xmx2g
+ -Xms2g
+ <span class="c"># GC tuning, etc.</span>
+<span class="o">)</span>
+
+<span class="c"># Flags controlling the scheduler.</span>
+<span class="nv">AURORA_FLAGS</span><span class="o">=(</span>
+ -http_port<span class="o">=</span>8081
+ -thrift_port<span class="o">=</span>8082
+ <span class="c"># Log configuration, etc.</span>
+<span class="o">)</span>
+
+<span class="c"># Environment variables controlling libmesos</span>
+<span class="nb">export </span><span class="nv">JAVA_HOME</span><span class="o">=</span>...
+<span class="nb">export </span><span class="nv">GLOG_v</span><span class="o">=</span>1
+<span class="nb">export </span><span class="nv">LIBPROCESS_PORT</span><span class="o">=</span>8083
+
+<span class="nv">JAVA_OPTS</span><span class="o">=</span><span class="s2">"</span><span class="k">${</span><span class="nv">JAVA_OPTS</span><span class="p">[*]</span><span class="k">}</span><span class="s2">"</span> <span class="nb">exec</span> <span class="s2">"</span><span class="nv">$AURORA_HOME</span><span class="s2">/bin/aurora-scheduler"</span> <span class="s2">"</span><span class="k">${</span><span class="nv">AURORA_FLAGS</span><span class="p">[@]</span><span class="k">}</span><span class="s2">"</span>
+</pre>
+<p>That way Aurora’s current flags are visible in <code>ps</code> and in the <code>/vars</code> admin endpoint.</p>
+
+<p>Examples are available under <code>examples/scheduler/</code>. For a list of available Aurora flags and their
+documentation run</p>
+<pre class="highlight text">/usr/local/aurora-scheduler/bin/aurora-scheduler -help
+</pre>
+<h2 id="replicated-log-configuration">Replicated Log Configuration</h2>
+
+<p>All Aurora state is persisted to a replicated log. This includes all jobs Aurora is running
+including where in the cluster they are being run and the configuration for running them, as
+well as other information such as metadata needed to reconnect to the Mesos master, resource
+quotas, and any other locks in place.</p>
+
+<p>Aurora schedulers use ZooKeeper to discover log replicas and elect a leader. Only one scheduler is
+leader at a given time - the other schedulers follow log writes and prepare to take over as leader
+but do not communicate with the Mesos master. Either 3 or 5 schedulers are recommended in a
+production deployment depending on failure tolerance and they must have persistent storage.</p>
+
+<p>In a cluster with <code>N</code> schedulers, the flag <code>-native_log_quorum_size</code> should be set to
+<code>floor(N/2) + 1</code>. So in a cluster with 1 scheduler it should be set to <code>1</code>, in a cluster with 3 it
+should be set to <code>2</code>, and in a cluster of 5 it should be set to <code>3</code>.</p>
+
+<table>
+ <thead>
+ <tr>
+ <th>Number of schedulers (N)
+ <th><code>-native_log_quorum_size</code> setting (<code>floor(N/2) + 1</code>)
+ <tbody>
+ <tr>
+ <td>1
+ <td>1
+ <tr>
+ <td>3
+ <td>2
+ <tr>
+ <td>5
+ <td>3
+ <tr>
+ <td>7
+ <td>4
+</table>
+
+<p><em>Incorrectly setting this flag will cause data corruption to occur!</em></p>
+
+<h2 id="network-considerations">Network considerations</h2>
+
+<p>The Aurora scheduler listens on 3 ports - a Thrift port for client RPCs, an admin web UI, and a
+libprocess (HTTP+Protobuf) port used to communicate with the Mesos master and for the log
+replication protocol. These can be left unconfigured (the scheduler publishes all selected ports
+to ZooKeeper) or explicitly set in the startup script as follows:</p>
+<pre class="highlight text"># ...
+AURORA_FLAGS=(
+ # ...
+ -http_port=8081
+ -thrift_port=8082
+ # ...
+)
+# ...
+export LIBPROCESS_PORT=8083
+# ...
+</pre>
+<h1 id="running-aurora">Running Aurora</h1>
+
+<p>Configure a supervisor like <a href="http://mmonit.com/monit/">Monit</a> or
+<a href="http://supervisord.org/">supervisord</a> to run the created <code>scheduler.sh</code> file and restart it
+whenever it fails. Aurora expects to be restarted by an external process when it fails. Aurora
+supports an active health checking protocol on its admin HTTP interface - if a <code>GET /health</code> times
+out or returns anything other than <code>200 OK</code> the scheduler process is unhealthy and should be
+restarted.</p>
+
+<p>For example, monit can be configured with</p>
+<pre class="highlight text">if failed port 8081 send "GET /health HTTP/1.0\r\n" expect "OK\n" with timeout 2 seconds for 10 cycles then restart
+</pre>
+<p>assuming you set <code>-http_port=8081</code>.</p>
+
+<h1 id="maintaining-an-aurora-installation">Maintaining an Aurora Installation</h1>
+
+<h2 id="monitoring">Monitoring</h2>
+
+<p>Aurora exports performance metrics via its HTTP interface <code>/vars</code> and <code>/vars.json</code> contain lots of
+useful data to help debug performance and configuration problems. These are all made available via
+<a href="https://github.com/twitter/commons/tree/master/src/java/com/twitter/commons/http">twitter.common.http</a>.</p>
+
+ </div>
+ <div class="container">
+ <hr>
+ <footer class="footer">
+ <div class="row-fluid">
+ <div class="span2 text-left">
+ <h3>Links</h3>
+ <ul class="unstyled">
+ <li><a href="/docs/gettingstarted/">Getting Started</a></li>
+ <li><a href="/downloads/">Downloads</a></li>
+ <li><a href="/developers/">Developers</a></li>
+ </ul>
+ </div>
+ <div class="span3 text-left">
+ <h3>Community</h3>
+ <ul class="unstyled">
+ <li><a href="/community/">Mailing Lists</a></li>
+ <li><a href="http://issues.apache.org/jira/browse/aurora">Issue Tracking</a></li>
+ <li><a href="/docs/howtocontribute/">How To Contribute</a></li>
+ </ul>
+ </div>
+ <div class="span7 text-left">
+ <h3>Apache Software Foundation</h3>
+
+ <div class="span8">
+ Copyright 2014 <a href="http://www.apache.org/">Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/">Apache License v2.0</a>. Apache, Apache Thrift, and the Apache feather logo are trademarks of The Apache Software Foundation. Currently part of the <a href="http://incubator.apache.org">Apache Incubator</a>.
+ </div>
+ <div class=" pull-right">
+ <a href="http://incubator.apache.org" class="logo"><img src="/assets/img/apache_incubator_logo.png" alt="Apache Incubator" class="pull-right"/></a>
+ </div>
+ </div>
+
+ </div>
+
+ </footer>
+</div>
+
+ </body>
+</html>
+
Added: incubator/aurora/site/publish/documentation/latest/developing-aurora-scheduler/index.html
URL: http://svn.apache.org/viewvc/incubator/aurora/site/publish/documentation/latest/developing-aurora-scheduler/index.html?rev=1581246&view=auto
==============================================================================
--- incubator/aurora/site/publish/documentation/latest/developing-aurora-scheduler/index.html (added)
+++ incubator/aurora/site/publish/documentation/latest/developing-aurora-scheduler/index.html Tue Mar 25 06:10:05 2014
@@ -0,0 +1,195 @@
+<html>
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Aurora</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="description" content="">
+ <meta name="author" content="">
+
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/bootstrap-responsive.min.css" rel="stylesheet">
+ <link href="/assets/css/main.css" rel="stylesheet">
+
+ <!-- JS -->
+ <script type="text/javascript" src="/assets/js/jquery-1.10.1.min.js"></script>
+ <script type="text/javascript" src="/assets/js/bootstrap-dropdown.js"></script>
+
+ <!-- Analytics -->
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-45879646-1']);
+ _gaq.push(['_setDomainName', 'apache.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+ </head>
+ <body>
+ <div class="navbar navbar-static-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a href="/" class="logo"><img src="/assets/img/aurora_logo.png" alt="Apache Aurora logo" /></a>
+ <ul class="nav">
+ <li><a href="/docs/gettingstarted/">Getting Started</a></li>
+ <li><a href="/documentation/latest/">Documentation</a></li>
+ <li><a href="/downloads/">Download</a></li>
+ <li><a href="/community">Community</a></li>
+ </ul>
+ </div>
+ </div>
+</div>
+
+<div class="container">
+<!-- magical breadcrumbs -->
+<ul class="breadcrumb">
+ <li>
+ <div class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation <b class="caret"></b></a>
+ <ul class="dropdown-menu" role="menu">
+ <li><a href="http://www.apache.org">Apache Homepage</a></li>
+ <li><a href="http://www.apache.org/licenses/">Apache License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ </ul>
+ </div>
+ </li>
+ <li><span class="divider">•</span></li>
+ <li><a href="http://incubator.apache.org">Apache Incubator</a></li>
+ <li><span class="divider">•</span></li>
+ <li><a href="http://aurora.incubator.apache.org">Apache Aurora</a></li>
+</ul>
+<!-- /breadcrumb -->
+
+ <div class="container">
+ <p>Java code in the aurora repo is built with <a href="http://gradle.org">Gradle</a>.</p>
+
+<h1 id="getting-started">Getting Started</h1>
+
+<p>You will need Java 7 installed and on your <code>PATH</code> or unzipped somewhere with <code>JAVA_HOME</code> set. Then</p>
+<pre class="highlight text">./gradlew tasks
+</pre>
+<p>will bootstrap the build system and show available tasks. This can take a while the first time you
+run it but subsequent runs will be much faster due to cached artifacts.</p>
+
+<h2 id="running-the-tests">Running the Tests</h2>
+
+<p>Aurora has a comprehensive unit test suite. To run the tests use</p>
+<pre class="highlight text">./gradlew build
+</pre>
+<p>Gradle will only re-run tests when dependencies of them have changed. To force a re-run of all
+tests use</p>
+<pre class="highlight text">./gradlew clean build
+</pre>
+<h2 id="creating-a-bundle-for-deployment">Creating a bundle for deployment</h2>
+
+<p>Gradle can create a zip file containing Aurora, all of its dependencies, and a launch script with</p>
+<pre class="highlight text">./gradlew distZip
+</pre>
+<p>or a tar file containing the same files with</p>
+<pre class="highlight text">./gradlew distTar
+</pre>
+<p>The output file will be written to <code>dist/distributions/aurora-scheduler.zip</code> or
+<code>dist/distributions/aurora-scheduler.tar</code>.</p>
+
+<h1 id="developing-aurora-java-code">Developing Aurora Java code</h1>
+
+<h2 id="setting-up-an-ide">Setting up an IDE</h2>
+
+<p>Gradle can generate project files for your IDE. To generate an IntelliJ IDEA project run</p>
+<pre class="highlight text">./gradlew idea
+</pre>
+<p>and import the generated <code>aurora.ipr</code> file.</p>
+
+<h2 id="adding-or-upgrading-a-dependency">Adding or Upgrading a Dependency</h2>
+
+<p>New dependencies can be added from Maven central by adding a <code>compile</code> dependency to <code>build.gradle</code>.
+For example, to add a dependency on <code>com.example</code>’s <code>example-lib</code> 1.0 add this block:</p>
+<pre class="highlight text">compile 'com.example:example-lib:1.0'
+</pre>
+<p>NOTE: Anyone thinking about adding a new dependency should first familiarize themself with the
+Apache Foundation’s third-party licensing
+<a href="http://www.apache.org/legal/resolved.html#category-x">policy</a>.</p>
+
+<h1 id="developing-aurora-ui">Developing Aurora UI</h1>
+
+<h2 id="installing-bower-(optional)">Installing bower (optional)</h2>
+
+<p>Third party JS libraries used in Aurora (located at 3rdparty/javascript/bower_components) are
+managed by bower, a JS dependency manager. Bower is only required if you plan to add, remove or
+update JS libraries. Bower can be installed using the following command:</p>
+<pre class="highlight text">npm install -g bower
+</pre>
+<p>Bower depends on node.js and npm. The easiest way to install node on a mac is via brew:</p>
+<pre class="highlight text">brew install node
+</pre>
+<p>For more node.js installation options refer to <a href="https://github.com/joyent/node/wiki/Installation">https://github.com/joyent/node/wiki/Installation</a>.</p>
+
+<p>More info on installing and using bower can be found at: <a href="http://bower.io/">http://bower.io/</a>. Once installed, you can
+use the following commands to view and modify the bower repo at
+3rdparty/javascript/bower_components</p>
+<pre class="highlight text">bower list
+bower install <library name>
+bower remove <library name>
+bower update <library name>
+bower help
+</pre>
+<h1 id="developing-the-aurora-build-system">Developing the Aurora Build System</h1>
+
+<h2 id="bootstrapping-gradle">Bootstrapping Gradle</h2>
+
+<p>The following files were autogenerated by <code>gradle wrapper</code> using gradle 1.8’s
+<a href="http://www.gradle.org/docs/1.8/dsl/org.gradle.api.tasks.wrapper.Wrapper.html">Wrapper</a> plugin and
+should not be modified directly:</p>
+<pre class="highlight text">./gradlew
+./gradlew.bat
+./gradle/wrapper/gradle-wrapper.jar
+./gradle/wrapper/gradle-wrapper.properties
+</pre>
+<p>To upgrade Gradle unpack the new version somewhere, run <code>/path/to/new/gradle wrapper</code> in the
+repository root and commit the changed files.</p>
+
+ </div>
+ <div class="container">
+ <hr>
+ <footer class="footer">
+ <div class="row-fluid">
+ <div class="span2 text-left">
+ <h3>Links</h3>
+ <ul class="unstyled">
+ <li><a href="/docs/gettingstarted/">Getting Started</a></li>
+ <li><a href="/downloads/">Downloads</a></li>
+ <li><a href="/developers/">Developers</a></li>
+ </ul>
+ </div>
+ <div class="span3 text-left">
+ <h3>Community</h3>
+ <ul class="unstyled">
+ <li><a href="/community/">Mailing Lists</a></li>
+ <li><a href="http://issues.apache.org/jira/browse/aurora">Issue Tracking</a></li>
+ <li><a href="/docs/howtocontribute/">How To Contribute</a></li>
+ </ul>
+ </div>
+ <div class="span7 text-left">
+ <h3>Apache Software Foundation</h3>
+
+ <div class="span8">
+ Copyright 2014 <a href="http://www.apache.org/">Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/">Apache License v2.0</a>. Apache, Apache Thrift, and the Apache feather logo are trademarks of The Apache Software Foundation. Currently part of the <a href="http://incubator.apache.org">Apache Incubator</a>.
+ </div>
+ <div class=" pull-right">
+ <a href="http://incubator.apache.org" class="logo"><img src="/assets/img/apache_incubator_logo.png" alt="Apache Incubator" class="pull-right"/></a>
+ </div>
+ </div>
+
+ </div>
+
+ </footer>
+</div>
+
+ </body>
+</html>
+