ridv/australis
1
0
Fork 0
Code Issues Pull requests Projects Releases 16 Packages Wiki Activity Actions

Upgrading documentation automatically generated by cobra.

Browse source
This commit is contained in:
Renan DelValle 2020-05-07 15:44:27 -07:00
parent 4806936c71
commit 620586fa73
No known key found for this signature in database
GPG key ID: C240AD6D6F443EC9
35 changed files with 277 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/australis.md
View file

@ -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

2
docs/australis_create.md
View file

@ -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

2
docs/australis_fetch.md
View file

@ -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

2
docs/australis_fetch_jobs.md
View file

@ -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

2
docs/australis_fetch_leader.md
View file

@ -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

2
docs/australis_fetch_status.md
View file

@ -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

2
docs/australis_fetch_task.md
View file

@ -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

2
docs/australis_fetch_task_config.md
View file

@ -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

2
docs/australis_fetch_task_status.md
View file

@ -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

2
docs/australis_force.md
View file

@ -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

2
docs/australis_force_backup.md
View file

@ -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

2
docs/australis_force_recon.md
View file

@ -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

2
docs/australis_force_recon_explicit.md
View file

@ -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

2
docs/australis_force_recon_implicit.md
View file

@ -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

2
docs/australis_force_snapshot.md
View file

@ -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

3
docs/australis_kill.md
View file

@ -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

2
docs/australis_kill_job.md
View file

@ -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

2
docs/australis_monitor.md
View file

@ -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

2
docs/australis_monitor_hosts.md
View file

@ -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

43
docs/australis_pulse.md Normal file
View file

@ -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

36
docs/australis_restart.md Normal file
View file

@ -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

42
docs/australis_restart_job.md Normal file
View file

@ -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

44
docs/australis_resume.md Normal file
View file

@ -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

8
docs/australis_rollback.md
View file

@ -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

8
docs/australis_rollback_update.md
View file

@ -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

2
docs/australis_set.md
View file

@ -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

2
docs/australis_set_quota.md
View file

@ -36,4 +36,4 @@ australis set quota <role> cpu:<value> ram:<value> disk:<value> [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

7
docs/australis_start.md
View file

@ -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

8
docs/australis_start_drain.md
View file

@ -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

8
docs/australis_start_maintenance.md
View file

@ -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

24
docs/australis_start_sla-drain.md
View file

@ -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

42
docs/australis_start_update.md Normal file
View file

@ -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

2
docs/australis_stop.md
View file

@ -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

2
docs/australis_stop_drain.md
View file

@ -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

2
docs/australis_stop_update.md
View file

@ -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