Airctl Reference

Airctl

Airctl is Platform9's On-Prem, air gapped Kubernetes orchestrator that comprises a useful command-line utility and related functions that manages the lifecycle of the DDU 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'.

Airctl CLI Options

$ /opt/pf9/airctl/airctl

Usage Syntax:

airctl [command]

Available Commands:

advanced-du advanced command for the du configuration

advanced-hosts advanced command for the hosts configuration

backup backs up the the management plane's state to a tar.gz file

configure-hosts configure the hosts

configure-localhost configures the local host's qemu hook and /etc/hosts file (requires sudo)

configure-sso configure sso

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

restore restores the management plane from a backup

Host Configuration Options

Here is an outline of the different options which can be passed using the configure-hosts flag.

$ /opt/pf9/airctl/airctl configure-hosts --config

Error: flag needs an argument: --config

Usage Syntax:

airctl configure-hosts [flags]

Flags:

-h, --help help for configure-hosts

--skip-docker-img-import skip import the docker images on each hosts

--skip-docker-install skip docker install on each hosts

--skip-image-renaming skip image renaming to point to the privateRegistryBase, for e.g gcr.io/hyperkube will become <privateRegistryBase>/hyperkube

--skip-yum-repo-install skip yum repo installation, default to false

Global Flags:

--config string config file (default is $HOME/airctl-config.yaml)

--verbose print verbose logs to the console

Explanation of each Skip Flag:

--skip-docker-img-import: By default, the cache of docker images required to stand up the cluster are copied over to the hosts to pre-warm the local docker cache.

Last updated on

Was this page helpful?