How to Collect Diagnostic Data for Swimlane Support

Turbine

Support Bundle

A support bundle should be requested by a support engineer for initial triage. This bundle contains logs from all relevant pods, as well as other useful information from your deployment.

Using the Command Line (Online & Airgap)

Download and unarchive the latest release

curl -L https://github.com/replicatedhq/troubleshoot/releases/latest/download/support-bundle_linux_amd64.tar.gz | tar xzvf -

For airgap (offline) environments, run the above command from a host that is connected to the internet to download the plugin, then do the following:

Copy the downloaded file to your offline Swimlane server

scp support-bundle_linux_amd64.tar.gz user@<turbineDNS>:/path/to/file

Unarchive the downloaded file from the step above as follows:

tar -xzvf support-bundle_linux_amd64.tar.gz

Move the plugin to your $PATH

sudo mv ./support-bundle /usr/local/bin/kubectl-support_bundle

NOTE: If you choose not to put the plugin into your $PATH, then replace all instances of kubectl support-bundle in the remainder of this document with ./support-bundle or with the absolute path to the binary where it was unzipped.

Gather the support bundle

NOTE: Replace <namespace> with the applicable namespace (default for embedded cluster)

kubectl support-bundle --interactive=false secret/<namespace>/kotsadm-turbine-supportbundle

Alternatively, if you have an online installation, you can also generate a support bundle directly from the Turbine Admin Console under Application > Troubleshoot.

Host Collector Support Bundle

A host collector support bundle should be needed by a support engineer in the following situations:

A cluster is down

The application is not installed

The admin console is not working

To debug a host-specific performance and configuration problems even when the cluster is running

This bundle contains information gathered directly from the host, such as CPU, memory, available block devices, and more.

NOTE: Install / unarchive the latest support-bundle release before proceeding

To gather a host collector support bundle, execute the following command on each node in the cluster with elevated privileges / as root:

kubectl support-bundle --interactive=false https://raw.githubusercontent.com/replicatedhq/troubleshoot-specs/main/host/default.yaml

The resulting host collector support bundle will be available in the current working directory as support-bundle-YYYY-MM-DDTHH_mm_ss.tar.gz.

NOTE: For an air-gapped Turbine deployment, on a server with internet access, download https://raw.githubusercontent.com/replicatedhq/troubleshoot-specs/main/host/default.yaml in your browser and copy default.yaml to your Turbine server(s). Then execute the following command on each node in the cluster with elevated privileges / as root:

kubectl support-bundle --interactive=false ./default.yaml

Velero Bundle

The command below will generate a debug bundle file (bundle-<date>.tar.gz) which contains detail logs of the backup in question:

velero get backup velero debug --backup <backupname>