aurora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dles...@apache.org
Subject svn commit: r1661840 - in /incubator/aurora/site: publish/documentation/latest/client-commands/ publish/documentation/latest/configuration-reference/ source/documentation/latest/
Date Tue, 24 Feb 2015 05:20:12 GMT
Author: dlester
Date: Tue Feb 24 05:20:11 2015
New Revision: 1661840

URL: http://svn.apache.org/r1661840
Log:
Updates Aurora documentation.

Modified:
    incubator/aurora/site/publish/documentation/latest/client-commands/index.html
    incubator/aurora/site/publish/documentation/latest/configuration-reference/index.html
    incubator/aurora/site/source/documentation/latest/client-commands.md
    incubator/aurora/site/source/documentation/latest/configuration-reference.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=1661840&r1=1661839&r2=1661840&view=diff
==============================================================================
--- incubator/aurora/site/publish/documentation/latest/client-commands/index.html (original)
+++ incubator/aurora/site/publish/documentation/latest/client-commands/index.html Tue Feb
24 05:20:11 2015
@@ -55,7 +55,11 @@
 <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>
+<li><a href="#user-content-asynchronous-job-updates-beta">Asynchronous job updates
(beta)</a>
+
+<ul>
+<li><a href="#user-content-coordinated-job-updates-beta">Coordinated job updates
(beta)</a></li>
+</ul></li>
 </ul></li>
 <li><a href="#renaming-a-job">Renaming a Job</a></li>
 <li><a href="#restarting-jobs">Restarting Jobs</a></li>
@@ -232,7 +236,7 @@ used to define and activate hooks for <c
 
 <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
+<p>As of 0.6.0, Aurora will control and dispatch 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>
 
@@ -259,6 +263,27 @@ proceed.</p>
 instruct the scheduler to completely abandon the job update and leave the job
 in the current (possibly partially-updated) state.</p>
 
+<h5 id="coordinated-job-updates-(beta)">Coordinated job updates (beta)</h5>
+
+<p>Some Aurora services may benefit from having more control over the
+<a href="#user-content-asynchronous-job-updates-beta">asynchronous scheduler updater</a>
by explicitly
+acknowledging (&ldquo;heartbeating&rdquo;) job update progress. This may be helpful
for mission-critical
+service updates where explicit job health monitoring is vital during the entire job update
+lifecycle. Such job updates would rely on an external service (or a custom client) periodically
+pulsing an active coordinated job update via a
+<a href="../api/src/main/thrift/org/apache/aurora/gen/api.thrift">pulseJobUpdate RPC</a>.</p>
+
+<p>A coordinated update is defined by setting a positive
+<a href="configuration-reference.md#updateconfig-objects">pulse<em>interval</em>secs</a>
value in job configuration
+file. If no pulses are received within specified interval the update will be blocked. A blocked
+update is unable to continue rolling forward (or rolling back) but retains its active status.
+It may only be unblocked by a fresh <code>pulseJobUpdate</code> call.</p>
+
+<p>NOTE: A coordinated update starts in <code>ROLL_FORWARD_AWAITING_PULSE</code>
state and will not make any
+progress until the first pulse arrives. However, a paused update (<code>ROLL_FORWARD_PAUSED</code>
or
+<code>ROLL_BACK_PAUSED</code>) is still considered active and upon resuming will
immediately make progress
+provided the pulse interval has not expired.</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/configuration-reference/index.html
URL: http://svn.apache.org/viewvc/incubator/aurora/site/publish/documentation/latest/configuration-reference/index.html?rev=1661840&r1=1661839&r2=1661840&view=diff
==============================================================================
--- incubator/aurora/site/publish/documentation/latest/configuration-reference/index.html
(original)
+++ incubator/aurora/site/publish/documentation/latest/configuration-reference/index.html
Tue Feb 24 05:20:11 2015
@@ -599,6 +599,21 @@ either due to human error or machine fai
 <td style="text-align: center">Integer</td>
 <td>Maximum number of shard failures to be tolerated in total during an update. Cannot
be greater than or equal to the total number of tasks in a job. (Default: 0)</td>
 </tr>
