Skip to content

Commit a0adcf6

Browse files
authored
debug dump (#287)
* debug dump
1 parent 7761e92 commit a0adcf6

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

input/troubleshooting/index.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,63 @@ This section outlines some advanced options for checking links.
160160
There are no link resources in the namespace
161161
```
162162

163+
164+
<a id="debug-dump"></a>
165+
## Creating a Skupper debug tar file
166+
<!--PROCEDURE-->
167+
168+
Create a debug tar file containing diagnostic information about a Skupper site to troubleshoot issues or share with support.
169+
170+
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`.
171+
172+
This procedure applies to both Kubernetes and local system sites.
173+
174+
**Procedure**
175+
176+
1. Create the debug tar file for a site:
177+
178+
```bash
179+
skupper debug dump
180+
```
181+
182+
Or specify a custom filename:
183+
184+
```bash
185+
skupper debug dump mysite-debug
186+
```
187+
188+
The command creates a file such as `skupper-dump-default-20250526-143022.tar.gz`.
189+
190+
2. Extract the tar file to examine its contents:
191+
192+
```bash
193+
mkdir skupper-dump
194+
tar -xzf skupper-dump-default-20250526-143022.tar.gz -C skupper-dump
195+
cd skupper-dump
196+
```
197+
198+
3. Check the Skupper and platform versions:
199+
200+
- `/versions/kubernetes.yaml` - Kubernetes version (on Kubernetes platforms)
201+
- `/versions/skupper.yaml` - Versions of Skupper components
202+
203+
4. Check the site configuration and ingress:
204+
205+
- `/site-namespace/resources/Site-<name>.yaml` - Site specification and status
206+
- `/site-namespace/resources/RouterAccess-<name>.yaml` - Ingress and access type configured for the site
207+
208+
5. Check linking and service configuration:
209+
210+
- `/site-namespace/resources/Link-<name>.yaml` - Link status between sites
211+
- `/site-namespace/resources/Accessgrant-<name>.yaml` - Access grants for tokens
212+
- `/site-namespace/resources/AccessTokens-<name>.yaml` - Token usage information
213+
- `/site-namespace/resources/Connector-<name>.yaml` - Connector configuration and status
214+
- `/site-namespace/resources/Listener-<name>.yaml` - Listener configuration and status
215+
216+
217+
218+
219+
163220
<a id="resolving-common-problems"></a>
164221
## Resolving common problems
165222
<!--REFERENCE-->

0 commit comments

Comments
 (0)