Generate Docs for Australis (#41)
Co-authored-by: Lawrence Wong <lawwong@paypal.com>
This commit is contained in:
parent
8ed6f5a773
commit
7b298f7a35
46 changed files with 455 additions and 36 deletions
|
@ -37,7 +37,8 @@ A light-weight command line client for use with Apache Aurora built using goreal
|
|||
* [australis rollback](australis_rollback.md) - Rollback an operation such as an Update
|
||||
* [australis schedule](australis_schedule.md) - Schedule a cron job on Aurora scheduler
|
||||
* [australis set](australis_set.md) - Set a value in the Aurora Scheduler.
|
||||
* [australis simulate](australis_simulate.md) - Simulate some work based on the current cluster condition, and return the output
|
||||
* [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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -38,4 +38,4 @@ australis create [flags]
|
|||
|
||||
* [australis](australis.md) - australis is a client for Apache Aurora
|
||||
|
||||
###### Auto generated by spf13/cobra on 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -32,9 +32,14 @@ Fetch information from Aurora
|
|||
### SEE ALSO
|
||||
|
||||
* [australis](australis.md) - australis is a client for Apache Aurora
|
||||
* [australis fetch capacity](australis_fetch_capacity.md) - Fetch capacity report
|
||||
* [australis fetch jobs](australis_fetch_jobs.md) - Fetch a list of task Aurora running under a role.
|
||||
* [australis fetch leader](australis_fetch_leader.md) - Fetch current Aurora leader given Zookeeper nodes.
|
||||
* [australis fetch master](australis_fetch_master.md) - Fetch current Aurora master nodes/leader given Zookeeper nodes.
|
||||
* [australis fetch mesos](australis_fetch_mesos.md) - Fetch information from Mesos.
|
||||
* [australis fetch quota](australis_fetch_quota.md) - Fetch the quotas of given roles
|
||||
* [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
|
||||
* [australis fetch tasks](australis_fetch_tasks.md) - Fetch tasks with status
|
||||
|
||||
###### Auto generated by spf13/cobra on 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
40
docs/australis_fetch_capacity.md
Normal file
40
docs/australis_fetch_capacity.md
Normal file
|
@ -0,0 +1,40 @@
|
|||
## australis fetch capacity
|
||||
|
||||
Fetch capacity report
|
||||
|
||||
### Synopsis
|
||||
|
||||
This command will show detailed capacity report of the cluster
|
||||
|
||||
```
|
||||
australis fetch capacity [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for capacity
|
||||
```
|
||||
|
||||
### 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.
|
||||
-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)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [australis fetch](australis_fetch.md) - Fetch information from Aurora
|
||||
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
|
@ -38,4 +38,4 @@ australis fetch jobs [flags]
|
|||
|
||||
* [australis fetch](australis_fetch.md) - Fetch information from Aurora
|
||||
|
||||
###### Auto generated by spf13/cobra on 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -39,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
42
docs/australis_fetch_master.md
Normal file
42
docs/australis_fetch_master.md
Normal file
|
@ -0,0 +1,42 @@
|
|||
## australis fetch master
|
||||
|
||||
Fetch current Aurora master nodes/leader given Zookeeper nodes.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Gets the current aurora master nodes/leader using information from Zookeeper path.
|
||||
Pass Zookeeper nodes separated by a space as an argument to this command.
|
||||
|
||||
```
|
||||
australis fetch master [zkNode0 zkNode1 ...zkNodeN] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for master
|
||||
--zkPath string Zookeeper node path to get master nodes/leader (default "/aurora/scheduler")
|
||||
```
|
||||
|
||||
### 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.
|
||||
-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)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [australis fetch](australis_fetch.md) - Fetch information from Aurora
|
||||
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
38
docs/australis_fetch_mesos.md
Normal file
38
docs/australis_fetch_mesos.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
## australis fetch mesos
|
||||
|
||||
Fetch information from Mesos.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Fetch information from Mesos.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for mesos
|
||||
```
|
||||
|
||||
### 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.
|
||||
-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)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [australis fetch](australis_fetch.md) - Fetch information from Aurora
|
||||
* [australis fetch mesos leader](australis_fetch_mesos_leader.md) - Fetch current Mesos-master leader given Zookeeper nodes.
|
||||
* [australis fetch mesos master](australis_fetch_mesos_master.md) - Fetch current Mesos-master nodes/leader given Zookeeper nodes.
|
||||
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
43
docs/australis_fetch_mesos_leader.md
Normal file
43
docs/australis_fetch_mesos_leader.md
Normal file
|
@ -0,0 +1,43 @@
|
|||
## australis fetch mesos leader
|
||||
|
||||
Fetch current Mesos-master leader given Zookeeper nodes.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Gets the current leading Mesos-master instance using information from Zookeeper path.
|
||||
Pass Zookeeper nodes separated by a space as an argument to this command. If no nodes are provided,
|
||||
it fetches leader from local Mesos agent or Zookeeper
|
||||
|
||||
```
|
||||
australis fetch mesos leader [zkNode0, zkNode1, ...zkNodeN] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for leader
|
||||
--zkPath string Zookeeper node path where mesos leader election happens (default "/mesos")
|
||||
```
|
||||
|
||||
### 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.
|
||||
-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)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [australis fetch mesos](australis_fetch_mesos.md) - Fetch information from Mesos.
|
||||
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
43
docs/australis_fetch_mesos_master.md
Normal file
43
docs/australis_fetch_mesos_master.md
Normal file
|
@ -0,0 +1,43 @@
|
|||
## australis fetch mesos master
|
||||
|
||||
Fetch current Mesos-master nodes/leader given Zookeeper nodes.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Gets the current Mesos-master instances using information from Zookeeper path.
|
||||
Pass Zookeeper nodes separated by a space as an argument to this command. If no nodes are provided,
|
||||
it fetches Mesos-master nodes/leader from local Mesos agent or Zookeeper
|
||||
|
||||
```
|
||||
australis fetch mesos master [zkNode0 zkNode1 ...zkNodeN] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for master
|
||||
--zkPath string Zookeeper node path to get mesos master nodes/leader (default "/mesos")
|
||||
```
|
||||
|
||||
### 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.
|
||||
-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)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [australis fetch mesos](australis_fetch_mesos.md) - Fetch information from Mesos.
|
||||
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
40
docs/australis_fetch_quota.md
Normal file
40
docs/australis_fetch_quota.md
Normal file
|
@ -0,0 +1,40 @@
|
|||
## australis fetch quota
|
||||
|
||||
Fetch the quotas of given roles
|
||||
|
||||
### Synopsis
|
||||
|
||||
This command will print list of resource quotas with the aggregated resources for the given roles
|
||||
|
||||
```
|
||||
australis fetch quota [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for quota
|
||||
```
|
||||
|
||||
### 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.
|
||||
-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)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [australis fetch](australis_fetch.md) - Fetch information from Aurora
|
||||
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
|
@ -37,4 +37,4 @@ australis fetch status [flags]
|
|||
|
||||
* [australis fetch](australis_fetch.md) - Fetch information from Aurora
|
||||
|
||||
###### Auto generated by spf13/cobra on 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -35,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -40,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -40,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
44
docs/australis_fetch_tasks.md
Normal file
44
docs/australis_fetch_tasks.md
Normal file
|
@ -0,0 +1,44 @@
|
|||
## australis fetch tasks
|
||||
|
||||
Fetch tasks with status
|
||||
|
||||
### Synopsis
|
||||
|
||||
This command will return the list of tasks with a given status
|
||||
|
||||
```
|
||||
australis fetch tasks [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-e, --environment string Aurora Environment
|
||||
-h, --help help for tasks
|
||||
-n, --name string Aurora Name
|
||||
-r, --role string Aurora Role
|
||||
-x, --status string Task Status
|
||||
```
|
||||
|
||||
### 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.
|
||||
-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)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [australis fetch](australis_fetch.md) - Fetch information from Aurora
|
||||
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
|
@ -36,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -38,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -42,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -39,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -38,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -38,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -33,5 +33,6 @@ 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
|
||||
* [australis kill tasks](australis_kill_tasks.md) - Kill Aurora Tasks
|
||||
|
||||
###### Auto generated by spf13/cobra on 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -41,4 +41,4 @@ australis kill job [flags]
|
|||
|
||||
* [australis kill](australis_kill.md) - Kill an Aurora Job
|
||||
|
||||
###### Auto generated by spf13/cobra on 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
45
docs/australis_kill_tasks.md
Normal file
45
docs/australis_kill_tasks.md
Normal file
|
@ -0,0 +1,45 @@
|
|||
## australis kill tasks
|
||||
|
||||
Kill Aurora Tasks
|
||||
|
||||
### Synopsis
|
||||
|
||||
Kill Aurora Tasks
|
||||
|
||||
```
|
||||
australis kill tasks [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-e, --environment string Aurora Environment
|
||||
-h, --help help for tasks
|
||||
-I, --instances string Instances e.g. 1, 2, 5
|
||||
-m, --monitor monitor the result after sending the command (default true)
|
||||
-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.
|
||||
-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)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [australis kill](australis_kill.md) - Kill an Aurora Job
|
||||
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
|
@ -34,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -41,4 +41,4 @@ australis pulse [flags]
|
|||
|
||||
* [australis](australis.md) - australis is a client for Apache Aurora
|
||||
|
||||
###### Auto generated by spf13/cobra on 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -34,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -40,4 +40,4 @@ australis restart job [flags]
|
|||
|
||||
* [australis restart](australis_restart.md) - Restart an Aurora Job.
|
||||
|
||||
###### Auto generated by spf13/cobra on 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -42,4 +42,4 @@ australis resume [flags]
|
|||
|
||||
* [australis](australis.md) - australis is a client for Apache Aurora
|
||||
|
||||
###### Auto generated by spf13/cobra on 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -34,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -42,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -37,4 +37,4 @@ australis schedule [flags]
|
|||
|
||||
* [australis](australis.md) - australis is a client for Apache Aurora
|
||||
|
||||
###### Auto generated by spf13/cobra on 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -34,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -37,4 +37,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
37
docs/australis_simulate.md
Normal file
37
docs/australis_simulate.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
## australis simulate
|
||||
|
||||
Simulate some work based on the current cluster condition, and return the output
|
||||
|
||||
### Synopsis
|
||||
|
||||
Simulate some work based on the current cluster condition, and return the output
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for simulate
|
||||
```
|
||||
|
||||
### 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.
|
||||
-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)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [australis](australis.md) - australis is a client for Apache Aurora
|
||||
* [australis simulate fit](australis_simulate_fit.md) - Compute how many tasks can we fit to a cluster
|
||||
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
40
docs/australis_simulate_fit.md
Normal file
40
docs/australis_simulate_fit.md
Normal file
|
@ -0,0 +1,40 @@
|
|||
## australis simulate fit
|
||||
|
||||
Compute how many tasks can we fit to a cluster
|
||||
|
||||
### Synopsis
|
||||
|
||||
Compute how many tasks can we fit to a cluster
|
||||
|
||||
```
|
||||
australis simulate fit [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for fit
|
||||
```
|
||||
|
||||
### 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.
|
||||
-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)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [australis simulate](australis_simulate.md) - Simulate some work based on the current cluster condition, and return the output
|
||||
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
|
@ -37,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -35,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
|
@ -40,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 5-Nov-2020
|
||||
###### Auto generated by spf13/cobra on 8-Sep-2022
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue