From 7b298f7a357bae7f466096e452be5f78e8db5405 Mon Sep 17 00:00:00 2001 From: lawwong1 <105893156+lawwong1@users.noreply.github.com> Date: Fri, 9 Sep 2022 09:07:39 -0700 Subject: [PATCH] Generate Docs for Australis (#41) Co-authored-by: Lawrence Wong --- docs/australis.md | 3 +- docs/australis_create.md | 2 +- docs/australis_fetch.md | 7 +++- docs/australis_fetch_capacity.md | 40 +++++++++++++++++++++++ docs/australis_fetch_jobs.md | 2 +- docs/australis_fetch_leader.md | 2 +- docs/australis_fetch_master.md | 42 ++++++++++++++++++++++++ docs/australis_fetch_mesos.md | 38 ++++++++++++++++++++++ docs/australis_fetch_mesos_leader.md | 43 ++++++++++++++++++++++++ docs/australis_fetch_mesos_master.md | 43 ++++++++++++++++++++++++ docs/australis_fetch_quota.md | 40 +++++++++++++++++++++++ docs/australis_fetch_status.md | 2 +- docs/australis_fetch_task.md | 2 +- docs/australis_fetch_task_config.md | 2 +- docs/australis_fetch_task_status.md | 2 +- docs/australis_fetch_tasks.md | 44 +++++++++++++++++++++++++ docs/australis_force.md | 2 +- docs/australis_force_backup.md | 2 +- docs/australis_force_recon.md | 2 +- docs/australis_force_recon_explicit.md | 2 +- docs/australis_force_recon_implicit.md | 2 +- docs/australis_force_snapshot.md | 2 +- docs/australis_kill.md | 3 +- docs/australis_kill_job.md | 2 +- docs/australis_kill_tasks.md | 45 ++++++++++++++++++++++++++ docs/australis_monitor.md | 2 +- docs/australis_monitor_hosts.md | 2 +- docs/australis_pulse.md | 2 +- docs/australis_restart.md | 2 +- docs/australis_restart_job.md | 2 +- docs/australis_resume.md | 2 +- docs/australis_rollback.md | 2 +- docs/australis_rollback_update.md | 2 +- docs/australis_schedule.md | 2 +- docs/australis_set.md | 2 +- docs/australis_set_quota.md | 2 +- docs/australis_simulate.md | 37 +++++++++++++++++++++ docs/australis_simulate_fit.md | 40 +++++++++++++++++++++++ docs/australis_start.md | 2 +- docs/australis_start_drain.md | 2 +- docs/australis_start_maintenance.md | 2 +- docs/australis_start_sla-drain.md | 2 +- docs/australis_start_update.md | 2 +- docs/australis_stop.md | 2 +- docs/australis_stop_drain.md | 2 +- docs/australis_stop_update.md | 2 +- 46 files changed, 455 insertions(+), 36 deletions(-) create mode 100644 docs/australis_fetch_capacity.md create mode 100644 docs/australis_fetch_master.md create mode 100644 docs/australis_fetch_mesos.md create mode 100644 docs/australis_fetch_mesos_leader.md create mode 100644 docs/australis_fetch_mesos_master.md create mode 100644 docs/australis_fetch_quota.md create mode 100644 docs/australis_fetch_tasks.md create mode 100644 docs/australis_kill_tasks.md create mode 100644 docs/australis_simulate.md create mode 100644 docs/australis_simulate_fit.md diff --git a/docs/australis.md b/docs/australis.md index 352c6f6..4c257ec 100644 --- a/docs/australis.md +++ b/docs/australis.md @@ -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 diff --git a/docs/australis_create.md b/docs/australis_create.md index 8069bc2..dc01c77 100644 --- a/docs/australis_create.md +++ b/docs/australis_create.md @@ -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 diff --git a/docs/australis_fetch.md b/docs/australis_fetch.md index 2f365c8..8853103 100644 --- a/docs/australis_fetch.md +++ b/docs/australis_fetch.md @@ -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 diff --git a/docs/australis_fetch_capacity.md b/docs/australis_fetch_capacity.md new file mode 100644 index 0000000..d26f37c --- /dev/null +++ b/docs/australis_fetch_capacity.md @@ -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 diff --git a/docs/australis_fetch_jobs.md b/docs/australis_fetch_jobs.md index 2f2dc6c..a150ae4 100644 --- a/docs/australis_fetch_jobs.md +++ b/docs/australis_fetch_jobs.md @@ -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 diff --git a/docs/australis_fetch_leader.md b/docs/australis_fetch_leader.md index dd99c47..0a326b8 100644 --- a/docs/australis_fetch_leader.md +++ b/docs/australis_fetch_leader.md @@ -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 diff --git a/docs/australis_fetch_master.md b/docs/australis_fetch_master.md new file mode 100644 index 0000000..9f8da1c --- /dev/null +++ b/docs/australis_fetch_master.md @@ -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 diff --git a/docs/australis_fetch_mesos.md b/docs/australis_fetch_mesos.md new file mode 100644 index 0000000..3926905 --- /dev/null +++ b/docs/australis_fetch_mesos.md @@ -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 diff --git a/docs/australis_fetch_mesos_leader.md b/docs/australis_fetch_mesos_leader.md new file mode 100644 index 0000000..c6557b9 --- /dev/null +++ b/docs/australis_fetch_mesos_leader.md @@ -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 diff --git a/docs/australis_fetch_mesos_master.md b/docs/australis_fetch_mesos_master.md new file mode 100644 index 0000000..7f35c9a --- /dev/null +++ b/docs/australis_fetch_mesos_master.md @@ -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 diff --git a/docs/australis_fetch_quota.md b/docs/australis_fetch_quota.md new file mode 100644 index 0000000..d3583ff --- /dev/null +++ b/docs/australis_fetch_quota.md @@ -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 diff --git a/docs/australis_fetch_status.md b/docs/australis_fetch_status.md index 373ceaa..a80cacf 100644 --- a/docs/australis_fetch_status.md +++ b/docs/australis_fetch_status.md @@ -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 diff --git a/docs/australis_fetch_task.md b/docs/australis_fetch_task.md index 70fff8e..b6ce7c2 100644 --- a/docs/australis_fetch_task.md +++ b/docs/australis_fetch_task.md @@ -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 diff --git a/docs/australis_fetch_task_config.md b/docs/australis_fetch_task_config.md index 6dae394..23b1005 100644 --- a/docs/australis_fetch_task_config.md +++ b/docs/australis_fetch_task_config.md @@ -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 diff --git a/docs/australis_fetch_task_status.md b/docs/australis_fetch_task_status.md index 5cbdf79..bd44edf 100644 --- a/docs/australis_fetch_task_status.md +++ b/docs/australis_fetch_task_status.md @@ -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 diff --git a/docs/australis_fetch_tasks.md b/docs/australis_fetch_tasks.md new file mode 100644 index 0000000..71dd4a8 --- /dev/null +++ b/docs/australis_fetch_tasks.md @@ -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 diff --git a/docs/australis_force.md b/docs/australis_force.md index 6aaccb3..420123d 100644 --- a/docs/australis_force.md +++ b/docs/australis_force.md @@ -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 diff --git a/docs/australis_force_backup.md b/docs/australis_force_backup.md index 1fd0a74..81ce196 100644 --- a/docs/australis_force_backup.md +++ b/docs/australis_force_backup.md @@ -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 diff --git a/docs/australis_force_recon.md b/docs/australis_force_recon.md index 9907fed..b470706 100644 --- a/docs/australis_force_recon.md +++ b/docs/australis_force_recon.md @@ -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 diff --git a/docs/australis_force_recon_explicit.md b/docs/australis_force_recon_explicit.md index 113316c..cbc1be8 100644 --- a/docs/australis_force_recon_explicit.md +++ b/docs/australis_force_recon_explicit.md @@ -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 diff --git a/docs/australis_force_recon_implicit.md b/docs/australis_force_recon_implicit.md index 932f390..e5b1159 100644 --- a/docs/australis_force_recon_implicit.md +++ b/docs/australis_force_recon_implicit.md @@ -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 diff --git a/docs/australis_force_snapshot.md b/docs/australis_force_snapshot.md index f6207a3..1e89739 100644 --- a/docs/australis_force_snapshot.md +++ b/docs/australis_force_snapshot.md @@ -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 diff --git a/docs/australis_kill.md b/docs/australis_kill.md index 69403b7..0398dac 100644 --- a/docs/australis_kill.md +++ b/docs/australis_kill.md @@ -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 diff --git a/docs/australis_kill_job.md b/docs/australis_kill_job.md index 56446f3..4ca1e6e 100644 --- a/docs/australis_kill_job.md +++ b/docs/australis_kill_job.md @@ -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 diff --git a/docs/australis_kill_tasks.md b/docs/australis_kill_tasks.md new file mode 100644 index 0000000..274ad4d --- /dev/null +++ b/docs/australis_kill_tasks.md @@ -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 diff --git a/docs/australis_monitor.md b/docs/australis_monitor.md index 59ba91a..50fea35 100644 --- a/docs/australis_monitor.md +++ b/docs/australis_monitor.md @@ -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 diff --git a/docs/australis_monitor_hosts.md b/docs/australis_monitor_hosts.md index 508fb68..8264253 100644 --- a/docs/australis_monitor_hosts.md +++ b/docs/australis_monitor_hosts.md @@ -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 diff --git a/docs/australis_pulse.md b/docs/australis_pulse.md index 904e253..a152e9b 100644 --- a/docs/australis_pulse.md +++ b/docs/australis_pulse.md @@ -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 diff --git a/docs/australis_restart.md b/docs/australis_restart.md index 6b1aa9f..81ea511 100644 --- a/docs/australis_restart.md +++ b/docs/australis_restart.md @@ -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 diff --git a/docs/australis_restart_job.md b/docs/australis_restart_job.md index 219c3c2..83be678 100644 --- a/docs/australis_restart_job.md +++ b/docs/australis_restart_job.md @@ -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 diff --git a/docs/australis_resume.md b/docs/australis_resume.md index cd9b899..8a63327 100644 --- a/docs/australis_resume.md +++ b/docs/australis_resume.md @@ -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 diff --git a/docs/australis_rollback.md b/docs/australis_rollback.md index 3c6fc7d..e6a2da9 100644 --- a/docs/australis_rollback.md +++ b/docs/australis_rollback.md @@ -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 diff --git a/docs/australis_rollback_update.md b/docs/australis_rollback_update.md index 5e45946..e4dedee 100644 --- a/docs/australis_rollback_update.md +++ b/docs/australis_rollback_update.md @@ -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 diff --git a/docs/australis_schedule.md b/docs/australis_schedule.md index ff97b70..7e139ba 100644 --- a/docs/australis_schedule.md +++ b/docs/australis_schedule.md @@ -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 diff --git a/docs/australis_set.md b/docs/australis_set.md index 6973c69..f462012 100644 --- a/docs/australis_set.md +++ b/docs/australis_set.md @@ -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 diff --git a/docs/australis_set_quota.md b/docs/australis_set_quota.md index 3e29bb3..cf28a6b 100644 --- a/docs/australis_set_quota.md +++ b/docs/australis_set_quota.md @@ -37,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 5-Nov-2020 +###### Auto generated by spf13/cobra on 8-Sep-2022 diff --git a/docs/australis_simulate.md b/docs/australis_simulate.md new file mode 100644 index 0000000..33de188 --- /dev/null +++ b/docs/australis_simulate.md @@ -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 diff --git a/docs/australis_simulate_fit.md b/docs/australis_simulate_fit.md new file mode 100644 index 0000000..384c96d --- /dev/null +++ b/docs/australis_simulate_fit.md @@ -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 diff --git a/docs/australis_start.md b/docs/australis_start.md index 9a8a8dd..1ca4b1a 100644 --- a/docs/australis_start.md +++ b/docs/australis_start.md @@ -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 diff --git a/docs/australis_start_drain.md b/docs/australis_start_drain.md index 2073cd4..bd16f94 100644 --- a/docs/australis_start_drain.md +++ b/docs/australis_start_drain.md @@ -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 diff --git a/docs/australis_start_maintenance.md b/docs/australis_start_maintenance.md index 51db1de..78b88da 100644 --- a/docs/australis_start_maintenance.md +++ b/docs/australis_start_maintenance.md @@ -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 diff --git a/docs/australis_start_sla-drain.md b/docs/australis_start_sla-drain.md index 3c0263d..cafc961 100644 --- a/docs/australis_start_sla-drain.md +++ b/docs/australis_start_sla-drain.md @@ -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 diff --git a/docs/australis_start_update.md b/docs/australis_start_update.md index 1bf29cb..4bd89f0 100644 --- a/docs/australis_start_update.md +++ b/docs/australis_start_update.md @@ -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 diff --git a/docs/australis_stop.md b/docs/australis_stop.md index 6ea3a5e..eb0c92f 100644 --- a/docs/australis_stop.md +++ b/docs/australis_stop.md @@ -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 diff --git a/docs/australis_stop_drain.md b/docs/australis_stop_drain.md index 705e07c..9a4ea99 100644 --- a/docs/australis_stop_drain.md +++ b/docs/australis_stop_drain.md @@ -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 diff --git a/docs/australis_stop_update.md b/docs/australis_stop_update.md index f597259..faa7be9 100644 --- a/docs/australis_stop_update.md +++ b/docs/australis_stop_update.md @@ -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