armadactl

README

Armadactl

Armadactl is a command-line tool used for managing jobs in the Armada workload orchestration system. It provides functionality for creating, updating, and deleting jobs, as well as monitoring job status and resource usage.

Usage

Once Armadactl is successfully installed, you can use it to execute Armada subcommands by running the following command:

armadactl [subcommand] [flags]

Here are the available subcommands:

• analyze : The analyze subcommand can be used to analyze a set of manifests and provide a report on their compatibility with a given Kubernetes cluster version.

armadactl analyze [path/to/manifests] [flags]

• cancel : The cancel subcommand can be used to cancel a running Armada deployment.

armadactl cancel [deployment_name] [flags]

• create : The create subcommand can be used to create a new Armada deployment.

armadactl create [path/to/manifests] [flags]

• delete : The delete subcommand can be used to delete an existing Armada deployment.

armadactl delete [deployment_name] [flags]

• update : The update subcommand can be used to update an existing Armada deployment.

armadactl update [deployment_name] [path/to/new_manifests] [flags]

• describe : The describe subcommand can be used to get detailed information about an existing Armada deployment.

armadactl describe [deployment_name] [flags]

• kube : The kube subcommand can be used to generate a Kubernetes kubeconfig file for a specific deployment.

armadactl kube [deployment_name] [flags]

• reprioritize : The reprioritize subcommand can be used to change the priority of a running Armada deployment.

armadactl reprioritize [deployment_name] [new_priority] [flags]

• resources : The resources subcommand can be used to get information about the resources used by an Armada deployment.

armadactl resources [deployment_name] [flags]

• submit : The submit subcommand can be used to submit a set of manifests to an existing Armada deployment.

armadactl submit [deployment_name] [path/to/new_manifests] [flags]

• version : The version subcommand can be used to get the version of Armada that is currently installed.

armadactl version [flags]

• watch : The watch subcommand can be used to watch the status of an Armada deployment.

armadactl watch [deployment_name] [flags]

• queue-report : This subcommand retrieves a report of the current scheduling status of all queues in the Armada cluster.

armadactl queue-report

• job-report : This subcommand retrieves a report of the current scheduling status of all jobs in the Armada cluster.

armadactl job-report

• scheduling-report : This subcommand retrieves a report of the current scheduling status in the Armada cluster.

armadactl scheduling-report

For a full list of subcommands and options, you can run armadactl --help.