oz0 support bundle
Usage and flags for oz0 support bundle.
For: Operators and developers looking up a command.
Write a support bundle: a tar.gz made here, from what the CLI context may read, with every secret, token, key, password and email address the redactor recognises replaced by [redacted:<kind>].
It holds:
- The versions of this CLI and of the servers.
- The CLI context (addresses and file names, never the key).
oz0 doctor(which includes management's migrations, when a cluster admin runs it; model keys are not checked).- The cluster, the nodes and their health.
- The jobs with findings and the error groups of the last --since.
- The logs given with --log (a file, or - for standard input, such as
journalctl -u orchestrator-zero --since -1d | oz0 support bundle --log -), their last 4 MiB from --since on. - With --data-dir, a server's data folder's listing (names and sizes, never what the files hold).
- The jobs named with --job, as
job exportwrites them.
What those jobs read and wrote is in it only with --content, which needs --job and the content permission and is in the audit log; the manifest says content only when an export returned some.
manifest.json lists every file with its source and checksum, what was left out and why, and how much of each kind was redacted.
Nothing is sent anywhere: read the bundle, then send it by hand. On a node, run oz0-node support bundle.
Usage
oz0 support bundle [flags]
Flags
| Flag | Type | Default | Description |
|---|---|---|---|
--config | string | the server's configuration to include, redacted: a file (an env file, a compose file, a unit) or - for standard input, such as systemctl cat orchestrator-zero (repeatable, at most 10) | |
--content | bool | include what the --job jobs read and wrote (needs --job and the content permission; audited) | |
--data-dir | string | a server's data folder, whose listing to include (names and sizes only) | |
--job | stringArray | a job to include, as job export writes it (repeatable, at most 20) | |
--log | stringArray | a log file to include, or - for standard input (repeatable, at most 10) | |
--out (-o) | string | oz0-support-<time>.tar.gz here; never an existing file | the file to write |
--since | duration | 24h0m0s | how far back logs and findings go (at most 720h) |
--tenant | string | default | tenant whose nodes, findings and jobs to include |
Inherited flags
| Flag | Type | Default | Description |
|---|---|---|---|
--context | string | $OZ0_CONTEXT or <config dir>/orchestrator-zero/context.json | CLI context file written by server init |
--log-level | string | info | log level: debug, info, warn or error |
See all oz0 commands and the global flags.