As of v0.40.0 of Troubleshoot, you can now use host collectors and analyzers in support bundles. These are useful when you need to debug a Kubernetes cluster that is offline, troubleshoot a kURL install that failed before the control plane was initialized, or if you need to collect and analyze information that isn’t available in in-cluster collectors.
Follow these steps to use host collectors and analyzers to troubleshoot a Kubernetes cluster that is down:
- If you do not have
kubectl support-bundle
plugin, install the support bundle binary on a host in the cluster you need to debug
curl -L https://github.com/replicatedhq/troubleshoot/releases/latest/download/support-bundle_linux_amd64.tar.gz | tar xzvf -
NOTE: Presently, there is no method in Troubleshoot to run host collectors on remote nodes. If you have a multi-node Kubernetes cluster, you must run the support bundle binary on each node and generate a bundle for each.
- Generate the support bundle
Using the downloaded binary
sudo ./support-bundle --interactive=false https://raw.githubusercontent.com/replicatedhq/troubleshoot-specs/main/host/default.yaml
Using kubectl plugin
sudo -E kubectl support-bundle --interactive=false https://raw.githubusercontent.com/replicatedhq/troubleshoot-specs/main/host/default.yaml
NOTE: You may need to run the above command with sudo
if your current user doesn’t have the access to gather information for a specific collector
NOTE: For airgapped installations you can download the binary and the spec, transfer them to the target host and run ./support-bundle default.yaml
Replicated maintains the troubleshoot-specs repo to aggregate useful specs for supporting your customers. If you have any suggestions for existing specs or would like to add new ones, we gladly welcome you to contribute.