Skip to content

Commit e596ffc

Browse files
troglobittroglobit
committed
doc: relocate support data collection to separate section
Does not really fit under "System Configuration". Signed-off-by: Joachim Wiberg <[email protected]>
1 parent 69bbf6f commit e596ffc

File tree

3 files changed

+92
-88
lines changed

3 files changed

+92
-88
lines changed

‎doc/support.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Support Data Collection
2+
3+
When troubleshooting issues or seeking support, the `support` command
4+
provides a convenient way to collect comprehensive system diagnostics.
5+
This command gathers configuration files, logs, network state, and other
6+
system information into a single compressed archive.
7+
8+
## Collecting Support Data
9+
10+
To collect support data and save it to a file:
11+
12+
```bash
13+
admin@host:~$ support collect > support-data.tar.gz
14+
(admin@host) Password: ***********
15+
Starting support data collection from host...
16+
This may take up to a minute. Please wait...
17+
Tailing /var/log/messages for 30 seconds (please wait)...
18+
Log tail complete.
19+
Collection complete. Creating archive...
20+
admin@host:~$ ls -l support-data.tar.gz
21+
-rw-rw-r-- 1 admin admin 508362 nov 30 13:05 support-data.tar.gz
22+
```
23+
24+
The command can also be run remotely via SSH from your workstation:
25+
26+
```bash
27+
$ ssh admin@host support collect > support-data.tar.gz
28+
...
29+
```
30+
31+
The collection process may take up to a minute depending on system load
32+
and the amount of logging data. Progress messages are shown during the
33+
collection process.
34+
35+
## Encrypted Collection
36+
37+
For secure transmission of support data, the archive can be encrypted
38+
with GPG using a password:
39+
40+
```bash
41+
admin@host:~$ support collect -p mypassword > support-data.tar.gz.gpg
42+
Starting support data collection from host...
43+
This may take up to a minute. Please wait...
44+
...
45+
Collection complete. Creating archive...
46+
Encrypting with GPG...
47+
```
48+
49+
The `support collect` command even supports omitting `mypassword` and
50+
will then prompt interactively for the password. This works over SSH too,
51+
but the local ssh client may then echo the password.
52+
53+
> [!TIP]
54+
> To hide the encryption password for an SSH session, the script supports
55+
> reading from stdin:
56+
> `echo "$MYSECRET" | ssh user@device support collect -p >
57+
> file.tar.gz.gpg`
58+
59+
After transferring the resulting file to your workstation, decrypt it
60+
with the password:
61+
62+
```bash
63+
$ gpg -d support-data.tar.gz.gpg > support-data.tar.gz
64+
$ tar xzf support-data.tar.gz
65+
...
66+
```
67+
68+
or
69+
70+
```bash
71+
$ gpg -d support-data.tar.gz.gpg | tar xz
72+
...
73+
```
74+
75+
> [!IMPORTANT]
76+
> Make sure to share `mypassword` out-of-band from the encrypted data
77+
> with the recipient of the data. I.e., avoid sending both in the same
78+
> plain-text email for example.
79+
80+
## What is Collected
81+
82+
The support archive includes:
83+
84+
- System identification (hostname, uptime, kernel version)
85+
- Running and operational configuration (sysrepo datastores)
86+
- System logs (`/var/log` directory and live tail of messages log)
87+
- Network configuration and state (interfaces, routes, neighbors, bridges)
88+
- FRRouting information (OSPF, BFD status)
89+
- Container information (podman containers and their configuration)
90+
- System resource usage (CPU, memory, disk, processes)
91+
- Hardware information (PCI, USB devices, network interfaces)

‎doc/system.md‎

Lines changed: 0 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -323,94 +323,6 @@ reference ID, stratum, time offsets, frequency, and root delay.
323323
> The system uses `chronyd` Network Time Protocol (NTP) daemon. The
324324
> output shown here is best explained in the [Chrony documentation][4].
325325
326-
## Support Data Collection
327-
328-
When troubleshooting issues or seeking support, the `support` command
329-
provides a convenient way to collect comprehensive system diagnostics.
330-
This command gathers configuration files, logs, network state, and other
331-
system information into a single compressed archive.
332-
333-
### Collecting Support Data
334-
335-
To collect support data and save it to a file:
336-
337-
```bash
338-
admin@host:~$ support collect > support-data.tar.gz
339-
(admin@host) Password: ***********
340-
Starting support data collection from host...
341-
This may take up to a minute. Please wait...
342-
Tailing /var/log/messages for 30 seconds (please wait)...
343-
Log tail complete.
344-
Collection complete. Creating archive...
345-
admin@host:~$ ls -l support-data.tar.gz
346-
-rw-rw-r-- 1 admin admin 508362 nov 30 13:05 support-data.tar.gz
347-
```
348-
349-
The command can also be run remotely via SSH from your workstation:
350-
351-
```bash
352-
$ ssh admin@host support collect > support-data.tar.gz
353-
...
354-
```
355-
356-
The collection process may take up to a minute depending on system load
357-
and the amount of logging data. Progress messages are shown during the
358-
collection process.
359-
360-
### Encrypted Collection
361-
362-
For secure transmission of support data, the archive can be encrypted
363-
with GPG using a password:
364-
365-
```bash
366-
admin@host:~$ support collect -p mypassword > support-data.tar.gz.gpg
367-
Starting support data collection from host...
368-
This may take up to a minute. Please wait...
369-
...
370-
Collection complete. Creating archive...
371-
Encrypting with GPG...
372-
```
373-
374-
The `support collect` command even supports omitting `mypassword` and
375-
will then prompt interactively for the password. This works over SSH too,
376-
but the local ssh client may then echo the password.
377-
378-
> [!TIP]
379-
> To hide the encryption password for an SSH session, the script supports reading from stdin:
380-
> `echo "$MYSECRET" | ssh user@device support collect -p > file.tar.gz.gpg`
381-
382-
After transferring the resulting file to your workstation, decrypt it
383-
with the password:
384-
385-
```bash
386-
$ gpg -d support-data.tar.gz.gpg > support-data.tar.gz
387-
$ tar xzf support-data.tar.gz
388-
```
389-
390-
or
391-
392-
```bash
393-
$ gpg -d support-data.tar.gz.gpg | tar xz
394-
```
395-
396-
> [!IMPORTANT]
397-
> Make sure to share `mypassword` out-of-band from the encrypted data
398-
> with the recipient of the data. I.e., avoid sending both in the same
399-
> plain-text email for example.
400-
401-
### What is Collected
402-
403-
The support archive includes:
404-
405-
- System identification (hostname, uptime, kernel version)
406-
- Running and operational configuration (sysrepo datastores)
407-
- System logs (`/var/log` directory and live tail of messages log)
408-
- Network configuration and state (interfaces, routes, neighbors, bridges)
409-
- FRRouting information (OSPF, BFD status)
410-
- Container information (podman containers and their configuration)
411-
- System resource usage (CPU, memory, disk, processes)
412-
- Hardware information (PCI, USB devices, network interfaces)
413-
414326
[1]: https://www.rfc-editor.org/rfc/rfc7317
415327
[2]: https://github.com/kernelkit/infix/blob/main/src/confd/yang/infix-system%402024-02-29.yang
416328
[3]: https://www.rfc-editor.org/rfc/rfc8341

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ nav:
4343
- Hardware Info & Status: hardware.md
4444
- Management: management.md
4545
- Syslog Support: syslog.md
46+
- Support Data: support.md
4647
- Upgrade: upgrade.md
4748
- Scripting:
4849
- Introduction: scripting.md

0 commit comments

Comments
 (0)