Skip to content

Commit 2ad1938

Browse files
author
root
committed
Add install issue reporting checklist to debugging tips
1 parent d3592f9 commit 2ad1938

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs/personas/quick-deploy/install-perfsonar-testpoint.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1619,6 +1619,20 @@ Perform these checks before handing the host over to operations:
16191619
nft list ruleset
16201620
```
16211621
1622+
??? note "What to include when reporting issues via email"
1623+
1624+
To help us diagnose install problems quickly, please include:
1625+
1626+
- Host details: OS version (e.g., `cat /etc/os-release`), kernel (`uname -r`), and whether this is testpoint or toolkit.
1627+
- Script/log context: which script/step failed and the exact command you ran.
1628+
- Timestamps: approximate time of failure and timezone.
1629+
- Outputs/logs: relevant console output and excerpts from `journalctl -u podman -n 200`, `tail -200 /var/log/perfSONAR-install-nftables.log`, and any script-specific log mentioned in the error.
1630+
- Network state: `ip -br addr`, `ip rule show`, `nmcli connection show`, and whether port 80/443 should be open externally.
1631+
- Certificates (if LE): whether port 80 was reachable from the Internet and the contents of `/var/log/letsencrypt/letsencrypt.log` around the failure.
1632+
- Contact info: your name, site, and a callback email.
1633+
1634+
Send reports to your usual perfSONAR support contact or project mailing list with the subject prefix `[perfSONAR install issue]`.
1635+
16221636
**Logs:**
16231637
16241638
```bash

docs/personas/quick-deploy/install-perfsonar-toolkit.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1837,6 +1837,20 @@ Perform these checks before handing the host over to operations:
18371837
nft list ruleset
18381838
```
18391839
1840+
??? note "What to include when reporting issues via email"
1841+
1842+
To help us diagnose install problems quickly, please include:
1843+
1844+
- Host details: OS version (e.g., `cat /etc/os-release`), kernel (`uname -r`), and whether this is testpoint or toolkit.
1845+
- Script/log context: which script/step failed and the exact command you ran.
1846+
- Timestamps: approximate time of failure and timezone.
1847+
- Outputs/logs: relevant console output and excerpts from `journalctl -u podman -n 200`, `tail -200 /var/log/perfSONAR-install-nftables.log`, and any script-specific log mentioned in the error.
1848+
- Network state: `ip -br addr`, `ip rule show`, `nmcli connection show`, and whether port 80/443 should be open externally.
1849+
- Certificates (if LE): whether port 80 was reachable from the Internet and the contents of `/var/log/letsencrypt/letsencrypt.log` around the failure.
1850+
- Contact info: your name, site, and a callback email.
1851+
1852+
Send reports to your usual perfSONAR support contact or project mailing list with the subject prefix `[perfSONAR install issue]`.
1853+
18401854
**Logs:**
18411855
18421856
```bash

0 commit comments

Comments
 (0)