From 620586fa73ac79950b1649f6d70ea939a6e400c7 Mon Sep 17 00:00:00 2001 From: Renan DelValle Date: Thu, 7 May 2020 15:44:27 -0700 Subject: [PATCH] Upgrading documentation automatically generated by cobra. --- docs/australis.md | 11 ++++--- docs/australis_create.md | 2 +- docs/australis_fetch.md | 2 +- docs/australis_fetch_jobs.md | 2 +- docs/australis_fetch_leader.md | 2 +- docs/australis_fetch_status.md | 2 +- docs/australis_fetch_task.md | 2 +- docs/australis_fetch_task_config.md | 2 +- docs/australis_fetch_task_status.md | 2 +- docs/australis_force.md | 2 +- docs/australis_force_backup.md | 2 +- docs/australis_force_recon.md | 2 +- docs/australis_force_recon_explicit.md | 2 +- docs/australis_force_recon_implicit.md | 2 +- docs/australis_force_snapshot.md | 2 +- docs/australis_kill.md | 3 +- docs/australis_kill_job.md | 2 +- docs/australis_monitor.md | 2 +- docs/australis_monitor_hosts.md | 2 +- docs/australis_pulse.md | 43 +++++++++++++++++++++++++ docs/australis_restart.md | 36 +++++++++++++++++++++ docs/australis_restart_job.md | 42 ++++++++++++++++++++++++ docs/australis_resume.md | 44 ++++++++++++++++++++++++++ docs/australis_rollback.md | 8 ++--- docs/australis_rollback_update.md | 8 ++--- docs/australis_set.md | 2 +- docs/australis_set_quota.md | 2 +- docs/australis_start.md | 7 ++-- docs/australis_start_drain.md | 8 +++-- docs/australis_start_maintenance.md | 8 +++-- docs/australis_start_sla-drain.md | 24 +++++++++++--- docs/australis_start_update.md | 42 ++++++++++++++++++++++++ docs/australis_stop.md | 2 +- docs/australis_stop_drain.md | 2 +- docs/australis_stop_update.md | 2 +- 35 files changed, 277 insertions(+), 51 deletions(-) create mode 100644 docs/australis_pulse.md create mode 100644 docs/australis_restart.md create mode 100644 docs/australis_restart_job.md create mode 100644 docs/australis_resume.md create mode 100644 docs/australis_start_update.md diff --git a/docs/australis.md b/docs/australis.md index c83d91a..29b1784 100644 --- a/docs/australis.md +++ b/docs/australis.md @@ -25,16 +25,17 @@ A light-weight command line client for use with Apache Aurora built using goreal ### SEE ALSO -* [australis autocomplete](australis_autocomplete.md) - Create auto completion for bash. * [australis create](australis_create.md) - Create an Aurora Job -* [australis docs](australis_docs.md) - Kill an Aurora Job * [australis fetch](australis_fetch.md) - Fetch information from Aurora * [australis force](australis_force.md) - Force the scheduler to do a snapshot, a backup, or a task reconciliation. * [australis kill](australis_kill.md) - Kill an Aurora Job * [australis monitor](australis_monitor.md) - Watch for a specific state change -* [australis rollback](australis_rollback.md) - rollback an operation such as an Update +* [australis pulse](australis_pulse.md) - Pulse a Job update +* [australis restart](australis_restart.md) - Restart an Aurora Job. +* [australis resume](australis_resume.md) - Resume a Job update +* [australis rollback](australis_rollback.md) - Rollback an operation such as an Update * [australis set](australis_set.md) - Set a value in the Aurora Scheduler. -* [australis start](australis_start.md) - Start a service, maintenance on a host (DRAIN), a snapshot, or a backup. +* [australis start](australis_start.md) - Start a service, maintenance on a host (DRAIN), a snapshot, an update, or a backup. * [australis stop](australis_stop.md) - Stop a service or maintenance on a host (DRAIN). -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_create.md b/docs/australis_create.md index b511a3f..3a605c8 100644 --- a/docs/australis_create.md +++ b/docs/australis_create.md @@ -36,4 +36,4 @@ australis create [flags] * [australis](australis.md) - australis is a client for Apache Aurora -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_fetch.md b/docs/australis_fetch.md index fa7c051..d229a42 100644 --- a/docs/australis_fetch.md +++ b/docs/australis_fetch.md @@ -36,4 +36,4 @@ Fetch information from Aurora * [australis fetch status](australis_fetch_status.md) - Fetch the maintenance status of a node from Aurora * [australis fetch task](australis_fetch_task.md) - Task information from Aurora -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_fetch_jobs.md b/docs/australis_fetch_jobs.md index e931ea3..ad9c045 100644 --- a/docs/australis_fetch_jobs.md +++ b/docs/australis_fetch_jobs.md @@ -37,4 +37,4 @@ australis fetch jobs [flags] * [australis fetch](australis_fetch.md) - Fetch information from Aurora -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_fetch_leader.md b/docs/australis_fetch_leader.md index b2d7e8f..e69dab3 100644 --- a/docs/australis_fetch_leader.md +++ b/docs/australis_fetch_leader.md @@ -38,4 +38,4 @@ australis fetch leader [zkNode0, zkNode1, ...zkNodeN] [flags] * [australis fetch](australis_fetch.md) - Fetch information from Aurora -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_fetch_status.md b/docs/australis_fetch_status.md index 443ba8c..62f944e 100644 --- a/docs/australis_fetch_status.md +++ b/docs/australis_fetch_status.md @@ -36,4 +36,4 @@ australis fetch status [flags] * [australis fetch](australis_fetch.md) - Fetch information from Aurora -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_fetch_task.md b/docs/australis_fetch_task.md index 67902b2..b902053 100644 --- a/docs/australis_fetch_task.md +++ b/docs/australis_fetch_task.md @@ -34,4 +34,4 @@ Task information from Aurora * [australis fetch task config](australis_fetch_task_config.md) - Fetch a list of task configurations from Aurora. * [australis fetch task status](australis_fetch_task_status.md) - Fetch task status for a Job key. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_fetch_task_config.md b/docs/australis_fetch_task_config.md index 41307ec..88e6c56 100644 --- a/docs/australis_fetch_task_config.md +++ b/docs/australis_fetch_task_config.md @@ -39,4 +39,4 @@ australis fetch task config [flags] * [australis fetch task](australis_fetch_task.md) - Task information from Aurora -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_fetch_task_status.md b/docs/australis_fetch_task_status.md index 2b91390..f378e3c 100644 --- a/docs/australis_fetch_task_status.md +++ b/docs/australis_fetch_task_status.md @@ -39,4 +39,4 @@ australis fetch task status [flags] * [australis fetch task](australis_fetch_task.md) - Task information from Aurora -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_force.md b/docs/australis_force.md index b6d217d..cd62da0 100644 --- a/docs/australis_force.md +++ b/docs/australis_force.md @@ -35,4 +35,4 @@ Force the scheduler to do a snapshot, a backup, or a task reconciliation. * [australis force recon](australis_force_recon.md) - Force the leading scheduler to perform a reconciliation. * [australis force snapshot](australis_force_snapshot.md) - Force the leading scheduler to perform a Snapshot. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_force_backup.md b/docs/australis_force_backup.md index a28ea3a..453c91f 100644 --- a/docs/australis_force_backup.md +++ b/docs/australis_force_backup.md @@ -37,4 +37,4 @@ australis force backup [flags] * [australis force](australis_force.md) - Force the scheduler to do a snapshot, a backup, or a task reconciliation. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_force_recon.md b/docs/australis_force_recon.md index 019fb49..17758d2 100644 --- a/docs/australis_force_recon.md +++ b/docs/australis_force_recon.md @@ -41,4 +41,4 @@ state for all currently known non-terminal tasks. * [australis force recon explicit](australis_force_recon_explicit.md) - Force the leading scheduler to perform an explicit recon. * [australis force recon implicit](australis_force_recon_implicit.md) - Force the leading scheduler to perform an implicit recon. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_force_recon_explicit.md b/docs/australis_force_recon_explicit.md index 2d537b1..802450b 100644 --- a/docs/australis_force_recon_explicit.md +++ b/docs/australis_force_recon_explicit.md @@ -38,4 +38,4 @@ australis force recon explicit [batch_size] [flags] * [australis force recon](australis_force_recon.md) - Force the leading scheduler to perform a reconciliation. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_force_recon_implicit.md b/docs/australis_force_recon_implicit.md index 4619ea9..ff30e2b 100644 --- a/docs/australis_force_recon_implicit.md +++ b/docs/australis_force_recon_implicit.md @@ -37,4 +37,4 @@ australis force recon implicit [flags] * [australis force recon](australis_force_recon.md) - Force the leading scheduler to perform a reconciliation. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_force_snapshot.md b/docs/australis_force_snapshot.md index ce8ca33..8ce8081 100644 --- a/docs/australis_force_snapshot.md +++ b/docs/australis_force_snapshot.md @@ -37,4 +37,4 @@ australis force snapshot [flags] * [australis force](australis_force.md) - Force the scheduler to do a snapshot, a backup, or a task reconciliation. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_kill.md b/docs/australis_kill.md index c12d0fc..89e914d 100644 --- a/docs/australis_kill.md +++ b/docs/australis_kill.md @@ -31,7 +31,6 @@ Kill an Aurora Job ### SEE ALSO * [australis](australis.md) - australis is a client for Apache Aurora -* [australis kill entire-cluster](australis_kill_entire-cluster.md) - Kill every task in the cluster. * [australis kill job](australis_kill_job.md) - Kill an Aurora Job -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_kill_job.md b/docs/australis_kill_job.md index 2586bd1..0a12da3 100644 --- a/docs/australis_kill_job.md +++ b/docs/australis_kill_job.md @@ -39,4 +39,4 @@ australis kill job [flags] * [australis kill](australis_kill.md) - Kill an Aurora Job -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_monitor.md b/docs/australis_monitor.md index f3d6ffd..aa77d1c 100644 --- a/docs/australis_monitor.md +++ b/docs/australis_monitor.md @@ -33,4 +33,4 @@ Watch for a specific state change * [australis](australis.md) - australis is a client for Apache Aurora * [australis monitor hosts](australis_monitor_hosts.md) - Watch a host maintenance status until it enters one of the desired statuses. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_monitor_hosts.md b/docs/australis_monitor_hosts.md index aa661ef..4dd1ded 100644 --- a/docs/australis_monitor_hosts.md +++ b/docs/australis_monitor_hosts.md @@ -40,4 +40,4 @@ australis monitor hosts [flags] * [australis monitor](australis_monitor.md) - Watch for a specific state change -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_pulse.md b/docs/australis_pulse.md new file mode 100644 index 0000000..0dc480a --- /dev/null +++ b/docs/australis_pulse.md @@ -0,0 +1,43 @@ +## australis pulse + +Pulse a Job update + +### Synopsis + +Pulse a Job update + +``` +australis pulse [flags] +``` + +### Options + +``` + -e, --environment string Aurora Environment + -h, --help help for pulse + --id string Update ID + -n, --name string Aurora Name + -r, --role string Aurora Role +``` + +### Options inherited from parent commands + +``` + -a, --caCertsPath string Path where CA certificates can be found. + -c, --clientCert string Client certificate to use to connect to Aurora. + -k, --clientKey string Client key to use to connect to Aurora. + --config string Config file to use. (default "/etc/aurora/australis.yml") + -l, --logLevel string Set logging level [panic fatal error warning info debug trace]. (default "info") + -p, --password string Password to use for API authentication + -s, --scheduler_addr string Aurora Scheduler's address. + -i, --skipCertVerification Skip CA certificate hostname verification. + --toJSON Print output in JSON format. + -u, --username string Username to use for API authentication + -z, --zookeeper string Zookeeper node(s) where Aurora stores information. (comma separated list) +``` + +### SEE ALSO + +* [australis](australis.md) - australis is a client for Apache Aurora + +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_restart.md b/docs/australis_restart.md new file mode 100644 index 0000000..79037d4 --- /dev/null +++ b/docs/australis_restart.md @@ -0,0 +1,36 @@ +## australis restart + +Restart an Aurora Job. + +### Synopsis + +Restart an Aurora Job. + +### Options + +``` + -h, --help help for restart +``` + +### Options inherited from parent commands + +``` + -a, --caCertsPath string Path where CA certificates can be found. + -c, --clientCert string Client certificate to use to connect to Aurora. + -k, --clientKey string Client key to use to connect to Aurora. + --config string Config file to use. (default "/etc/aurora/australis.yml") + -l, --logLevel string Set logging level [panic fatal error warning info debug trace]. (default "info") + -p, --password string Password to use for API authentication + -s, --scheduler_addr string Aurora Scheduler's address. + -i, --skipCertVerification Skip CA certificate hostname verification. + --toJSON Print output in JSON format. + -u, --username string Username to use for API authentication + -z, --zookeeper string Zookeeper node(s) where Aurora stores information. (comma separated list) +``` + +### SEE ALSO + +* [australis](australis.md) - australis is a client for Apache Aurora +* [australis restart job](australis_restart_job.md) - Restart a Job. + +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_restart_job.md b/docs/australis_restart_job.md new file mode 100644 index 0000000..4225b66 --- /dev/null +++ b/docs/australis_restart_job.md @@ -0,0 +1,42 @@ +## australis restart job + +Restart a Job. + +### Synopsis + +Restart a Job. + +``` +australis restart job [flags] +``` + +### Options + +``` + -e, --environment string Aurora Environment + -h, --help help for job + -n, --name string Aurora Name + -r, --role string Aurora Role +``` + +### Options inherited from parent commands + +``` + -a, --caCertsPath string Path where CA certificates can be found. + -c, --clientCert string Client certificate to use to connect to Aurora. + -k, --clientKey string Client key to use to connect to Aurora. + --config string Config file to use. (default "/etc/aurora/australis.yml") + -l, --logLevel string Set logging level [panic fatal error warning info debug trace]. (default "info") + -p, --password string Password to use for API authentication + -s, --scheduler_addr string Aurora Scheduler's address. + -i, --skipCertVerification Skip CA certificate hostname verification. + --toJSON Print output in JSON format. + -u, --username string Username to use for API authentication + -z, --zookeeper string Zookeeper node(s) where Aurora stores information. (comma separated list) +``` + +### SEE ALSO + +* [australis restart](australis_restart.md) - Restart an Aurora Job. + +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_resume.md b/docs/australis_resume.md new file mode 100644 index 0000000..f7697c4 --- /dev/null +++ b/docs/australis_resume.md @@ -0,0 +1,44 @@ +## australis resume + +Resume a Job update + +### Synopsis + +Resume a Job update + +``` +australis resume [flags] +``` + +### Options + +``` + -e, --environment string Aurora Environment + -h, --help help for resume + --id string Update ID + --message string Message to store along resume. + -n, --name string Aurora Name + -r, --role string Aurora Role +``` + +### Options inherited from parent commands + +``` + -a, --caCertsPath string Path where CA certificates can be found. + -c, --clientCert string Client certificate to use to connect to Aurora. + -k, --clientKey string Client key to use to connect to Aurora. + --config string Config file to use. (default "/etc/aurora/australis.yml") + -l, --logLevel string Set logging level [panic fatal error warning info debug trace]. (default "info") + -p, --password string Password to use for API authentication + -s, --scheduler_addr string Aurora Scheduler's address. + -i, --skipCertVerification Skip CA certificate hostname verification. + --toJSON Print output in JSON format. + -u, --username string Username to use for API authentication + -z, --zookeeper string Zookeeper node(s) where Aurora stores information. (comma separated list) +``` + +### SEE ALSO + +* [australis](australis.md) - australis is a client for Apache Aurora + +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_rollback.md b/docs/australis_rollback.md index 75c007d..7b0f871 100644 --- a/docs/australis_rollback.md +++ b/docs/australis_rollback.md @@ -1,10 +1,10 @@ ## australis rollback -rollback an operation such as an Update +Rollback an operation such as an Update ### Synopsis -rollback an operation such as an Update +Rollback an operation such as an Update ### Options @@ -31,6 +31,6 @@ rollback an operation such as an Update ### SEE ALSO * [australis](australis.md) - australis is a client for Apache Aurora -* [australis rollback update](australis_rollback_update.md) - rollback an update that is currently paused +* [australis rollback update](australis_rollback_update.md) - Rollback an update -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_rollback_update.md b/docs/australis_rollback_update.md index 17d58d6..5d798ba 100644 --- a/docs/australis_rollback_update.md +++ b/docs/australis_rollback_update.md @@ -1,10 +1,10 @@ ## australis rollback update -rollback an update that is currently paused +Rollback an update ### Synopsis -rollback an update that is currently paused +Rollback an update ``` australis rollback update [flags] @@ -39,6 +39,6 @@ australis rollback update [flags] ### SEE ALSO -* [australis rollback](australis_rollback.md) - rollback an operation such as an Update +* [australis rollback](australis_rollback.md) - Rollback an operation such as an Update -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_set.md b/docs/australis_set.md index 23d3849..6efb0b4 100644 --- a/docs/australis_set.md +++ b/docs/australis_set.md @@ -33,4 +33,4 @@ Set a value in the Aurora Scheduler. * [australis](australis.md) - australis is a client for Apache Aurora * [australis set quota](australis_set_quota.md) - Set Quota resources for a role. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_set_quota.md b/docs/australis_set_quota.md index 8837d76..555f195 100644 --- a/docs/australis_set_quota.md +++ b/docs/australis_set_quota.md @@ -36,4 +36,4 @@ australis set quota cpu: ram: disk: [flags] * [australis set](australis_set.md) - Set a value in the Aurora Scheduler. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_start.md b/docs/australis_start.md index 57c71f3..b4390c7 100644 --- a/docs/australis_start.md +++ b/docs/australis_start.md @@ -1,10 +1,10 @@ ## australis start -Start a service, maintenance on a host (DRAIN), a snapshot, or a backup. +Start a service, maintenance on a host (DRAIN), a snapshot, an update, or a backup. ### Synopsis -Start a service, maintenance on a host (DRAIN), a snapshot, or a backup. +Start a service, maintenance on a host (DRAIN), a snapshot, an update, or a backup. ### Options @@ -34,5 +34,6 @@ Start a service, maintenance on a host (DRAIN), a snapshot, or a backup. * [australis start drain](australis_start_drain.md) - Place a list of space separated Mesos Agents into draining mode. * [australis start maintenance](australis_start_maintenance.md) - Place a list of space separated Mesos Agents into maintenance mode. * [australis start sla-drain](australis_start_sla-drain.md) - Place a list of space separated Mesos Agents into maintenance mode using SLA aware strategies. +* [australis start update](australis_start_update.md) - Start an update on an Aurora long running service. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_start_drain.md b/docs/australis_start_drain.md index de39a3c..5462952 100644 --- a/docs/australis_start_drain.md +++ b/docs/australis_start_drain.md @@ -10,7 +10,7 @@ are killed and rescheduled in an Agent that is not in maintenance mode. Command expects a space separated list of hosts to place into maintenance mode. ``` -australis start drain [space separated host list] [flags] +australis start drain [space separated host list or use JSON flags] [flags] ``` ### Options @@ -18,6 +18,8 @@ australis start drain [space separated host list] [flags] ``` -h, --help help for drain --interval duration Interval at which to poll scheduler. (default 5s) + --json Read JSON list of agents from the STDIN. + --json-file string JSON file to read list of agents from. --timeout duration Time after which the monitor will stop polling and throw an error. (default 10m0s) ``` @@ -39,6 +41,6 @@ australis start drain [space separated host list] [flags] ### SEE ALSO -* [australis start](australis_start.md) - Start a service, maintenance on a host (DRAIN), a snapshot, or a backup. +* [australis start](australis_start.md) - Start a service, maintenance on a host (DRAIN), a snapshot, an update, or a backup. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_start_maintenance.md b/docs/australis_start_maintenance.md index 8baaa19..ff93667 100644 --- a/docs/australis_start_maintenance.md +++ b/docs/australis_start_maintenance.md @@ -9,7 +9,7 @@ are de-prioritized for scheduling a task. Command expects a space separated list of hosts to place into maintenance mode. ``` -australis start maintenance [space separated host list] [flags] +australis start maintenance [space separated host list or use JSON flags] [flags] ``` ### Options @@ -17,6 +17,8 @@ australis start maintenance [space separated host list] [flags] ``` -h, --help help for maintenance --interval duration Interval at which to poll scheduler. (default 5s) + --json Read JSON list of agents from the STDIN. + --json-file string JSON file to read list of agents from. --timeout duration Time after which the monitor will stop polling and throw an error. (default 10m0s) ``` @@ -38,6 +40,6 @@ australis start maintenance [space separated host list] [flags] ### SEE ALSO -* [australis start](australis_start.md) - Start a service, maintenance on a host (DRAIN), a snapshot, or a backup. +* [australis start](australis_start.md) - Start a service, maintenance on a host (DRAIN), a snapshot, an update, or a backup. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_start_sla-drain.md b/docs/australis_start_sla-drain.md index 39407db..831507d 100644 --- a/docs/australis_start_sla-drain.md +++ b/docs/australis_start_sla-drain.md @@ -8,11 +8,27 @@ Adds a Mesos Agent to Aurora's Drain list. Agents in this list are not allowed to schedule new tasks and any tasks already running on this Agent are killed and rescheduled in an Agent that is not in maintenance mode. Command expects a space separated list of hosts to place into maintenance mode. +If the --count argument is passed, tasks will be drained using the count SLA policy as a fallback +when a Job does not have a defined SLA policy. +If the --percentage argument is passed, tasks will be drained using the percentage SLA policy as a fallback +when a Job does not have a defined SLA policy. + +``` +australis start sla-drain [space separated host list or use JSON flags] [flags] +``` ### Options ``` - -h, --help help for sla-drain + --count int Instances count that should be running to meet SLA. (default 5) + --duration RUNNING Minimum time duration a task needs to be RUNNING to be treated as active. (default 1m0s) + -h, --help help for sla-drain + --interval duration Interval at which to poll scheduler. (default 10s) + --json Read JSON list of agents from the STDIN. + --json-file string JSON file to read list of agents from. + --percentage float Percentage of instances that should be running to meet SLA. (default 80) + --sla-limit duration Time limit after which SLA-Aware drain sheds SLA Awareness. (default 1h0m0s) + --timeout duration Time after which the monitor will stop polling and throw an error. (default 20m0s) ``` ### Options inherited from parent commands @@ -33,8 +49,6 @@ expects a space separated list of hosts to place into maintenance mode. ### SEE ALSO -* [australis start](australis_start.md) - Start a service, maintenance on a host (DRAIN), a snapshot, or a backup. -* [australis start sla-drain count](australis_start_sla-drain_count.md) - Place a list of space separated Mesos Agents into maintenance mode using the count SLA aware policy as a fallback. -* [australis start sla-drain percentage](australis_start_sla-drain_percentage.md) - Place a list of space separated Mesos Agents into maintenance mode using the percentage SLA aware policy as a fallback. +* [australis start](australis_start.md) - Start a service, maintenance on a host (DRAIN), a snapshot, an update, or a backup. -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_start_update.md b/docs/australis_start_update.md new file mode 100644 index 0000000..bc1f0e0 --- /dev/null +++ b/docs/australis_start_update.md @@ -0,0 +1,42 @@ +## australis start update + +Start an update on an Aurora long running service. + +### Synopsis + +Starts the update process on an Aurora long running service. If no such service exists, the update mechanism +will act as a deployment, creating all new instances based on the requirements in the update configuration. + +``` +australis start update [update config] [flags] +``` + +### Options + +``` + -h, --help help for update + --interval duration Interval at which to poll scheduler. (default 5s) + --timeout duration Time after which the monitor will stop polling and throw an error. (default 10m0s) +``` + +### Options inherited from parent commands + +``` + -a, --caCertsPath string Path where CA certificates can be found. + -c, --clientCert string Client certificate to use to connect to Aurora. + -k, --clientKey string Client key to use to connect to Aurora. + --config string Config file to use. (default "/etc/aurora/australis.yml") + -l, --logLevel string Set logging level [panic fatal error warning info debug trace]. (default "info") + -p, --password string Password to use for API authentication + -s, --scheduler_addr string Aurora Scheduler's address. + -i, --skipCertVerification Skip CA certificate hostname verification. + --toJSON Print output in JSON format. + -u, --username string Username to use for API authentication + -z, --zookeeper string Zookeeper node(s) where Aurora stores information. (comma separated list) +``` + +### SEE ALSO + +* [australis start](australis_start.md) - Start a service, maintenance on a host (DRAIN), a snapshot, an update, or a backup. + +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_stop.md b/docs/australis_stop.md index 0cd1ef1..f7f8970 100644 --- a/docs/australis_stop.md +++ b/docs/australis_stop.md @@ -34,4 +34,4 @@ Stop a service or maintenance on a host (DRAIN). * [australis stop drain](australis_stop_drain.md) - Stop maintenance on a host (move to NONE). * [australis stop update](australis_stop_update.md) - Stop update -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_stop_drain.md b/docs/australis_stop_drain.md index 129aca8..f9fb293 100644 --- a/docs/australis_stop_drain.md +++ b/docs/australis_stop_drain.md @@ -38,4 +38,4 @@ australis stop drain [space separated host list] [flags] * [australis stop](australis_stop.md) - Stop a service or maintenance on a host (DRAIN). -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020 diff --git a/docs/australis_stop_update.md b/docs/australis_stop_update.md index b3c7eca..894925b 100644 --- a/docs/australis_stop_update.md +++ b/docs/australis_stop_update.md @@ -39,4 +39,4 @@ australis stop update [update ID] [flags] * [australis stop](australis_stop.md) - Stop a service or maintenance on a host (DRAIN). -###### Auto generated by spf13/cobra on 22-Mar-2019 +###### Auto generated by spf13/cobra on 7-May-2020