Collect Support Bundles for Edge Cluster Troubleshooting
When deploying or operating Edge clusters, you may encounter issues that require assistance from the Spectro Cloud
support team, such as Edge hosts failing to register, pod failures, or provisioning errors. To help our team
troubleshoot these issues more effectively, follow this guide to collect support bundles and attach them to your support
ticket. Use the support-bundle-edge.sh script that collects host-level diagnostics from an Edge node and, if
available, includes Kubernetes data accessible locally on that host.
Limitations
- The embedded
support-bundle-edge.shscript is included with the version of Palette agent that was in use at the time of provisioning. It is updated only when Palette agent is upgraded through an ISO or a Palette update. To ensure you are using the most current version, download and run the script manually.
Prerequisites
- You are connected to the host you want to troubleshoot using SSH (Secure Shell), remote shell, direct terminal access, or another connection method.
- The following tools are available on the host:
journalctlsystemctl
- You have root privileges to run the
support-bundle-edge.shscript.
Run the Script to Collect Edge Host Logs
Follow the steps below on every Edge host you want to troubleshoot.
-
(Optional) Set the path to your
kubeconfigfile.Templateexport KUBECONFIG=<path-to-kubeconfig>Exampleexport KUBECONFIG=/etc/kubernetes/admin.confIf you do not perform this step, the script defaults to using
/run/kubeconfigif it exists. If no validkubeconfigis available, the script still runs but collects only host-level diagnostics. -
- Downloaded Scripts
- Embedded Script
Download the
support-bundle-edge.shscript and run it as a user with root privileges.curl --remote-name https://software.spectrocloud.com/scripts/support-bundle-edge.sh
sudo bash support-bundle-edge.shThe host you need to troubleshoot must have an active internet connection to download the troubleshooting script. If internet access is not available, download the script on another machine and transfer it to the host.
Run the
support-bundle-edge.shscript as a user with root privileges.sudo bash /opt/spectrocloud/scripts/support-bundle-edge.shThe table below contains the optional flags you can use when running the script.
Longhand Flags Shorthand Flags Description Example --directory-dCustom output directory for temporary files and the final archive. -d /var/tmp--start-days-ago-sNumber of days in the past to start collecting journald logs from. -s 7--end-days-ago-eNumber of days before now to stop collecting journald logs. The value must be smaller than -s.-e 5--start-date-SStart date for journald log collection. -S 2024-01-01--end-date-EEnd date for journald log collection. Must be later than -S.-E 2024-01-06--lines-lNumber of log lines to collect from journald logs. -l 500000--namespaces-nAdditional namespaces to collect logs from. By default, the script collects the logs from the following namespaces: capi-webhook-system,cert-manager,harbor,kube-system,kube-public,longhorn-system,os-patch,palette-system,reach-system,spectro-system, andsystem-upgrade.-n hello-universe,hello-world--resources-namespaced-rAdditional namespace-scoped resources to collect. By default, the script collects the following namespace-scoped resources: apiservices,configmaps,cronjobs,daemonsets,deployments,endpoints,endpointslices,events,hpa,ingress,jobs,leases,limitranges,networkpolicies,poddisruptionbudgets,pods,pvc,replicasets,resourcequotas,roles,rolebindings,services,serviceaccounts, andstatefulsets.-r certificates.cert-manager.io--resources-cluster-scoped-RAdditional cluster-scoped resources to collect. By default, the script collects the following cluster-scoped resources: apiservices,clusterroles,clusterrolebindings,crds,csr,mutatingwebhookconfigurations,namespaces,nodes,priorityclasses,pv,storageclasses,validatingwebhookconfigurations, andvolumeattachments.-R clusterissuers.cert-manager.io--journald-services-jBy default, the script includes the following journald services: stylus-agent,stylus-operator,palette-tui,spectro-stylus-agent,spectro-stylus-operator,spectro-init,spectro-palette-agent-start,spectro-palette-agent-initramfs,spectro-palette-agent-boot,spectro-palette-agent-network,spectro-palette-agent-bootstrap,systemd-timesyncd,containerd,kubelet,k3s,k3s-agent,rke2-server,rke2-agent, andcos-setup-boot.-j cloud-init,systemd-resolvedinfoThe default values for flags may change. Refer to the script for the most accurate information. For example, you can display the script content in the terminal with the following command.
cat support-bundle-infra.shIf the script runs successfully, it creates a file in the directory specified by the
--directoryflag. If you do not specify--directory, the script saves the file in the system's temporary directory (typically/tmp). The file name follows the pattern<hostname>-<YYYY-MM-DD>_<HH_MM_SS>.tar.gz. One of the messages the terminal displays contains the created file's name and its path.Example outputLogs are archived in /tmp/tmp.qrKKeY1LqA/edge-e965384209c2d45078a29480e90bd275-2025-05-13_16_58_20.tar.gzinfoThe script collects only Helm release secrets from Spectro Cloud namespaces and excludes other Kubernetes secrets to protect sensitive data.
-
Copy the file to your local computer. Run the command on the machine to which you want to copy the file.
Templatescp <user>@<host-ip-address>:<path-to-file> <local-destination-directory>The command below serves as an example of how to copy the file
edge-e965384209c2d45078a29480e90bd275-2025-05-13_16_58_20.tar.gzfrom thekairos@10.10.150.150host to yourDownloadsfolder.Examplescp kairos@10.10.150.150:/tmp/tmp.qrKKeY1LqA/edge-e965384209c2d45078a29480e90bd275-2025-05-13_16_58_20.tar.gz ~/Downloads/
Validate
Review the file you copied. The script archives the collected logs into compressed tarballs TAR.GAR.
Extract the file named in the format <hostname>-<YYYY-MM-DD>_<HH_MM_SS>.tar.gz and ensure it contains the following:
console.logfilehelmfolderjournaldfoldernetworkingfolderoemfolderrunfoldersysteminfofolderusrfoldervarfolder
Next Steps
After you have successfully collected the support bundle, attach the TAR.GAR archive to the support ticket.