docs: module dossier + install/quickstart sync for truthful cutover sprints
- API_CLI_REFERENCE.md, INSTALL_GUIDE.md, quickstart.md, architecture/integrations.md, dev/DEV_ENVIRONMENT_SETUP.md, integrations/LOCAL_SERVICES.md: reflect real-service wiring. - docs/modules/**: module dossier updates across the modules touched by SPRINT_20260415_001..007 + SPRINT_20260416_003..017 + SPRINT_20260417_018..024 + SPRINT_20260418_025 + SPRINT_20260419_026. - docs/features/checked/web/**: update feature notes where UI changed. - docs/qa/feature-checks/runs/web/evidence-presentation-ux/: QA evidence artifacts. - docs/setup/**, docs/technical/**: align with setup wizard contracts. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
master
@@ -7,7 +7,7 @@ This document defines the functional requirements for the Stella Ops Setup Wizar
|
||||
The Setup Wizard provides a guided, step-by-step configuration experience that:
|
||||
- Validates infrastructure dependencies (PostgreSQL, Valkey)
|
||||
- Runs database migrations
|
||||
- Bootstraps the initial admin and crypto profile
|
||||
- Bootstraps the initial admin, crypto profile, and optional advisory/VEX source configuration
|
||||
- Exposes a truthful required-readiness summary for setup completion
|
||||
- Hands tenant onboarding to authenticated `/setup/*` and integration command surfaces instead of pretending they are bootstrap steps
|
||||
|
||||
@@ -57,8 +57,9 @@ The system reaches "Production-Ready" state when:
|
||||
| `migrations` | Database Migrations | Yes | No | Infrastructure |
|
||||
| `admin` | Admin Bootstrap | Yes | No | Security |
|
||||
| `crypto` | Crypto Profile | Yes | No | Security |
|
||||
| `sources` | Advisory & VEX Sources | No | Yes | Data |
|
||||
|
||||
Only these five core steps are current runtime setup step IDs. The integration and orchestration catalogs below are historical handoff targets and are no longer accepted by the current setup APIs or `stella setup` command group.
|
||||
Current runtime setup step IDs now include the five required control-plane steps plus the optional `sources` step. The integration and orchestration catalogs below are historical handoff targets and are no longer accepted by the current setup APIs or `stella setup` command group.
|
||||
|
||||
### 3.2 Integration Handoffs (Not current setup steps)
|
||||
|
||||
@@ -77,13 +78,11 @@ Only these five core steps are current runtime setup step IDs. The integration a
|
||||
|---------|------|----------|-----------|----------|
|
||||
| `environments` | Environment Definition | No | Yes | Orchestration |
|
||||
| `agents` | Agent Registration | No | Yes | Orchestration |
|
||||
| `feeds` | Vulnerability Feeds | No | Yes | Data |
|
||||
|
||||
---
|
||||
|
||||
## 4. Step Specifications
|
||||
|
||||
Sections 4.1-4.5 describe the current installation-scoped setup steps. Sections 4.6 and later remain useful as onboarding capability notes, but those inputs now belong to authenticated post-bootstrap surfaces rather than the setup wizard step catalog.
|
||||
Sections 4.1-4.5 and 4.5.1 describe the current installation-scoped setup steps. Sections 4.6 and later remain useful as onboarding capability notes, but those inputs now belong to authenticated post-bootstrap surfaces rather than the setup wizard step catalog.
|
||||
|
||||
### 4.1 Database Setup (`database`)
|
||||
|
||||
@@ -226,6 +225,39 @@ Sections 4.1-4.5 describe the current installation-scoped setup steps. Sections
|
||||
|
||||
---
|
||||
|
||||
### 4.5.1 Advisory & VEX Sources (`sources`)
|
||||
|
||||
**Purpose:** Optionally enable advisory and VEX aggregation during bootstrap without forcing operators through the full integrations catalog on first run.
|
||||
|
||||
**Inputs:**
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `mode` | enum | Yes | `mirror` | `mirror` enables StellaOps Mirror only; `manual` exposes explicit source selection |
|
||||
| `mirror.url` | string | Required when `mode=mirror` | `https://mirror.stella-ops.org` | StellaOps Mirror base URL |
|
||||
| `mirror.apiKey` | secret | No | - | Optional StellaOps Mirror API key |
|
||||
| `enabled` | string[] | Required when `mode=manual` | `[]` | Advisory/VEX source IDs to enable |
|
||||
|
||||
**Outputs:**
|
||||
- Selected sources are persisted through Concelier durable source storage
|
||||
- `mirror` mode enables only `stella-mirror`
|
||||
- `manual` mode enables only the explicitly selected upstream sources
|
||||
- Initial aggregation is scheduled for newly enabled sources
|
||||
|
||||
**Validation:**
|
||||
- Mirror URL must be an absolute URI
|
||||
- Manual mode must select at least one real source
|
||||
- `stella-mirror` is reserved for mirror mode and cannot be mixed into manual selections
|
||||
|
||||
**Doctor Checks:**
|
||||
- `check.sources.feeds.configured`
|
||||
- `check.sources.feeds.connectivity`
|
||||
|
||||
**Skip behavior:**
|
||||
- Skipping this optional step leaves advisory and VEX aggregation off
|
||||
- The integrations Advisory & VEX Sources page must surface that off-state and offer later enablement without rerunning bootstrap
|
||||
|
||||
---
|
||||
|
||||
### 4.6 Vault Integration (`vault`)
|
||||
|
||||
**Purpose:** Configure secrets management provider.
|
||||
@@ -481,7 +513,7 @@ The wizard stores user preferences in the settings store:
|
||||
"notifications": "slack"
|
||||
},
|
||||
"completedAt": "2026-01-13T10:30:00Z",
|
||||
"skippedSteps": ["identity", "feeds"]
|
||||
"skippedSteps": ["identity", "sources"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user