docs: UI-driven local setup sprints + module dossier sync
Add SPRINT_20260413_004 (platform UI-only setup bootstrap closure) with BOOTSTRAP-001..006 delivery tracker, and update sprint 003 and sprint 20260410-001 execution logs to reflect the completed persistence / orchestrator / secret-authority work. Sync module dossiers and operator guides with the new reality: setup wizard UX, platform-service architecture, CLI setup guide, integrations architecture + local services, release-orchestrator architecture, install guide, and compose README. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -278,57 +278,76 @@ stella image inspect http://localhost:5000/myapp:1.0.0
|
||||
|
||||
## stella setup
|
||||
|
||||
Interactive setup wizard for configuring StellaOps components.
|
||||
Installation-scoped control-plane bootstrap for the running StellaOps platform.
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
stella setup [options]
|
||||
stella setup --step <step-id> [options]
|
||||
stella setup [--config <path>] [--non-interactive]
|
||||
stella setup run [options]
|
||||
stella setup resume [--session <id>]
|
||||
stella setup status [--session <id>] [--json]
|
||||
stella setup reset [--step <step-id> | --all] [--force]
|
||||
stella setup validate --config <path>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Description |
|
||||
| --- | --- |
|
||||
| `--step`, `-s` | Run a specific setup step (e.g., `llm`, `notify`, `authority`). |
|
||||
| `--non-interactive` | Run in non-interactive mode using config values. |
|
||||
| `--dry-run` | Preview changes without applying them. |
|
||||
| `--config`, `-c` | Path to YAML configuration file. |
|
||||
| `--config`, `-c` | Path to the YAML configuration file used to seed setup draft values. |
|
||||
| `--non-interactive`, `-y` | Run without prompts. |
|
||||
| `--step`, `-s` | `run`/`reset` only. Limit the operation to one supported control-plane step. |
|
||||
| `--dry-run` | `run` only. Probe without applying. |
|
||||
| `--force`, `-f` | `run` starts a fresh session; `reset --all` skips confirmation. |
|
||||
| `--session` | `resume`/`status` only. Use an explicit session id. |
|
||||
| `--json` | `status` only. Emit machine-readable session state. |
|
||||
| `--verbose`, `-v` | Enable verbose output. |
|
||||
|
||||
### Available Steps
|
||||
|
||||
| Step ID | Name | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authority` | Authentication Provider | Yes | Configure authentication (Standard/LDAP). |
|
||||
| `users` | User Management | Yes | Create super user and additional users. |
|
||||
| `database` | PostgreSQL Database | Yes | Configure database connection. |
|
||||
| `cache` | Valkey/Redis Cache | Yes | Configure cache connection. |
|
||||
| `vault` | Secrets Vault | No | Configure secrets management (Vault/AWS/Azure). |
|
||||
| `settingsstore` | Settings Store | No | Configure settings backend (Consul/etcd). |
|
||||
| `registry` | Container Registry | No | Configure registry authentication. |
|
||||
| `telemetry` | OpenTelemetry | No | Configure observability. |
|
||||
| `notify` | Notifications | No | Configure notification channels. |
|
||||
| `llm` | AI/LLM Provider | No | Configure LLM for AdvisoryAI. |
|
||||
| `migrations` | Database Migrations | Yes | Converge the required schema migrations. |
|
||||
| `admin` | Admin Bootstrap | Yes | Ensure the bootstrap administrator exists. |
|
||||
| `crypto` | Crypto Profile | Yes | Validate and apply the selected crypto profile. |
|
||||
|
||||
Compatibility aliases still accepted:
|
||||
- `valkey -> cache`
|
||||
- `authority -> admin`
|
||||
- `users -> admin`
|
||||
|
||||
Former setup targets such as `vault`, `settingsstore`, `registry`, `scm`, `notify`, `telemetry`, `llm`, `sources`, `environments`, and `agents` now return explicit handoff guidance to the authenticated onboarding surfaces.
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Run full setup wizard
|
||||
stella setup
|
||||
# Run the installation bootstrap
|
||||
stella setup run
|
||||
|
||||
# Configure LLM provider only
|
||||
stella setup --step llm
|
||||
# Probe only
|
||||
stella setup run --step database --dry-run --config ./setup.yaml
|
||||
|
||||
# Preview database configuration
|
||||
stella setup --step database --dry-run
|
||||
# Resume and inspect status
|
||||
stella setup resume
|
||||
stella setup status --json
|
||||
|
||||
# Non-interactive with config file
|
||||
stella setup --step llm --non-interactive --config ./setup.yaml
|
||||
# Reset the installation session
|
||||
stella setup reset --all --force
|
||||
```
|
||||
|
||||
See also: `docs/modules/advisory-ai/llm-setup-guide.md` for LLM configuration details.
|
||||
After `stella setup`, use the authenticated integration/onboarding surfaces instead of more setup steps:
|
||||
|
||||
```bash
|
||||
stella config integrations secrets targets
|
||||
stella config integrations secrets upsert-bundle \
|
||||
--bundle gitlab-server \
|
||||
--target <vault-integration-id> \
|
||||
--path gitlab/server \
|
||||
--entry access-token=glpat-...
|
||||
```
|
||||
|
||||
## stella advise ask
|
||||
|
||||
@@ -364,7 +383,7 @@ An LLM provider must be configured. If not configured, the command will display:
|
||||
Error: AI/LLM provider not configured.
|
||||
|
||||
AdvisoryAI features require an LLM provider to be configured.
|
||||
Run 'stella setup --step llm' to configure an LLM provider.
|
||||
Use the AdvisoryAI integration surfaces to configure an LLM provider.
|
||||
|
||||
Alternatively, set one of these environment variables:
|
||||
- OPENAI_API_KEY for OpenAI
|
||||
|
||||
Reference in New Issue
Block a user