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/12/06 20:01:41 UTC
svn commit: r1643588 - in /incubator/aurora/site:
publish/documentation/latest/ publish/documentation/latest/client-commands/
publish/documentation/latest/clientv2/
publish/documentation/latest/cron-jobs/ source/documentation/
source/documentation/latest/
Author: dlester
Date: Sat Dec 6 19:01:40 2014
New Revision: 1643588
URL: http://svn.apache.org/r1643588
Log:
Updates website documentation to reflect current git master.
Modified:
incubator/aurora/site/publish/documentation/latest/client-commands/index.html
incubator/aurora/site/publish/documentation/latest/clientv2/index.html
incubator/aurora/site/publish/documentation/latest/cron-jobs/index.html
incubator/aurora/site/publish/documentation/latest/index.html
incubator/aurora/site/source/documentation/latest.html.md
incubator/aurora/site/source/documentation/latest/client-commands.md
incubator/aurora/site/source/documentation/latest/clientv2.md
incubator/aurora/site/source/documentation/latest/cron-jobs.md
Modified: incubator/aurora/site/publish/documentation/latest/client-commands/index.html
URL: http://svn.apache.org/viewvc/incubator/aurora/site/publish/documentation/latest/client-commands/index.html?rev=1643588&r1=1643587&r2=1643588&view=diff
==============================================================================
--- incubator/aurora/site/publish/documentation/latest/client-commands/index.html (original)
+++ incubator/aurora/site/publish/documentation/latest/client-commands/index.html Sat Dec 6 19:01:40 2014
@@ -84,7 +84,11 @@ reflection.</p>
<li><a href="#creating-and-running-a-job">Creating and Running a Job</a></li>
<li><a href="#running-a-command-on-a-running-job">Running a Command On a Running Job</a></li>
<li><a href="#killing-a-job">Killing a Job</a></li>
-<li><a href="#updating-a-job">Updating a Job</a></li>
+<li><a href="#updating-a-job">Updating a Job</a>
+
+<ul>
+<li><a href="#user-content-asynchronous-job-updates-beta">Asynchronous job updates (beta)</a></li>
+</ul></li>
<li><a href="#renaming-a-job">Renaming a Job</a></li>
<li><a href="#restarting-jobs">Restarting Jobs</a></li>
</ul></li>
@@ -313,6 +317,35 @@ Defaults to <code>False</code>.</li>
Time interval between subsequent shard status checks. Defaults to <code>3</code>.</li>
</ul>
+<h4 id="asynchronous-job-updates-(beta)">Asynchronous job updates (beta)</h4>
+
+<p>As of 0.6.0, Aurora will coordinate updates (and rollbacks) within the
+scheduler. Performing updates this way also allows the scheduler to display
+update progress and job update history in the browser.</p>
+
+<p>There are several sub-commands to manage job updates:</p>
+<pre class="highlight text">aurora2 beta-update start <job key> <configuration file
+aurora2 beta-update status <job key>
+aurora2 beta-update pause <job key>
+aurora2 beta-update resume <job key>
+aurora2 beta-update abort <job key>
+aurora2 beta-update list <cluster>
+</pre>
+<p>When you <code>start</code> a job update, the command will return once it has sent the
+instructions to the scheduler. At that point, you may view detailed
+progress for the update with the <code>status</code> subcommand, in addition to viewing
+graphical progress in the web browser. You may also get a full listing of
+in-progress updates in a cluster with <code>list</code>.</p>
+
+<p>Once an update has been started, you can <code>pause</code> to keep the update but halt
+progress. This can be useful for doing things like debug a partially-updated
+job to determine whether you would like to proceed. You can <code>resume</code> to
+proceed.</p>
+
+<p>You may <code>abort</code> a job update regardless of the state it is in. This will
+instruct the scheduler to completely abandon the job update and leave the job
+in the current (possibly partially-updated) state.</p>
+
<h3 id="renaming-a-job">Renaming a Job</h3>
<p>Renaming is a tricky operation as downstream clients must be informed of
Modified: incubator/aurora/site/publish/documentation/latest/clientv2/index.html
URL: http://svn.apache.org/viewvc/incubator/aurora/site/publish/documentation/latest/clientv2/index.html?rev=1643588&r1=1643587&r2=1643588&view=diff
==============================================================================
--- incubator/aurora/site/publish/documentation/latest/clientv2/index.html (original)
+++ incubator/aurora/site/publish/documentation/latest/clientv2/index.html Sat Dec 6 19:01:40 2014
@@ -305,7 +305,8 @@ schedule. The cron commands all manipula
schedules are specified as a part of the job configuration.</p>
<ul>
-<li><code>aurora cron schedule jobkey config</code>: schedule a job to run by cron.</li>
+<li><code>aurora cron schedule jobkey config</code>: schedule a job to run by cron. If a cron job already exists
+replaces its template with a new one.</li>
<li><code>aurora cron deschedule jobkey</code>: removes a jobs entry from the cron schedule.</li>
<li><code>aurora cron status jobkey</code>: query for a scheduled job’s status.</li>
</ul>
Modified: incubator/aurora/site/publish/documentation/latest/cron-jobs/index.html
URL: http://svn.apache.org/viewvc/incubator/aurora/site/publish/documentation/latest/cron-jobs/index.html?rev=1643588&r1=1643587&r2=1643588&view=diff
==============================================================================
--- incubator/aurora/site/publish/documentation/latest/cron-jobs/index.html (original)
+++ incubator/aurora/site/publish/documentation/latest/cron-jobs/index.html Sat Dec 6 19:01:40 2014
@@ -154,7 +154,8 @@ for up-to-date usage instructions.</p>
<h3 id="cron-schedule">cron schedule</h3>
-<p>Schedules a new cron job on the Aurora cluster for later runs, or updates an existing job.</p>
+<p>Schedules a new cron job on the Aurora cluster for later runs or replaces the existing cron template
+with a new one. Only future runs will be affected, any existing active tasks are left intact.</p>
<pre class="highlight text">$ aurora2 cron schedule devcluster/www-data/test/cron_hello_world /vagrant/examples/jobs/cron_hello_world.aurora
</pre>
<h3 id="cron-deschedule">cron deschedule</h3>
Modified: incubator/aurora/site/publish/documentation/latest/index.html
URL: http://svn.apache.org/viewvc/incubator/aurora/site/publish/documentation/latest/index.html?rev=1643588&r1=1643587&r2=1643588&view=diff
==============================================================================
--- incubator/aurora/site/publish/documentation/latest/index.html (original)
+++ incubator/aurora/site/publish/documentation/latest/index.html Sat Dec 6 19:01:40 2014
@@ -65,28 +65,54 @@
<!-- /breadcrumb -->
<div class="container">
- <h1 id="overview">Overview</h1>
+ <h1 id="documentation">Documentation</h1>
-<p><em>Aurora</em> is a service scheduler that schedules jobs onto <em>Mesos</em>, which runs tasks at a specified cluster. Typical services consist of up to hundreds of task replicas.</p>
+<h2 id="introduction">Introduction</h2>
-<p>Aurora provides a <em>Job</em> abstraction consisting of a <em>Task</em> template and instructions for creating near-identical replicas of that Task (modulo things like “instance id” or specific port numbers which may differ from machine to machine).</p>
+<p>Apache Aurora is a service scheduler that runs on top of Apache Mesos, enabling you to run long-running services that take advantage of Apache Mesos' scalability, fault-tolerance, and resource isolation. This documentation has been organized into sections with three audiences in mind:</p>
-<p><em>Terminology Note</em>: <em>Replicas</em> are also referred to as <em>shards</em> and <em>instances</em>. While there is a general desire to move to using “instances”, “shard” is still found in commands and help strings.</p>
-
-<p>Typically a Task is a single <em>Process</em> corresponding to a single command line, such as <code>python2.6 my_script.py</code>. However, sometimes you must colocate separate Processes together within a single Task, which runs within a single container and <code>chroot</code>, often referred to as a “sandbox”. For example, if you run multiple cooperating agents together such as <code>logrotate</code>, <code>installer</code>, and master or slave processes. <em>Thermos</em> provides a Process abstraction under the Mesos Tasks.</p>
-
-<p>To use and get up to speed on Aurora, you should look the docs in this directory in this order:</p>
-
-<ol>
-<li>How to <a href="/documentation/latest/deploying-aurora-scheduler/">deploy Aurora</a> or, how to <a href="/documentation/latest/vagrant/">install Aurora on virtual machines on your private machine</a> (the Tutorial uses the virtual machine approach).</li>
-<li>As a user, get started quickly with a <a href="/documentation/latest/tutorial/">Tutorial</a>.</li>
-<li>For an overview of Aurora’s process flow under the hood, see the <a href="/documentation/latest/user-guide/">User Guide</a>.</li>
-<li>To learn how to write a configuration file, look at our <a href="/documentation/latest/configuration-tutorial/">Configuration Tutorial</a>. From there, look at the <a href="/documentation/latest/configuration-reference/">Aurora + Thermos Reference</a>.</li>
-<li>Then read up on the <a href="/documentation/latest/client-commands/">Aurora Command Line Client</a>.</li>
-<li>Find out general information and useful tips about how Aurora does <a href="/documentation/latest/resource-isolation/">Resource Isolation</a>.</li>
-</ol>
-
-<p>To contact the Aurora Developer List, email <a href="mailto:dev@aurora.incubator.apache.org">dev@aurora.incubator.apache.org</a>. You may want to read the list <a href="http://mail-archives.apache.org/mod_mbox/incubator-aurora-dev/">archives</a>. You can also use the IRC channel <code>#aurora</code> on <code>irc.freenode.net</code></p>
+<ul>
+<li>Users: General information about the project and to learn how to run an Aurora job.</li>
+<li>Operators: For those that wish to manage and fine-tune an Aurora cluster.</li>
+<li>Developers: All the information you need to start modifying Aurora and contributing back to the project.</li>
+</ul>
+
+<p>This documentation is a work in progress, and we encourage you to ask questions on the <a href="http://aurora.incubator.apache.org/community/">Aurora developer list</a> or the <code>#aurora</code> IRC channel on <code>irc.freenode.net</code>.</p>
+
+<h2 id="users">Users</h2>
+
+<ul>
+<li><a href="/documentation/latest/vagrant/">Install Aurora on virtual machines on your private machine</a></li>
+<li><a href="/documentation/latest/tutorial/">Hello World Tutorial</a></li>
+<li><a href="/documentation/latest/user-guide/">User Guide</a></li>
+<li><a href="/documentation/latest/configuration-tutorial/">Configuration Tutorial</a></li>
+<li><a href="/documentation/latest/configuration-reference/">Aurora + Thermos Reference</a></li>
+<li><a href="/documentation/latest/client-commands/">Command Line Client</a></li>
+<li><a href="/documentation/latest/clientv2/">Aurora Client v2</a></li>
+<li><a href="/documentation/latest/cron-jobs/">Cron Jobs</a></li>
+</ul>
+
+<h2 id="operators">Operators</h2>
+
+<ul>
+<li><a href="/documentation/latest/deploying-aurora-scheduler/">Deploy Aurora</a></li>
+<li><a href="/documentation/latest/monitoring/">Monitoring</a></li>
+<li><a href="/documentation/latest/hooks/">Hooks for Aurora Client API</a></li>
+<li><a href="/documentation/latest/storage/">Scheduler Storage</a></li>
+<li><a href="/documentation/latest/storage-config/">Scheduler Storage and Maintenance</a></li>
+<li><a href="/documentation/latest/sla/">SLA Measurement</a></li>
+<li><a href="/documentation/latest/resource-isolation/">Resource Isolation and Sizing</a></li>
+<li><a href="/documentation/latest/test-resource-generation/">Generating test resources</a></li>
+</ul>
+
+<h2 id="developers">Developers</h2>
+
+<ul>
+<li><a href="/documentation/latest/contributing/">Contributing to the project</a></li>
+<li><a href="/documentation/latest/developing-aurora-scheduler/">Developing the Aurora Scheduler</a></li>
+<li><a href="/documentation/latest/developing-aurora-client/">Developing the Aurora Client</a></li>
+<li><a href="/documentation/latest/committers/">Committers Guide</a></li>
+</ul>
</div>
<div class="container">
Modified: incubator/aurora/site/source/documentation/latest.html.md
URL: http://svn.apache.org/viewvc/incubator/aurora/site/source/documentation/latest.html.md?rev=1643588&r1=1643587&r2=1643588&view=diff
==============================================================================
--- incubator/aurora/site/source/documentation/latest.html.md (original)
+++ incubator/aurora/site/source/documentation/latest.html.md Sat Dec 6 19:01:40 2014
@@ -1,20 +1,36 @@
-# Overview
+# Documentation
-*Aurora* is a service scheduler that schedules jobs onto *Mesos*, which runs tasks at a specified cluster. Typical services consist of up to hundreds of task replicas.
-
-Aurora provides a *Job* abstraction consisting of a *Task* template and instructions for creating near-identical replicas of that Task (modulo things like "instance id" or specific port numbers which may differ from machine to machine).
-
-*Terminology Note*: *Replicas* are also referred to as *shards* and *instances*. While there is a general desire to move to using "instances", "shard" is still found in commands and help strings.
-
-Typically a Task is a single *Process* corresponding to a single command line, such as `python2.6 my_script.py`. However, sometimes you must colocate separate Processes together within a single Task, which runs within a single container and `chroot`, often referred to as a "sandbox". For example, if you run multiple cooperating agents together such as `logrotate`, `installer`, and master or slave processes. *Thermos* provides a Process abstraction under the Mesos Tasks.
-
-To use and get up to speed on Aurora, you should look the docs in this directory in this order:
-
-1. How to [deploy Aurora](/documentation/latest/deploying-aurora-scheduler/) or, how to [install Aurora on virtual machines on your private machine](/documentation/latest/vagrant/) (the Tutorial uses the virtual machine approach).
-2. As a user, get started quickly with a [Tutorial](/documentation/latest/tutorial/).
-3. For an overview of Aurora's process flow under the hood, see the [User Guide](/documentation/latest/user-guide/).
-4. To learn how to write a configuration file, look at our [Configuration Tutorial](/documentation/latest/configuration-tutorial/). From there, look at the [Aurora + Thermos Reference](/documentation/latest/configuration-reference/).
-5. Then read up on the [Aurora Command Line Client](/documentation/latest/client-commands/).
-6. Find out general information and useful tips about how Aurora does [Resource Isolation](/documentation/latest/resource-isolation/).
-
-To contact the Aurora Developer List, email [dev@aurora.incubator.apache.org](mailto:dev@aurora.incubator.apache.org). You may want to read the list [archives](http://mail-archives.apache.org/mod_mbox/incubator-aurora-dev/). You can also use the IRC channel `#aurora` on `irc.freenode.net`
+## Introduction
+Apache Aurora is a service scheduler that runs on top of Apache Mesos, enabling you to run long-running services that take advantage of Apache Mesos' scalability, fault-tolerance, and resource isolation. This documentation has been organized into sections with three audiences in mind:
+
+ * Users: General information about the project and to learn how to run an Aurora job.
+ * Operators: For those that wish to manage and fine-tune an Aurora cluster.
+ * Developers: All the information you need to start modifying Aurora and contributing back to the project.
+
+This documentation is a work in progress, and we encourage you to ask questions on the [Aurora developer list](http://aurora.incubator.apache.org/community/) or the `#aurora` IRC channel on `irc.freenode.net`.
+
+## Users
+ * [Install Aurora on virtual machines on your private machine](/documentation/latest/vagrant/)
+ * [Hello World Tutorial](/documentation/latest/tutorial/)
+ * [User Guide](/documentation/latest/user-guide/)
+ * [Configuration Tutorial](/documentation/latest/configuration-tutorial/)
+ * [Aurora + Thermos Reference](/documentation/latest/configuration-reference/)
+ * [Command Line Client](/documentation/latest/client-commands/)
+ * [Aurora Client v2](/documentation/latest/clientv2/)
+ * [Cron Jobs](/documentation/latest/cron-jobs/)
+
+## Operators
+ * [Deploy Aurora](/documentation/latest/deploying-aurora-scheduler/)
+ * [Monitoring](/documentation/latest/monitoring/)
+ * [Hooks for Aurora Client API](/documentation/latest/hooks/)
+ * [Scheduler Storage](/documentation/latest/storage/)
+ * [Scheduler Storage and Maintenance](/documentation/latest/storage-config/)
+ * [SLA Measurement](/documentation/latest/sla/)
+ * [Resource Isolation and Sizing](/documentation/latest/resource-isolation/)
+ * [Generating test resources](/documentation/latest/test-resource-generation/)
+
+## Developers
+ * [Contributing to the project](/documentation/latest/contributing/)
+ * [Developing the Aurora Scheduler](/documentation/latest/developing-aurora-scheduler/)
+ * [Developing the Aurora Client](/documentation/latest/developing-aurora-client/)
+ * [Committers Guide](/documentation/latest/committers/)
\ No newline at end of file
Modified: incubator/aurora/site/source/documentation/latest/client-commands.md
URL: http://svn.apache.org/viewvc/incubator/aurora/site/source/documentation/latest/client-commands.md?rev=1643588&r1=1643587&r2=1643588&view=diff
==============================================================================
--- incubator/aurora/site/source/documentation/latest/client-commands.md (original)
+++ incubator/aurora/site/source/documentation/latest/client-commands.md Sat Dec 6 19:01:40 2014
@@ -16,6 +16,7 @@ reflection.
- [Running a Command On a Running Job](#running-a-command-on-a-running-job)
- [Killing a Job](#killing-a-job)
- [Updating a Job](#updating-a-job)
+ - [Asynchronous job updates (beta)](#user-content-asynchronous-job-updates-beta)
- [Renaming a Job](#renaming-a-job)
- [Restarting Jobs](#restarting-jobs)
- [Cron Jobs](#cron-jobs)
@@ -244,6 +245,36 @@ used to define and activate hooks for `u
- `--updater_health_check_interval_seconds=HEALTH_CHECK_INTERVAL_SECONDS`
Time interval between subsequent shard status checks. Defaults to `3`.
+#### Asynchronous job updates (beta)
+
+As of 0.6.0, Aurora will coordinate updates (and rollbacks) within the
+scheduler. Performing updates this way also allows the scheduler to display
+update progress and job update history in the browser.
+
+There are several sub-commands to manage job updates:
+
+ aurora2 beta-update start <job key> <configuration file
+ aurora2 beta-update status <job key>
+ aurora2 beta-update pause <job key>
+ aurora2 beta-update resume <job key>
+ aurora2 beta-update abort <job key>
+ aurora2 beta-update list <cluster>
+
+When you `start` a job update, the command will return once it has sent the
+instructions to the scheduler. At that point, you may view detailed
+progress for the update with the `status` subcommand, in addition to viewing
+graphical progress in the web browser. You may also get a full listing of
+in-progress updates in a cluster with `list`.
+
+Once an update has been started, you can `pause` to keep the update but halt
+progress. This can be useful for doing things like debug a partially-updated
+job to determine whether you would like to proceed. You can `resume` to
+proceed.
+
+You may `abort` a job update regardless of the state it is in. This will
+instruct the scheduler to completely abandon the job update and leave the job
+in the current (possibly partially-updated) state.
+
### Renaming a Job
Renaming is a tricky operation as downstream clients must be informed of
Modified: incubator/aurora/site/source/documentation/latest/clientv2.md
URL: http://svn.apache.org/viewvc/incubator/aurora/site/source/documentation/latest/clientv2.md?rev=1643588&r1=1643587&r2=1643588&view=diff
==============================================================================
--- incubator/aurora/site/source/documentation/latest/clientv2.md (original)
+++ incubator/aurora/site/source/documentation/latest/clientv2.md Sat Dec 6 19:01:40 2014
@@ -227,7 +227,8 @@ Cron is a scheduler adjunct that periodi
schedule. The cron commands all manipulate cron schedule entries. The
schedules are specified as a part of the job configuration.
-* `aurora cron schedule jobkey config`: schedule a job to run by cron.
+* `aurora cron schedule jobkey config`: schedule a job to run by cron. If a cron job already exists
+replaces its template with a new one.
* `aurora cron deschedule jobkey`: removes a jobs entry from the cron schedule.
* `aurora cron status jobkey`: query for a scheduled job's status.
Modified: incubator/aurora/site/source/documentation/latest/cron-jobs.md
URL: http://svn.apache.org/viewvc/incubator/aurora/site/source/documentation/latest/cron-jobs.md?rev=1643588&r1=1643587&r2=1643588&view=diff
==============================================================================
--- incubator/aurora/site/source/documentation/latest/cron-jobs.md (original)
+++ incubator/aurora/site/source/documentation/latest/cron-jobs.md Sat Dec 6 19:01:40 2014
@@ -76,7 +76,8 @@ Most interaction with cron jobs takes pl
for up-to-date usage instructions.
### cron schedule
-Schedules a new cron job on the Aurora cluster for later runs, or updates an existing job.
+Schedules a new cron job on the Aurora cluster for later runs or replaces the existing cron template
+with a new one. Only future runs will be affected, any existing active tasks are left intact.
$ aurora2 cron schedule devcluster/www-data/test/cron_hello_world /vagrant/examples/jobs/cron_hello_world.aurora