Document mirror client setup wizard and consumer API endpoints

mirror.md: added section 8 covering the 4-step UI wizard flow, wizard
vs env var comparison table, and air-gap bundle import via UI and CLI.

architecture.md: added 6 consumer API endpoints (GET/PUT /consumer,
discover, verify-signature, import, import/status) to REST API section.

airgap-operations-runbook.md: cross-reference to UI import alternative.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
master
2026-03-15 14:49:43 +02:00
parent 9add6af221
commit b2cc26b161
4 changed files with 174 additions and 5 deletions

View File

@@ -188,7 +188,7 @@ Completion criteria:
- [x] Tests verify navigation between wizard and dashboard
### MCS-006 - Documentation update
Status: TODO
Status: DONE
Dependency: MCS-001 through MCS-005
Owners: Documentation author
Task description:
@@ -200,9 +200,9 @@ Task description:
- Add consumer setup screenshots or step descriptions
Completion criteria:
- [ ] Mirror docs include UI-based consumer setup instructions
- [ ] Env var and UI configuration paths both documented
- [ ] Air-gap import documented for both CLI and UI
- [x] Mirror docs include UI-based consumer setup instructions
- [x] Env var and UI configuration paths both documented
- [x] Air-gap import documented for both CLI and UI
---
@@ -215,6 +215,7 @@ Completion criteria:
| 2026-03-15 | MCS-001 DONE: Added 4 consumer endpoints (GET/PUT /consumer, POST /consumer/discover, POST /consumer/verify-signature), IMirrorConsumerConfigStore interface, in-memory implementation, DI wiring, MirrorConsumer HttpClient. | Developer (Backend) |
| 2026-03-15 | MCS-003 DONE: mirror-dashboard.component.ts — added Configure button in consumer panel header, setup prompt when no consumer URL, Switch to Mirror CTA card for Direct mode with showDirectModeCta computed signal. advisory-source-catalog.component.ts — added Connect to Mirror link in mirror context header, consumer URL + last sync stats for Mirror/Hybrid mode via isConsumerMode computed signal. | Developer (FE) |
| 2026-03-15 | MCS-004 DONE: Added POST /api/v1/mirror/import and GET /api/v1/mirror/import/status endpoints to MirrorDomainManagementEndpointExtensions.cs. Import runs async with manifest parsing, SHA256 checksum verification, DSSE detection, artifact copy to local data store. Added IMirrorBundleImportStore interface, implemented in InMemoryMirrorDomainStore, wired DI in Program.cs. Extended mirror-management.api.ts with importBundle() and getImportStatus() methods + DTOs. | Developer (Backend + FE) |
| 2026-03-15 | MCS-006 DONE: Updated `docs/modules/concelier/operations/mirror.md` with new section 8 "Setting up as Mirror Consumer (UI)" covering 4-step wizard flow, wizard-vs-env-var comparison table, air-gap bundle import for both CLI and UI. Updated `docs/modules/concelier/architecture.md` REST API section with 6 new endpoints (GET/PUT /consumer, POST /consumer/discover, POST /consumer/verify-signature, POST /import, GET /import/status). Added cross-reference in `docs/operations/airgap-operations-runbook.md` section 2.4 pointing to the UI import alternative. | Documentation author |
## Decisions & Risks
- The `StellaOpsMirrorConnector` plugin already handles fetch/parse/map jobs. The wizard configures it, not replaces it.