docs: close pre-release documentation gaps #124

2026-06-12T19:26:42Z

lerko commented

2026-06-12 19:26:42 +00:00

Documentation items from the v0.1.0 checklist:

Docker compose: ping_group_range sysctl — ping checks use unprivileged ICMP (SetPrivileged(false)); without the sysctl, pings inside a container get no response and silently report DOWN.
README data retention table — 1,000 checks + 5,000 state changes per monitor, 200 log entries, pruned automatically. (Checklist claim that state_changes was never pruned turned out stale.)
README: group-alert limitation — groups roll up child status but don't fire their own alerts yet (#70); attach alerts to children.
config-as-code: apply is not atomic — explicit wording plus re-run convergence guidance; real transactional fix pairs with the store split (#76).
config-as-code: backup redaction footgun — /api/backup/export redacts secrets by default; restoring a redacted export imports ***REDACTED*** literally. Documented redact_secrets=false for real backups.
config-as-code: opsgenie example (provider count was stale at 9) and ntfy auth keys.

Depends on the header-rename PR (#122) — backup examples use X-Uptop-Secret. Merge after it.

Documentation items from the v0.1.0 checklist: - **Docker compose: `ping_group_range` sysctl** — ping checks use unprivileged ICMP (`SetPrivileged(false)`); without the sysctl, pings inside a container get no response and silently report DOWN. - **README data retention table** — 1,000 checks + 5,000 state changes per monitor, 200 log entries, pruned automatically. (Checklist claim that state_changes was never pruned turned out stale.) - **README: group-alert limitation** — groups roll up child status but don't fire their own alerts yet (#70); attach alerts to children. - **config-as-code: apply is not atomic** — explicit wording plus re-run convergence guidance; real transactional fix pairs with the store split (#76). - **config-as-code: backup redaction footgun** — `/api/backup/export` redacts secrets by default; restoring a redacted export imports `***REDACTED***` literally. Documented `redact_secrets=false` for real backups. - **config-as-code: opsgenie example** (provider count was stale at 9) and ntfy auth keys. Depends on the header-rename PR (#122) — backup examples use `X-Uptop-Secret`. Merge after it.

lerko added 1 commit 2026-06-12 19:37:49 +00:00

docs: close pre-release documentation gaps

CI / test (pull_request) Successful in 2m0s

Details

CI / lint (pull_request) Successful in 1m22s

Details

CI / vulncheck (pull_request) Successful in 51s

Details

Release Binaries / release (push) Failing after 8m31s

Details

Release Docker / docker (push) Failing after 2m17s

Details

4070691407

- Docker compose: ping_group_range sysctl, without which ping monitors
  silently report DOWN in containers
- README: data retention table (1000 checks / 5000 state changes per
  monitor, 200 logs, pruned automatically), group-alert limitation note
- config-as-code: apply is not atomic + re-run convergence, backup
  redaction footgun (/api/backup/export redacts by default), opsgenie
  example (provider count was stale at 9), ntfy auth keys

lerko force-pushed docs/pre-release-gaps from 8a56651141 to 4070691407

2026-06-12 19:37:49 +00:00

Compare

lerko merged commit 4070691407 into main

2026-06-12 19:49:55 +00:00

lerko deleted branch docs/pre-release-gaps

2026-06-12 19:49:55 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: lerkolabs/uptop#124