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 (default true)
      --db-dump             Include a MySQL database dump in the support bundle
      --db-names string     Comma-separated list of database names to dump (optional)
      --db-regions string   Comma-separated list of regions for database dump (optional)
  -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

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

Bash

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

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

Info

By default, the support bundle collects the cluster dump and airctl logs.

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

Including MySQL Database Dumps in Support Bundles

You can include MySQL database dumps in the support bundle using the following flags.

If no region or database is specified, a complete database dump is taken by default.

• When both region and database names are specified, only the selected databases from that specific region are included.

• When only the region is specified, all databases from that region are included.

• When only database names are specified, those databases are dumped from all available regions.

Bash

--db-dump       Enable database dump inclusion  
--db-names      Comma-separated list of database names to dump  
--db-regions    Comma-separated list of regions for the database dump

Bash

export KUBECONFIG=/etc/nodelet/airctl-mgmt/certs/admin.kubeconfig
/opt/pf9/airctl/airctl gen-support-bundle  --config /opt/pf9/airctl/conf/airctl-config.yaml --db-dump

NOTE

The --db-dump flag must be enabled to include any database dumps.

This provides flexibility to collect database information at varying levels of granularity, depending on the scope of troubleshooting or recovery needs.

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.