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'.

Airctl CLI Options

Bash

$ /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).

Bash

$ /opt/pf9/airctl/airctl configure --help
generates the configuration for the management plane, including configuration options to create the management cluster and the management plane

Usage:
  airctl configure [flags]

Flags:
  -d, --cluster-deployment-type string                              Either 'nodeletd' or 'k3s' (default "nodeletd")
  -f, --du-fqdn duFQDN                                              specify the management plane (DU) FQDN. Defaults to airctl-1.platform9.localnet
  -a, --enable-k8s                                                  set this flag to enable kubernetes (default true)
  -e, --external-ip4 ip                                             set the external IPv4 for the DU
  -x, --external-ip6 ip                                             set the external IPv6 for the DU
  -h, --help                                                        help for configure
  -4, --ipv4-enabled                                                set this flag to enable ipv4 network. To enable dual stack networks, set this flag and "ipv6-enabled"
  -6, --ipv6-enabled                                                set this flag to enable ipv6 network. To enable dual stack networks, set this flag and "ipv4-enabled"
  -c, --k3s-pod-cidr string                                         specify the pod CIDR for k3s cluster (default "10.20.0.0/16")
  -s, --k3s-service-cidr string                                     specify the service CIDR for k3s cluster (default "10.21.0.0/16")
  -i, --master-ips strings                                          a set of master node IP(s), separated by commas
  -v, --master-vip-interface string                                 specify the masterVipInterface since more than 1 master node
  -z, --master-vip-vrouterid string                                 specify the masterVipVrouterId since more than 1 master node
      --master-vip4 ip                                              the VIP of type IPv4 for management cluster
      --master-vip6 ip                                              the VIP of type IPv6 for management cluster
  -k, --nfs-ip ip                                                   set the nfs server IP for the DU
  -n, --nfs-share string                                            specify the nfs share for the DU
      --private-reg-base privateRegistryBasePath                    set the private registry base url if the registry for container images is set to "custom"
  -r, --regions string                                              specify the regions for the DU (atleast 1) (default "Region1")
      --registry-type privateRegistryType                           type of container image registry to use. Possible values: DU, custom, none. Defaults to DU
      --ssh-port int                                                specify the ssh port for nodes (default 22)
  -p, --storage-provider /opt/pf9/airctl/conf/ddu/storage/custom/   StorageProvider (Either 'hostpath-provisioner' or 'custom') (For custom, save provider specific YAMLs to /opt/pf9/airctl/conf/ddu/storage/custom/) (default "hostpath-provisioner")
  -w, --worker-ips strings                                          a set of worker node IP(s), separated by commas

Global Flags:
      --config string   config file (default is $HOME/airctl-config.yaml)
      --json            json output for commands (configure-hosts only currently)
      --quiet           disable spinners
      --verbose         print verbose logs to the console