Airctl Support Bundle

A support bundle is a comprehensive archive created specifically for the purpose of submitting pertinent information to the Platform9 support team.

The support bundle mechanism is designed to be pluggable, allowing for the easy addition of commands, extra logs, or other relevant data to be captured during the archiving process. The steps outlined below will guide you through this procedure.

Management Plane

For the Management Plane (nodelet cluster), the command airctl gen-support-bundle is instrumental in generating a comprehensive support bundle. This bundle contains crucial diagnostic information that can be utilized for troubleshooting and support purposes.

Options specific to the gen-support-bundle command are:

Bash

Usage:
  airctl gen-support-bundle [flags]

Flags:
      --all               collect logs from all the hosts in the airctl config file
      --cluster-dump      retrieve cluster-info dump
      --cluster-state     Get cluster state (default true)
  -h, --help              help for gen-support-bundle
      --host-ips string   collect host side logs. Enter unique host ip's in comma-separated format.                           Example: "10.128.243.113, 10.128.242.112"
      --out string        the output file name (default "/tmp/supportbundle.tgz")

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

Info

This process will collect logs from all nodes within the management plane cluster, ensuring comprehensive data retrieval for analysis and troubleshooting.

airctl gen-support-bundle command should be executed from a Management plane host

To generate the support bundle, you can use the following command:

Bash

$ sudo /opt/pf9/airctl/airctl gen-support-bundle --config /opt/pf9/airctl/conf/airctl-config.yaml

By default, the archived contents will be located in the file /tmp/supportbundle.tgz. You can share this archived file with the Platform9 support team for further assistance.

To specify a custom path for the archived support bundle, utilize the --out option. This allows you to define the exact location where the support bundle will be saved, ensuring that it is easily accessible for future reference or analysis.

Bash

$ sudo /opt/pf9/airctl/airctl gen-support-bundle --out <PATH_NAME>.tgz --config /opt/pf9/airctl/conf/airctl-config.yaml

By default, the support bundle collects essential logs from the nodes of the management plane cluster specified in the bootstrapCfgPath configuration file.

Support bundle logs includes:

• dduLogs : The management plane cluster's (Kubernetes control plane) service logs from the pod/container on the node it's running.

• /var/log/pf9: Logs related to the Platform9 services and Kubernetes control plane services running on management plane cluster.

• Kubectl get [pods|nodes|events]

Info

-- cluster-dump option is not functional at the moment.

If the Platform9 support team requests the entire management plane cluster logs, including logs from management plane components, along with the support bundle, please follow the steps below after exporting the KUBECONFIG:

$ kubectl cluster-info dump --all-namespaces --output-directory=/path/to/dump

Cluster Dump a set of namespaces

$ kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/dump

Next, compress this directory along with the support bundle into a tar archive.

Host Support Bundle

Generate a support bundle for hosts that are connected or authorized to the Management Plane, which we need to troubleshoot the hosts in case of any issues.

Steps for collecting the support bundle from hosts are outlined here: Hosts Support Bundle.