australis/README.md

42 lines
1.3 KiB
Markdown
Raw Normal View History

2017-12-03 12:49:06 -08:00
# Australis
A light-weight client for [Apache Aurora](https://aurora.apache.org/) built using [gorealis](https://github.com/paypal/gorealis).
## Usage
```
Usage:
australis [command]
Available Commands:
create Create an Aurora Job
fetch Fetch information from Aurora
2017-12-03 12:49:06 -08:00
help Help about any command
kill Kill an Aurora Job
start Start a service or maintenance on a host (DRAIN).
stop Stop a service or maintenance on a host (DRAIN).
Flags:
-h, --help help for australis
-p, --password string Password to use for API authentication
-s, --scheduler_addr string Aurora Scheduler's address.
-u, --username string Username to use for API authentication
-z, --zookeeper string Zookeeper node(s) where Aurora stores information.
2017-12-03 12:49:06 -08:00
Use "australis [command] --help" for more information about a command.
```
2018-04-29 18:56:13 -04:00
## Sample commands:
### Fetching current leader
`australis fetch leader [ZK NODE 1] [ZK NODE 2]...[ZK NODE N]`
### Setting host to DRAIN:
`australis start drain [HOST 1] [HOST 2]...[HOST N]`
### Taking hosts out of DRAIN (End maintenance):
`australis stop drain [HOST 1] [HOST 2]...[HOST N]`
2017-12-03 12:49:06 -08:00
## Status
Australis is a work in progress and does not support all the features of Apache Aurora.