feat: onboarding wizard -- guided first-run setup for new deployments

pyr0ball commented

2026-05-26 23:05:28 -07:00

Owner

New Turnstone deployments currently require manual YAML editing to define log sources, a pattern file, and the DB path. This creates friction for non-expert operators (support engineers, sysadmins unfamiliar with the stack) and makes enterprise pilots harder to set up quickly.

Onboarding wizard flow (3-step, shown only on first launch when no sources are configured):

Detect environment -- auto-discover available log sources:
- Scan for journald (/var/log/journal, journalctl availability)
- Enumerate running Docker/Podman containers
- Detect common app log directories (/var/log/nginx, /var/log/apache2, etc.)
- Offer SSH-collected remote nodes (hostname + SSH test)
Select and name sources -- checklist of discovered sources with friendly names; allow manual add
Confirm and write -- preview the generated sources.yaml snippet, write it, trigger initial glean

Additional touches:

"Add source" button in SourcesView opens a condensed version of steps 1-2 for adding new sources post-setup
Skip wizard link (for users who prefer YAML directly)
Wizard state stored in the DB so it doesn't re-run after completion

Acceptance criteria:

Fresh deployment with no sources.yaml shows wizard on first navigation to Sources view
Wizard produces a valid sources.yaml that gleans successfully
Existing deployments are unaffected

New Turnstone deployments currently require manual YAML editing to define log sources, a pattern file, and the DB path. This creates friction for non-expert operators (support engineers, sysadmins unfamiliar with the stack) and makes enterprise pilots harder to set up quickly. **Onboarding wizard flow (3-step, shown only on first launch when no sources are configured):** 1. **Detect environment** -- auto-discover available log sources: - Scan for journald (`/var/log/journal`, `journalctl` availability) - Enumerate running Docker/Podman containers - Detect common app log directories (`/var/log/nginx`, `/var/log/apache2`, etc.) - Offer SSH-collected remote nodes (hostname + SSH test) 2. **Select and name sources** -- checklist of discovered sources with friendly names; allow manual add 3. **Confirm and write** -- preview the generated `sources.yaml` snippet, write it, trigger initial glean **Additional touches:** - "Add source" button in SourcesView opens a condensed version of steps 1-2 for adding new sources post-setup - Skip wizard link (for users who prefer YAML directly) - Wizard state stored in the DB so it doesn't re-run after completion **Acceptance criteria:** - Fresh deployment with no `sources.yaml` shows wizard on first navigation to Sources view - Wizard produces a valid `sources.yaml` that gleans successfully - Existing deployments are unaffected

pyr0ball added this to the beta milestone 2026-05-26 23:05:28 -07:00

pyr0ball added the

ux

enhancement

labels 2026-05-26 23:05:28 -07:00

pyr0ball closed this issue

2026-05-29 09:40:13 -07:00

pyr0ball commented

2026-05-29 09:45:29 -07:00

Author

Owner

Implemented. Backend: app/services/discover.py (journald/Docker/file detection), app/services/nl_source.py (keyword+LLM interpretation), GET /api/setup/status + /discover, POST /api/setup/write + /interpret. Frontend: SetupWizard.vue (3-step Detect→Select→Confirm), wired into SourcesView (shows on first run when no sources.yaml; Add Source button reuses it post-setup). NL field with manual form fallback. 372 tests passing, build clean.

pyr0ball referenced this issue from a commit

2026-05-29 14:18:48 -07:00

feat: bundle PII sanitization, onboarding wizard, NL source addition (#51, #52, #53)

pyr0ball referenced this issue from a commit

2026-06-13 21:54:47 -07:00

feat: bundle PII sanitization, onboarding wizard, NL source addition (#51, #52, #53)

pyr0ball referenced this issue from a commit

2026-06-13 22:18:24 -07:00

feat: bundle PII sanitization, onboarding wizard, NL source addition (#51, #52, #53)

feat: onboarding wizard -- guided first-run setup for new deployments #52