+<tr>
+<td><code>rollback_on_failure</code></td>
+<td style="text-align: center">boolean</td>
+<td>When False, prevents auto rollback of a failed update (Default: True)</td>
+</tr>
+<tr>
+<td><code>wait_for_batch_completion</code></td>
+<td style="text-align: center">boolean</td>
+<td>When True, all threads from a given batch will be blocked from picking up new instances
until the entire batch is updated. This essentially simulates the legacy sequential updater
algorithm. (Default: False)</td>
+</tr>
+<tr>
+<td><code>pulse_interval_secs</code></td>
+<td style="text-align: center">Integer</td>
+<td>Indicates a <a href="client-commands.md#user-content-coordinated-job-updates-beta">coordinated
update</a>. If no pulses are received within the provided interval the update will be
blocked. Beta-updater only. Will fail on submission when used with client updater. (Default:
None)</td>
+</tr>
 </tbody></table>
 
 <h3 id="healthcheckconfig-objects">HealthCheckConfig Objects</h3>

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=1661840&r1=1661839&r2=1661840&view=diff
==============================================================================
--- incubator/aurora/site/source/documentation/latest/client-commands.md (original)
+++ incubator/aurora/site/source/documentation/latest/client-commands.md Tue Feb 24 05:20:11
2015
@@ -11,6 +11,7 @@ Aurora Client Commands
     - [Killing a Job](#killing-a-job)
     - [Updating a Job](#updating-a-job)
         - [Asynchronous job updates (beta)](#user-content-asynchronous-job-updates-beta)
+            - [Coordinated job updates (beta)](#user-content-coordinated-job-updates-beta)
     - [Renaming a Job](#renaming-a-job)
     - [Restarting Jobs](#restarting-jobs)
 - [Cron Jobs](#cron-jobs)
@@ -194,7 +195,7 @@ used to define and activate hooks for `j
 
 #### Asynchronous job updates (beta)
 
-As of 0.6.0, Aurora will coordinate updates (and rollbacks) within the
+As of 0.6.0, Aurora will control and dispatch 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.
 
@@ -222,6 +223,27 @@ You may `abort` a job update regardless
 instruct the scheduler to completely abandon the job update and leave the job
 in the current (possibly partially-updated) state.
 
+##### Coordinated job updates (beta)
+
+Some Aurora services may benefit from having more control over the
+[asynchronous scheduler updater](#user-content-asynchronous-job-updates-beta) by explicitly
+acknowledging ("heartbeating") job update progress. This may be helpful for mission-critical
+service updates where explicit job health monitoring is vital during the entire job update
+lifecycle. Such job updates would rely on an external service (or a custom client) periodically
+pulsing an active coordinated job update via a
+[pulseJobUpdate RPC](../api/src/main/thrift/org/apache/aurora/gen/api.thrift).
+
+A coordinated update is defined by setting a positive
+[pulse_interval_secs](configuration-reference.md#updateconfig-objects) value in job configuration
+file. If no pulses are received within specified interval the update will be blocked. A blocked
+update is unable to continue rolling forward (or rolling back) but retains its active status.
+It may only be unblocked by a fresh `pulseJobUpdate` call.
+
+NOTE: A coordinated update starts in `ROLL_FORWARD_AWAITING_PULSE` state and will not make
any
+progress until the first pulse arrives. However, a paused update (`ROLL_FORWARD_PAUSED` or
+`ROLL_BACK_PAUSED`) is still considered active and upon resuming will immediately make progress
+provided the pulse interval has not expired.
+
 ### Renaming a Job
 
 Renaming is a tricky operation as downstream clients must be informed of

Modified: incubator/aurora/site/source/documentation/latest/configuration-reference.md
URL: http://svn.apache.org/viewvc/incubator/aurora/site/source/documentation/latest/configuration-reference.md?rev=1661840&r1=1661839&r2=1661840&view=diff
==============================================================================
--- incubator/aurora/site/source/documentation/latest/configuration-reference.md (original)
+++ incubator/aurora/site/source/documentation/latest/configuration-reference.md Tue Feb 24
05:20:11 2015
@@ -347,6 +347,9 @@ Parameters for controlling the rate and
 | ```watch_secs```             | Integer  | Minimum number of seconds a shard must remain
in ```RUNNING``` state before considered a success (Default: 45)
 | ```max_per_shard_failures``` | Integer  | Maximum number of restarts per shard during update.
Increments total failure count when this limit is exceeded. (Default: 0)
 | ```max_total_failures```     | Integer  | Maximum number of shard failures to be tolerated
in total during an update. Cannot be greater than or equal to the total number of tasks in
a job. (Default: 0)
+| ```rollback_on_failure```    | boolean  | When False, prevents auto rollback of a failed
update (Default: True)
+| ```wait_for_batch_completion```| boolean | When True, all threads from a given batch will
be blocked from picking up new instances until the entire batch is updated. This essentially
simulates the legacy sequential updater algorithm. (Default: False)
+| ```pulse_interval_secs```    | Integer  |  Indicates a [coordinated update](client-commands.md#user-content-coordinated-job-updates-beta).
If no pulses are received within the provided interval the update will be blocked. Beta-updater
only. Will fail on submission when used with client updater. (Default: None)
 
 ### HealthCheckConfig Objects
 



Mime
View raw message