Airctl Reference
Airctl Overview
Airctl is Platform9's On-Prem, Kubernetes orchestrator that comprises a useful command-line utility and related functions that manages the lifecycle of the Management Server in the Platform9 management plane. Additionally, it also contains auxiliary functions like:
DNS management: A straightforward way to ensure all the other nodes can reach the temp management plane when it starts.
Image management: Populating the image cache onto various nodes to avoid image fetching when the management plane is not running. This setup includes the docker images as well as RPM packages.
State management: starts the management plane (creates and configures it first, if necessary)
Platform9 uses a mysql database. Airctl would help with the backup of that data. However, since we are only looking at a three-node cluster, the amount of backup data would be minimal.
Config File: config files describe the state of the cluster that the user wants to create and contain the pointers (ip addresses) for Kubernetes nodes and their corresponding credentials.
Other CLI utilities to help with backup and recovery of the ‘state'.
$ /opt/pf9/airctl/airctl --help
Platform9 on prem Private Cloud Director orchestrator
Usage:
airctl [command]
Available Commands:
add-region Add region to the pcd-virt management plane
advanced-du advanced command for the du configuration
advanced-hosts advanced command for the hosts configuration
artifacts manage airctl artifacts
backup backs up the the management plane's state to a tar.gz file
ce commands for community edition
check Check the pre-requisites to deploy management cluster that hosts Private Cloud Director
completion Generate the autocompletion script for the specified shell
configure generates the configuration for the management plane
configure-hosts configure the hosts
create-cluster Create a nodelet based management cluster
delete-cluster Delete a Head-less management cluster
gen-support-bundle generate support bundle
get-creds displays the admin username (email) and initial generated password
get-du-version displays the DU's release version
help Help about any command
host-status reports the statuses of all hosts
renew-certs Updates the http-wildcard-cert in kplane
reset-taskstate reset the task_state flag
restore restores the management plane from a backup
scale-cluster Scale up/down a nodelet based management cluster
scale-du Scales the DU objects up or down
set-password Sets airctl admin password
start starts the management plane (creates and configures it first if necessary)
status reports the status of the management plane
stop stops the management plane if it is running
unconfigure-du delete the management plane's configuration state
unpin removes the pinned label from container images
update-admin-password update admin password
update-dns-endpoint Update coredns endpoint
update-kubecfg Updates the kubeconfig in kplane
upgrade upgrades the management plane apps on the management cluster to the latest version
upgrade-cluster Upgrade a nodelet-based management cluster
upgrade-hosts upgrade Platform9 agent on all hosts
Flags:
--config string config file (default is $HOME/airctl-config.yaml)
-h, --help help for airctl
--json json output for commands (configure-hosts only currently)
--quiet disable spinners
--verbose print verbose logs to the console
-v, --version version for airctl
Use "airctl [command] --help" for more information about a command.Configure airctl Options
Here is an outline of the different options which can be passed using the configure flag.
Choose between a single-master or multi-master management cluster, depending on installation type (POC or production).
Last updated
Was this helpful?