The page details how to generate a support bundle for both the Appian operator and any sites managed by the operator. When possible, the decision to generate a support bundle should be made in consultation with Appian Support.
A support bundle is an archive containing information gathered from a self-managed customer's Kubernetes cluster that can be analyzed to troubleshoot issues with either the Appian operator or sites in that cluster. The information collected and analyzed includes but is not limited to:
Note: The support bundle will not contain any data from Secrets; it will contain information on whether certain Secrets exist with certain keys. Data from specific ConfigMaps will be collected and included in the support bundle.
Generation of a support bundle is handled by a kubectl plugin. The plugin runs entirely on the client side, meaning nothing is installed to the Kubernetes cluster. This means the plugin must be installed by the user generating the support bundle.
The easiest way to install the plugin is via Krew. Start by installing Krew.
Once Krew has been installed you can install the support-bundle plugin:
1
kubectl krew install support-bundle
Unarchive the downloaded file and move it to somewhere on your PATH. The file must be named kubectl-support_bundle after being moved as well as being executable. For example, assuming $HOME/bin is on your PATH:
1
2
3
tar -xzvf collect_linux_arm64.tar.gz collect
mv collect $HOME/bin/kubectl-support_bundle
chmod 700 $HOME/bin/kubectl-support_bundle
Generating a support bundle for either the Appian operator or a site simply involves running the plugin.
Assuming you installed the operator to the appian-operator namespace:
1
kubectl support-bundle --namespace appian-operator --load-cluster-specs --output appian-operator-$(date +%Y%m%d%H%M%S)
This will generate a file named something similar to appian-operator-20230725120000.tar.gz.
The following example assumes your site is running in the namespace my-site-namespace. Adjust the --namespace flag to use your actual site namespace.
1
kubectl support-bundle --namespace my-site-namespace --load-cluster-specs --output my-site-$(date +%Y%m%d%H%M%S)
This will generate a file named something similar to my-site-20230725120000.tar.gz.
Some of the data collected by the support-bundle plugin is automatically redacted. Sensitive information like passwords will be redacted during generation of the support bundle.
Caution: The redaction process is thorough but it can miss sensitive information. It is the customer's responsibility to review the data contained in the generated support bundle, particularly logs, and perform any additional redaction before sending the support bundle to Appian.
When a support bundle is generated some checks for common problems are run and the results are displayed. Depending on the issue you might be able to resolve it.
