How To Generate Support Bundle from Deployment Host?

Problem

How to generate support log bundle containing logs and configuration data from the Deployment Host and Deployment Unit Virtual Machine from within the Deployment Host via Airctl?

Environment

• Platform9 Edge Cloud - v5.2 and Higher

Procedure

Command

airctl gen-support-bundle

Example Help

$ airctl gen-support-bundle --help
generate support bundle

Usage:
  airctl gen-support-bundle [flags]

Flags:
      --full         retrieve full DU syslogs [large]
  -h, --help         help for gen-support-bundle
      --out string   the output file name (default "/tmp/supportbundle.tgz")
      --skip-du      skip adding du logs
      --skip-state   skip adding state information

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

Example Output

[centos@deploymenthost~]$ /opt/pf9/airctl/airctl gen-support-bundle --out /tmp/supportbundle.tgz

writing support bundle to /tmp/supportbundle.tgz
done

Once generated, the tar file can be shared with Platform9 Support by uploading it to a S3 bucket.

Command

curl -T <file name/path> https://s3-us-west-1.amazonaws.com/uploads.platform9.com/YourUserName/Zendesk-tkt-number/filename

Example

[centos@deploymenthost~]$ curl -T /tmp/supportbundle.tgz https://s3-us-west 1.amazonaws.com/uploads.platform9.com/johndoe/1345787/supportbundle.tgz

Additional Information

Important contents within the generated bundle file.

Moving the tar file to a new directory

[centos@deploymenthost tmp]$ mkdir logbundle
[centos@deploymenthost tmp]$ mv supportbundle.tgz logbundle/

[centos@deploymenthost logbundle]$ pwd
/tmp/logbundle

[centos@deploymenthost logbundle]$ ls
supportbundle.tgz

Extracting the file

[centos@deploymenthost logbundle]$ tar -xvf supportbundle.tgz
...
[centos@deploymenthost logbundle]$

[centos@deploymenthost logbundle]$ ls
DU-version.txt  home  hostagent_version.txt  hoststatus.json  supportbundle.tgz  tmp  version.txt

Sub Directories:

Airctl Logs from Deployment Host:

[centos@deploymenthost~]$ pwd
/tmp/logbundle/home/centos/airctl-logs

Airctl Configuration YAML from Deployment Host

[centos@deploymenthost~]$ pwd
/tmp/logbundle/home/centos/airctl-config.yaml

Deployment Unit VM Log Bundle tar File

[centos@deploymenthost~]$ pwd
/tmp/logbundle/tmp/du-support-tar238674157.tgz