aurora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wfar...@apache.org
Subject incubator-aurora git commit: Add documentation for the beta-update command.
Date Wed, 12 Nov 2014 21:05:11 GMT
Repository: incubator-aurora
Updated Branches:
  refs/heads/master 16489f1b6 -> ea439998d


Add documentation for the beta-update command.

Bugs closed: AURORA-763

Reviewed at https://reviews.apache.org/r/27089/


Project: http://git-wip-us.apache.org/repos/asf/incubator-aurora/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-aurora/commit/ea439998
Tree: http://git-wip-us.apache.org/repos/asf/incubator-aurora/tree/ea439998
Diff: http://git-wip-us.apache.org/repos/asf/incubator-aurora/diff/ea439998

Branch: refs/heads/master
Commit: ea439998dac5d83869363054ce0817317f50ceba
Parents: 16489f1
Author: Bill Farner <wfarner@apache.org>
Authored: Wed Nov 12 13:04:49 2014 -0800
Committer: Bill Farner <wfarner@apache.org>
Committed: Wed Nov 12 13:04:49 2014 -0800

----------------------------------------------------------------------
 docs/client-commands.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-aurora/blob/ea439998/docs/client-commands.md
----------------------------------------------------------------------
diff --git a/docs/client-commands.md b/docs/client-commands.md
index d8e8aac..6c929c1 100644
--- a/docs/client-commands.md
+++ b/docs/client-commands.md
@@ -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 `update`.
 - `--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


Mime
View raw message