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
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
|
Loading…
Add table
Add a link
Reference in a new issue