Skip to content

debug dump #287

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.

Sign up for GitHub

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

Open
pwright wants to merge 2 commits into
base: main
Choose a base branch
from
Open

debug dump #287

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11fc287
debug dump
pwright May 26, 2026
97ac75c
update
pwright May 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions input/troubleshooting/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,63 @@ This section outlines some advanced options for checking links.
There are no link resources in the namespace
```


<a id="debug-dump"></a>
## Creating a Skupper debug tar file
<!--PROCEDURE-->

Create a debug tar file containing diagnostic information about a Skupper site to troubleshoot issues or share with support.

The `skupper debug dump` command creates a compressed tarball (`.tar.gz`) containing logs, configurations, and resource status from a site. The output file is named using the pattern `<filename>-<namespace>-<datetime>.tar.gz`. If no filename is provided, it defaults to `skupper-dump`.

This procedure applies to both Kubernetes and local system sites.

**Procedure**

1. Create the debug tar file for a site:

```bash
skupper debug dump
```

Or specify a custom filename:

```bash
skupper debug dump mysite-debug
```

The command creates a file such as `skupper-dump-default-20250526-143022.tar.gz`.

2. Extract the tar file to examine its contents:

```bash
mkdir skupper-dump
tar -xzf skupper-dump-default-20250526-143022.tar.gz -C skupper-dump
cd skupper-dump
```

3. Check the Skupper and platform versions:

- `/versions/kubernetes.yaml` - Kubernetes version (on Kubernetes platforms)
- `/versions/skupper.yaml` - Versions of Skupper components

4. Check the site configuration and ingress:

- `/site-namespace/resources/Site-<name>.yaml` - Site specification and status
- `/site-namespace/resources/RouterAccess-<name>.yaml` - Ingress and access type configured for the site

5. Check linking and service configuration:

- `/site-namespace/resources/Link-<name>.yaml` - Link status between sites
- `/site-namespace/resources/Accessgrant-<name>.yaml` - Access grants for tokens
- `/site-namespace/resources/AccessTokens-<name>.yaml` - Token usage information
- `/site-namespace/resources/Connector-<name>.yaml` - Connector configuration and status
- `/site-namespace/resources/Listener-<name>.yaml` - Listener configuration and status





<a id="resolving-common-problems"></a>
## Resolving common problems
<!--REFERENCE-->
Expand Down