Support Bundles

Support bundles is an archive generated for sole purpose of submitting information to the Platform9 support team.

The support bundle mechanism is pluggable, which renders the ability to add commands, additional logs, or other data to be easily captured during the archive process using the steps outlined below.

Management Plane

For the Management Plane (nodelet cluster), the airctl command helps to generate a support bundle:

Command

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

Bash

airctl gen-support-bundle [flags]

Flags:

--all           collect logs from all the workload hosts in the airctl config file

--cluster-dump  retrieve cluster-info dump

--host-ips      (string) collect workload 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")

Info

We support the all, cluster-dump, host-ips flags starting from 5.9.2 release.

By default, the support bundle collects relevant logs from nodes of nodelet cluster that is mentioned in bootstrapCfgPath config file.

Support bundle logs includes:

• airctl-logs: under the home directory of the designated user contains the logs for the airctl command line runs, it is useful for starting, upgrade, rollback, backup and other tasks performed using airctl on the management plane.

• dduLogs : typically the nodelet cluster's pod or container logs from the node where its is running.

• /var/log/pf9: These are the logs related to the Platform9 services running on nodelet cluster that can help debug.

Nodelet cluster logs

For sending nodelet cluster logs along with support bundle, after exporting KUBECONFIG, run

kubectl cluster-info dump --namespaces A -o yaml --output-directory=<path_provided_with_airctl>

And then tar this directory along with the support bundle.

Cluster Nodes

There are multiple troubleshooting options available when supporting remote nodes. These include using a Support Bundle or utilizing the Platform9 Advanced Remote Support option (via SSH mode).

Prerequisite:

The host must be up and running with pf9 packages installed. And the user has appropriate permissions to run the datagatherer.py script on nodes.

Generating Support Bundle From Nodes

For generating support bundle of the node that are connected or authorized to Management Plane (nodelet cluster) run the below command after login to the node:

Command

$ LD_LIBRARY_PATH="/opt/pf9/python/pf9-lib:${LD_LIBRARY_PATH}" PYTHONPATH="/opt/pf9/python/lib/python3.9:${PYTHONPATH}" 
/opt/pf9/hostagent/bin/python /opt/pf9/hostagent/lib/python3.9/site-packages/datagatherer/datagatherer.py

The above command will generate archive support bundle in /tmp/pf9-support.tgz which then can be shared uploaded to the support team for further troubleshooting.

Note:

• In this case, the support bundle gets gradually collected in /tmp. The size of the bundle file stops growing once the bundle has completely downloaded. Best effort dictates that users monitor the disk space usage while the bundle is growing or have allocated sufficient space in advance on the /tmp directory.

• After uploading the bundle to Platform9, and having received confirmation from Platform9 Support that the file has been extracted, only then should you remove the file from /tmp directory.

The node support bundle generation process captures:

1. Logs from the following location on the nodes:

   1. /etc/pf9/*

   2. /var/log/pf9/*

   3. /var/cache/pf9apps/*

   4. /etc/resolv.conf

   5. /etc/hosts

2. Output of the following commands:

   1. ps aux | grep pf9

   2. systemctl list-units --all --no-pager

   3. systemd-cgls --no-pager

   4. route -n

   5. ip a

   6. iptables --list -t nat

   7. netstat -anlp

   8. brctl show

   9. df -kh

   10. rpm -qa or dpkg -l

   11. getenforce

   12. date

   13. uptime

And more.

The size of the support bundle depends on the above content.

Info

Once the bundle is created, please contact Platform9 Support to know the procedure to upload to the support portal.

FAQ

• For General Documentation about Platform9 Managed Kubernetes, refer to Platform9 Managed Kubernetes Documentation.

• For faster resolution of issues with Platform9 Managed Kubernetes, also refer to our extensive Knowledge Base,