acd-support-dump
Page not available in that version
The current page acd-support-dump doesn't exist in version 1.6.2 of the documentation for this product.
Synopsis
acd-support-dump [<output path>]
Description
acd-support-dump captures a point-in-time diagnostic snapshot of the cluster into one compressed tarball, for attaching to a support ticket. It is installed on every machine at /usr/local/bin/acd-support-dump, and on every server /usr/bin/acd-support-dump links to it, so sudo acd-support-dump works without changing the sudo configuration. Run it on a server, as root or with sudo. It needs no network access beyond the cluster, so it works air-gapped.
The tarball holds pod logs, cluster resources and events, node system logs, database and Longhorn health, metric history and automated triage findings. Secret values are never collected, and the collected data is redacted before the tarball is written. It does not collect database contents. See Support Dumps for the full list.
The tarball is readable by its owner only. Progress goes to standard error. The only line written to standard output is the path of the tarball written, so a script can capture it.
Arguments
| Argument | Effect |
|---|---|
<output path> | Where to write the tarball. .tar.gz is added to a path that does not end in it. A path that starts with - is taken for an option and refused: write it as ./-name. Default: support-dump-<hostname>-<UTC time>.tar.gz in the current folder, where <UTC time> looks like 20261016T120000Z. |
Environment
| Variable | Effect |
|---|---|
KUBECONFIG | The cluster credentials to use. Default: /etc/rancher/k3s/k3s.yaml. |
Files
| File | Contents |
|---|---|
/usr/share/acd/acd-support-dump.yaml | What to collect and how to redact it. Shipped with the release: do not edit. |
Exit Status
| Status | Meaning |
|---|---|
0 | The tarball was written |
2 | Invalid command line: more than one argument, or an option. acd-support-dump takes no options. |
| other non-zero | The collection failed, or the collection engine or its specification is missing |
Examples
Write the tarball to the current folder:
acd-support-dump
Write it to a chosen path:
acd-support-dump /tmp/support-dump.tar.gz
See Also
- Log Collection: when to collect, and how to share the tarball