From be6c458f232b37c7b2419c5bf596ccbbc766b592 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A1n=20I=2E=20Del=20Valle?= Date: Thu, 5 Nov 2020 15:46:07 -0800 Subject: [PATCH] Documentation update (#17) * Updates documentation automatically generated by Cobra. Deletes some old, outdated documentation. --- docs/australis.md | 3 +- docs/australis_create.md | 6 ++- docs/australis_fetch.md | 3 +- docs/australis_fetch_jobs.md | 3 +- docs/australis_fetch_leader.md | 3 +- docs/australis_fetch_status.md | 3 +- docs/australis_fetch_task.md | 3 +- docs/australis_fetch_task_config.md | 3 +- docs/australis_fetch_task_status.md | 3 +- docs/australis_force.md | 3 +- docs/australis_force_backup.md | 3 +- docs/australis_force_recon.md | 3 +- docs/australis_force_recon_explicit.md | 3 +- docs/australis_force_recon_implicit.md | 3 +- docs/australis_force_snapshot.md | 3 +- docs/australis_kill.md | 3 +- docs/australis_kill_entire-cluster.md | 39 ----------------- docs/australis_kill_job.md | 4 +- docs/australis_monitor.md | 3 +- docs/australis_monitor_hosts.md | 4 +- docs/australis_pulse.md | 3 +- docs/australis_restart.md | 3 +- docs/australis_restart_job.md | 3 +- docs/australis_resume.md | 3 +- docs/australis_rollback.md | 3 +- docs/australis_rollback_update.md | 3 +- docs/australis_schedule.md | 3 +- docs/australis_set.md | 3 +- docs/australis_set_quota.md | 3 +- docs/australis_start.md | 3 +- docs/australis_start_drain.md | 4 +- docs/australis_start_maintenance.md | 4 +- docs/australis_start_sla-drain.md | 4 +- docs/australis_start_sla-drain_count.md | 45 -------------------- docs/australis_start_sla-drain_percentage.md | 45 -------------------- docs/australis_start_update.md | 4 +- docs/australis_stop.md | 3 +- docs/australis_stop_drain.md | 4 +- docs/australis_stop_update.md | 3 +- 39 files changed, 75 insertions(+), 172 deletions(-) delete mode 100644 docs/australis_kill_entire-cluster.md delete mode 100644 docs/australis_start_sla-drain_count.md delete mode 100644 docs/australis_start_sla-drain_percentage.md diff --git a/docs/australis.md b/docs/australis.md index 1374c86..352c6f6 100644 --- a/docs/australis.md +++ b/docs/australis.md @@ -18,6 +18,7 @@ A light-weight command line client for use with Apache Aurora built using goreal -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -39,4 +40,4 @@ A light-weight command line client for use with Apache Aurora built using goreal * [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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_create.md b/docs/australis_create.md index 3a605c8..8069bc2 100644 --- a/docs/australis_create.md +++ b/docs/australis_create.md @@ -13,7 +13,8 @@ australis create [flags] ### Options ``` - -h, --help help for create + -h, --help help for create + -m, --monitor monitor the result after sending the command (default true) ``` ### Options inherited from parent commands @@ -27,6 +28,7 @@ australis create [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -36,4 +38,4 @@ australis create [flags] * [australis](australis.md) - australis is a client for Apache Aurora -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_fetch.md b/docs/australis_fetch.md index d229a42..2f365c8 100644 --- a/docs/australis_fetch.md +++ b/docs/australis_fetch.md @@ -23,6 +23,7 @@ Fetch information from Aurora -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -36,4 +37,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_fetch_jobs.md b/docs/australis_fetch_jobs.md index ad9c045..2f2dc6c 100644 --- a/docs/australis_fetch_jobs.md +++ b/docs/australis_fetch_jobs.md @@ -28,6 +28,7 @@ australis fetch jobs [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -37,4 +38,4 @@ australis fetch jobs [flags] * [australis fetch](australis_fetch.md) - Fetch information from Aurora -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_fetch_leader.md b/docs/australis_fetch_leader.md index e69dab3..dd99c47 100644 --- a/docs/australis_fetch_leader.md +++ b/docs/australis_fetch_leader.md @@ -29,6 +29,7 @@ australis fetch leader [zkNode0, zkNode1, ...zkNodeN] [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -38,4 +39,4 @@ australis fetch leader [zkNode0, zkNode1, ...zkNodeN] [flags] * [australis fetch](australis_fetch.md) - Fetch information from Aurora -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_fetch_status.md b/docs/australis_fetch_status.md index 62f944e..373ceaa 100644 --- a/docs/australis_fetch_status.md +++ b/docs/australis_fetch_status.md @@ -27,6 +27,7 @@ australis fetch status [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -36,4 +37,4 @@ australis fetch status [flags] * [australis fetch](australis_fetch.md) - Fetch information from Aurora -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_fetch_task.md b/docs/australis_fetch_task.md index b902053..70fff8e 100644 --- a/docs/australis_fetch_task.md +++ b/docs/australis_fetch_task.md @@ -23,6 +23,7 @@ Task information from Aurora -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -34,4 +35,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_fetch_task_config.md b/docs/australis_fetch_task_config.md index 88e6c56..6dae394 100644 --- a/docs/australis_fetch_task_config.md +++ b/docs/australis_fetch_task_config.md @@ -30,6 +30,7 @@ australis fetch task config [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -39,4 +40,4 @@ australis fetch task config [flags] * [australis fetch task](australis_fetch_task.md) - Task information from Aurora -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_fetch_task_status.md b/docs/australis_fetch_task_status.md index f378e3c..5cbdf79 100644 --- a/docs/australis_fetch_task_status.md +++ b/docs/australis_fetch_task_status.md @@ -30,6 +30,7 @@ australis fetch task status [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -39,4 +40,4 @@ australis fetch task status [flags] * [australis fetch task](australis_fetch_task.md) - Task information from Aurora -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_force.md b/docs/australis_force.md index cd62da0..6aaccb3 100644 --- a/docs/australis_force.md +++ b/docs/australis_force.md @@ -23,6 +23,7 @@ Force the scheduler to do a snapshot, a backup, or a task reconciliation. -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -35,4 +36,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_force_backup.md b/docs/australis_force_backup.md index 453c91f..1fd0a74 100644 --- a/docs/australis_force_backup.md +++ b/docs/australis_force_backup.md @@ -28,6 +28,7 @@ australis force backup [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -37,4 +38,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_force_recon.md b/docs/australis_force_recon.md index 17758d2..9907fed 100644 --- a/docs/australis_force_recon.md +++ b/docs/australis_force_recon.md @@ -30,6 +30,7 @@ state for all currently known non-terminal tasks. -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -41,4 +42,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_force_recon_explicit.md b/docs/australis_force_recon_explicit.md index 802450b..113316c 100644 --- a/docs/australis_force_recon_explicit.md +++ b/docs/australis_force_recon_explicit.md @@ -29,6 +29,7 @@ australis force recon explicit [batch_size] [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -38,4 +39,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_force_recon_implicit.md b/docs/australis_force_recon_implicit.md index ff30e2b..932f390 100644 --- a/docs/australis_force_recon_implicit.md +++ b/docs/australis_force_recon_implicit.md @@ -28,6 +28,7 @@ australis force recon implicit [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -37,4 +38,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_force_snapshot.md b/docs/australis_force_snapshot.md index 8ce8081..f6207a3 100644 --- a/docs/australis_force_snapshot.md +++ b/docs/australis_force_snapshot.md @@ -28,6 +28,7 @@ australis force snapshot [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -37,4 +38,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_kill.md b/docs/australis_kill.md index 89e914d..69403b7 100644 --- a/docs/australis_kill.md +++ b/docs/australis_kill.md @@ -23,6 +23,7 @@ Kill an Aurora Job -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -33,4 +34,4 @@ Kill an Aurora Job * [australis](australis.md) - australis is a client for Apache Aurora * [australis kill job](australis_kill_job.md) - Kill an Aurora Job -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_kill_entire-cluster.md b/docs/australis_kill_entire-cluster.md deleted file mode 100644 index 5d8585d..0000000 --- a/docs/australis_kill_entire-cluster.md +++ /dev/null @@ -1,39 +0,0 @@ -## australis kill entire-cluster - -Kill every task in the cluster. - -### Synopsis - -To be written. - -``` -australis kill entire-cluster [flags] -``` - -### Options - -``` - -h, --help help for entire-cluster -``` - -### 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 kill](australis_kill.md) - Kill an Aurora Job - -###### Auto generated by spf13/cobra on 22-Mar-2019 diff --git a/docs/australis_kill_job.md b/docs/australis_kill_job.md index 0a12da3..56446f3 100644 --- a/docs/australis_kill_job.md +++ b/docs/australis_kill_job.md @@ -15,6 +15,7 @@ australis kill job [flags] ``` -e, --environment string Aurora Environment -h, --help help for job + -m, --monitor monitor the result after sending the command (default true) -n, --name string Aurora Name -r, --role string Aurora Role ``` @@ -30,6 +31,7 @@ australis kill job [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -39,4 +41,4 @@ australis kill job [flags] * [australis kill](australis_kill.md) - Kill an Aurora Job -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_monitor.md b/docs/australis_monitor.md index aa77d1c..59ba91a 100644 --- a/docs/australis_monitor.md +++ b/docs/australis_monitor.md @@ -23,6 +23,7 @@ Watch for a specific state change -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -33,4 +34,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_monitor_hosts.md b/docs/australis_monitor_hosts.md index 4dd1ded..508fb68 100644 --- a/docs/australis_monitor_hosts.md +++ b/docs/australis_monitor_hosts.md @@ -17,7 +17,6 @@ australis monitor hosts [flags] -h, --help help for hosts --interval duration Interval at which to poll scheduler. (default 5s) --statuses strings List of acceptable statuses for a host to be in. (case-insensitive) [NONE, SCHEDULED, DRAINED, DRAINING] (default [DRAINED]) - --timeout duration Time after which the monitor will stop polling and throw an error. (default 10m0s) ``` ### Options inherited from parent commands @@ -31,6 +30,7 @@ australis monitor hosts [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_pulse.md b/docs/australis_pulse.md index 0dc480a..904e253 100644 --- a/docs/australis_pulse.md +++ b/docs/australis_pulse.md @@ -31,6 +31,7 @@ australis pulse [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -40,4 +41,4 @@ australis pulse [flags] * [australis](australis.md) - australis is a client for Apache Aurora -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_restart.md b/docs/australis_restart.md index 79037d4..6b1aa9f 100644 --- a/docs/australis_restart.md +++ b/docs/australis_restart.md @@ -23,6 +23,7 @@ Restart an Aurora Job. -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -33,4 +34,4 @@ Restart an Aurora Job. * [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 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_restart_job.md b/docs/australis_restart_job.md index 4225b66..219c3c2 100644 --- a/docs/australis_restart_job.md +++ b/docs/australis_restart_job.md @@ -30,6 +30,7 @@ australis restart job [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -39,4 +40,4 @@ australis restart job [flags] * [australis restart](australis_restart.md) - Restart an Aurora Job. -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_resume.md b/docs/australis_resume.md index f7697c4..cd9b899 100644 --- a/docs/australis_resume.md +++ b/docs/australis_resume.md @@ -32,6 +32,7 @@ australis resume [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -41,4 +42,4 @@ australis resume [flags] * [australis](australis.md) - australis is a client for Apache Aurora -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_rollback.md b/docs/australis_rollback.md index 7b0f871..3c6fc7d 100644 --- a/docs/australis_rollback.md +++ b/docs/australis_rollback.md @@ -23,6 +23,7 @@ Rollback an operation such as an Update -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -33,4 +34,4 @@ Rollback an operation such as an Update * [australis](australis.md) - australis is a client for Apache Aurora * [australis rollback update](australis_rollback_update.md) - Rollback an update -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_rollback_update.md b/docs/australis_rollback_update.md index 5d798ba..5e45946 100644 --- a/docs/australis_rollback_update.md +++ b/docs/australis_rollback_update.md @@ -32,6 +32,7 @@ australis rollback update [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -41,4 +42,4 @@ australis rollback update [flags] * [australis rollback](australis_rollback.md) - Rollback an operation such as an Update -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_schedule.md b/docs/australis_schedule.md index 0218243..ff97b70 100644 --- a/docs/australis_schedule.md +++ b/docs/australis_schedule.md @@ -27,6 +27,7 @@ australis schedule [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -36,4 +37,4 @@ australis schedule [flags] * [australis](australis.md) - australis is a client for Apache Aurora -###### Auto generated by spf13/cobra on 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_set.md b/docs/australis_set.md index 6efb0b4..6973c69 100644 --- a/docs/australis_set.md +++ b/docs/australis_set.md @@ -23,6 +23,7 @@ Set a value in the Aurora Scheduler. -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -33,4 +34,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_set_quota.md b/docs/australis_set_quota.md index 555f195..3e29bb3 100644 --- a/docs/australis_set_quota.md +++ b/docs/australis_set_quota.md @@ -27,6 +27,7 @@ australis set quota cpu: ram: disk: [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -36,4 +37,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_start.md b/docs/australis_start.md index b4390c7..9a8a8dd 100644 --- a/docs/australis_start.md +++ b/docs/australis_start.md @@ -23,6 +23,7 @@ Start a service, maintenance on a host (DRAIN), a snapshot, an update, or a back -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -36,4 +37,4 @@ Start a service, maintenance on a host (DRAIN), a snapshot, an update, or a back * [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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_start_drain.md b/docs/australis_start_drain.md index 5462952..2073cd4 100644 --- a/docs/australis_start_drain.md +++ b/docs/australis_start_drain.md @@ -20,7 +20,6 @@ australis start drain [space separated host list or use JSON flags] [flags] --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) ``` ### Options inherited from parent commands @@ -34,6 +33,7 @@ australis start drain [space separated host list or use JSON flags] [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -43,4 +43,4 @@ australis start drain [space separated host list or use JSON flags] [flags] * [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 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_start_maintenance.md b/docs/australis_start_maintenance.md index ff93667..51db1de 100644 --- a/docs/australis_start_maintenance.md +++ b/docs/australis_start_maintenance.md @@ -19,7 +19,6 @@ australis start maintenance [space separated host list or use JSON flags] [flags --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) ``` ### Options inherited from parent commands @@ -33,6 +32,7 @@ australis start maintenance [space separated host list or use JSON flags] [flags -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -42,4 +42,4 @@ australis start maintenance [space separated host list or use JSON flags] [flags * [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 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_start_sla-drain.md b/docs/australis_start_sla-drain.md index 831507d..3c0263d 100644 --- a/docs/australis_start_sla-drain.md +++ b/docs/australis_start_sla-drain.md @@ -28,7 +28,6 @@ australis start sla-drain [space separated host list or use JSON flags] [flags] --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 @@ -42,6 +41,7 @@ australis start sla-drain [space separated host list or use JSON flags] [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -51,4 +51,4 @@ australis start sla-drain [space separated host list or use JSON flags] [flags] * [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 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_start_sla-drain_count.md b/docs/australis_start_sla-drain_count.md deleted file mode 100644 index 457d559..0000000 --- a/docs/australis_start_sla-drain_count.md +++ /dev/null @@ -1,45 +0,0 @@ -## australis start sla-drain count - -Place a list of space separated Mesos Agents into maintenance mode using the count SLA aware policy as a fallback. - -### Synopsis - -Adds a Mesos Agent to Aurora's Drain list. Tasks will be drained using the count SLA policy as a fallback -when a Job does not have a defined SLA policy. - -``` -australis start sla-drain count [space separated host list] [flags] -``` - -### Options - -``` - --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 45s) - -h, --help help for count - --interval duration Interval at which to poll scheduler. (default 10s) - --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 - -``` - -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 sla-drain](australis_start_sla-drain.md) - Place a list of space separated Mesos Agents into maintenance mode using SLA aware strategies. - -###### Auto generated by spf13/cobra on 22-Mar-2019 diff --git a/docs/australis_start_sla-drain_percentage.md b/docs/australis_start_sla-drain_percentage.md deleted file mode 100644 index d431564..0000000 --- a/docs/australis_start_sla-drain_percentage.md +++ /dev/null @@ -1,45 +0,0 @@ -## australis start sla-drain percentage - -Place a list of space separated Mesos Agents into maintenance mode using the percentage SLA aware policy as a fallback. - -### Synopsis - -Adds a Mesos Agent to Aurora's Drain list. 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 percentage [space separated host list] [flags] -``` - -### Options - -``` - --duration RUNNING Minimum time duration a task needs to be RUNNING to be treated as active. (default 45s) - -h, --help help for percentage - --interval duration Interval at which to poll scheduler. (default 10s) - --percent float Percentage of instances that should be running to meet SLA. (default 75) - --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 - -``` - -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 sla-drain](australis_start_sla-drain.md) - Place a list of space separated Mesos Agents into maintenance mode using SLA aware strategies. - -###### Auto generated by spf13/cobra on 22-Mar-2019 diff --git a/docs/australis_start_update.md b/docs/australis_start_update.md index bc1f0e0..1bf29cb 100644 --- a/docs/australis_start_update.md +++ b/docs/australis_start_update.md @@ -16,7 +16,6 @@ australis start update [update config] [flags] ``` -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 @@ -30,6 +29,7 @@ australis start update [update config] [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -39,4 +39,4 @@ australis start update [update config] [flags] * [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 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_stop.md b/docs/australis_stop.md index f7f8970..6ea3a5e 100644 --- a/docs/australis_stop.md +++ b/docs/australis_stop.md @@ -23,6 +23,7 @@ Stop a service or maintenance on a host (DRAIN). -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -34,4 +35,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_stop_drain.md b/docs/australis_stop_drain.md index f9fb293..705e07c 100644 --- a/docs/australis_stop_drain.md +++ b/docs/australis_stop_drain.md @@ -15,7 +15,6 @@ australis stop drain [space separated host list] [flags] ``` -h, --help help for drain --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 1m0s) ``` ### Options inherited from parent commands @@ -29,6 +28,7 @@ australis stop drain [space separated host list] [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020 diff --git a/docs/australis_stop_update.md b/docs/australis_stop_update.md index 894925b..f597259 100644 --- a/docs/australis_stop_update.md +++ b/docs/australis_stop_update.md @@ -30,6 +30,7 @@ australis stop update [update ID] [flags] -p, --password string Password to use for API authentication -s, --scheduler_addr string Aurora Scheduler's address. -i, --skipCertVerification Skip CA certificate hostname verification. + -t, --timeout duration Gorealis timeout. (default 20s) --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) @@ -39,4 +40,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 7-May-2020 +###### Auto generated by spf13/cobra on 5-Nov-2020