Support bundle

A support bundle is one archive of the platform's state. RigFabTech support reads it instead of asking for access to your servers.

rft collects it with troubleshoot.sh and masks secrets before it writes the archive.

Before you begin

• troubleshoot.sh's support-bundle, for example as the kubectl plugin: kubectl krew install support-bundle.
• kubectl pointed at the cluster.

Collect the bundle

rft support-bundle

It writes the archive in this directory and prints Wrote rft-support-bundle-<time>.tar.gz.

Check what's in it

Open the archive and check that it holds nothing you won't share.

Upload it

On portal.rigfab.com, go to Support and upload it with your request's subject as the reference. Don't email it.

What it holds

• The Kubernetes version, the nodes, and cluster-wide resources such as CRDs and volumes.
• The resources and events of rft-system and of every product's namespace.
• Each pod's log in those namespaces from the last 72 hours, at most 10,000 lines and 5 MB per container.
• The Helm releases in those namespaces, without their values.
• The licence agent's state and the rft version, under rft/.
• The analysis. A failure that has an entry in the failure catalog starts with its id, such as the ids in Troubleshooting.

What it leaves out

• It never puts the values of Secrets in the archive.
• It masks passwords, tokens, licence keys, private keys and connection strings in everything else. See redaction.
• It collects in a directory beside the archive, then removes that directory.
• It sends nothing anywhere.

How long RigFabTech keeps it

RigFabTech deletes a bundle 90 days after the request it came with is resolved, and never more than 180 days after you upload it. To have it deleted sooner, ask support.

Without rft

The spec lives in the Secret rft-system/rft-support-bundle. The support-bundle kubectl plugin collects the same bundle of rft-system from it, without rft/ and the products' namespaces:

kubectl support-bundle --load-cluster-specs