-
Notifications
You must be signed in to change notification settings - Fork 1
Add support bundle docs #1044
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add support bundle docs #1044
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| --- | ||
| title: Support Bundles | ||
| description: Collect diagnostic snapshots for troubleshooting | ||
| --- | ||
|
|
||
| The `up` CLI uses [troubleshoot.sh] to collect diagnostic snapshots from UXP, Spaces, and control planes for troubleshooting. | ||
|
|
||
| ## Commands | ||
|
|
||
| | Command | Description | | ||
| |---------|-------------| | ||
| | `collect` | Gather logs and resources into a tar.gz archive | | ||
| | `template` | Output the default YAML config for customization | | ||
| | `serve` | View bundle contents via a local API server | | ||
|
|
||
| ## Collecting a support bundle | ||
|
|
||
| ```bash | ||
| up support-bundle collect | ||
| ``` | ||
|
|
||
| This outputs a timestamped `tar.gz` file (e.g., `upbound-support-bundle-20250115-163905.tar.gz`). | ||
|
|
||
| By default, the bundle includes logs and cluster resources from: | ||
|
|
||
| - `crossplane-system` | ||
| - `upbound-system` | ||
| - Any Spaces control plane namespaces | ||
|
|
||
| ### Filtering namespaces | ||
|
|
||
| Include or exclude specific namespaces using glob patterns: | ||
|
|
||
| ```bash | ||
| up support-bundle collect --include-namespaces "prefix-*" | ||
| up support-bundle collect --exclude-namespaces upbound-system | ||
| ``` | ||
|
|
||
| ### Crossplane resources only | ||
|
|
||
| Skip log collection and gather only Crossplane CRDs and associated custom resources: | ||
|
|
||
| ```bash | ||
| up support-bundle collect --crossplane-resources-only | ||
| ``` | ||
|
|
||
| ## Viewing a support bundle | ||
|
|
||
| The `serve` command starts a local API server and generates a kubeconfig, letting you browse bundle contents with kubectl or k9s: | ||
|
|
||
| ```bash | ||
| up support-bundle serve ./upbound-support-bundle-20250115-163905.tar.gz | ||
| ``` | ||
|
|
||
| Then in another terminal: | ||
|
|
||
| ```bash | ||
| kubectl --kubeconfig=./support-bundle-kubeconfig get pods -A | ||
| ``` | ||
|
|
||
| This runs only the API server for viewing collected data, no workloads are actually running. | ||
|
|
||
| ## Automatic redaction | ||
|
|
||
| Sensitive information is automatically redacted, including: | ||
|
|
||
| - Kubernetes secrets | ||
| - Passwords and API keys | ||
| - IPv4 addresses in logs | ||
| - ConfigMap data fields | ||
| - EnvironmentConfig data fields | ||
| - Provider Kubernetes objects | ||
|
|
||
| ## Shared responsibility | ||
|
|
||
| Automatic redaction covers common cases but cannot guarantee complete removal of all sensitive data. Before sharing a support bundle with Upbound: | ||
|
|
||
| 1. Use `up support-bundle serve` to review the contents | ||
| 2. Remove any sensitive information or PII that wasn't automatically redacted | ||
| 3. Add custom redactors if you need to exclude specific patterns | ||
|
|
||
| ## Custom configuration | ||
|
|
||
| Generate the default config template: | ||
|
|
||
| ```bash | ||
| up support-bundle template > support-bundle-config.yaml | ||
| ``` | ||
|
|
||
| Edit the file to add custom collectors or redactors, then collect with it: | ||
|
|
||
| ```bash | ||
| up support-bundle collect -c support-bundle-config.yaml | ||
| ``` | ||
|
|
||
| The config file supports multi-document YAML—include both `SupportBundle` and `Redactor` resources separated by `---`. | ||
|
|
||
| When using `-c`, the `--include-namespaces` and `--exclude-namespaces` flags are ignored. | ||
|
|
||
| For redactor syntax, see the [troubleshoot.sh redactors documentation][redactors]. | ||
|
|
||
| [troubleshoot.sh]: https://troubleshoot.sh/docs/support-bundle/introduction | ||
| [redactors]: https://troubleshoot.sh/docs/redact/redactors | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these are available in the
mainchannel, not in a release quite yet