Sergey Antropoff
48df10b17e
- Harden DB-backed handlers and seed profiles; align client wire shapes for cluster resources, QEMU config, and node SSL fields - Serve plain HTTP on Compose :8006; keep TLS optional (--profile tls) and terminate HTTPS at Kubernetes Ingress - Add pulumi-tests (full contract surface majors 6–9 + BPG lifecycle) and make pulumi-tests - Ship bilingual docs, CHANGELOG, SECURITY, CONTRIBUTING, and GitHub Actions (make ci + Compose/Helm validation)
111 lines
4.7 KiB
Markdown
111 lines
4.7 KiB
Markdown
**Language / Язык:** [English](configuration.md) | [Русский](ru/configuration.md)
|
||
|
||
# Configuration
|
||
|
||
Application settings are loaded from the environment (see `.env.example`).
|
||
Docker Compose injects many of these for the `simulator` service; values
|
||
declared under `environment:` in `docker-compose.yml` override `.env` for that
|
||
service.
|
||
|
||
## Core
|
||
|
||
| Variable | Default / example | Meaning |
|
||
|---|---|---|
|
||
| `APP_HOST` | `0.0.0.0` | Bind address |
|
||
| `APP_PORT` | `8006` | HTTP listen port |
|
||
| `DATABASE_URL` | `postgresql://proxmox:proxmox@postgres:5432/proxmox_simulator` | asyncpg DSN |
|
||
| `DB_POOL_MIN_SIZE` | `1` | Pool minimum |
|
||
| `DB_POOL_MAX_SIZE` | `10` | Pool maximum |
|
||
| `DB_CONNECT_TIMEOUT_SECONDS` | `10` | Connect timeout |
|
||
| `DB_COMMAND_TIMEOUT_SECONDS` | `30` | Command timeout |
|
||
| `LOG_LEVEL` | `INFO` | Logging level |
|
||
| `REQUEST_ID_HEADER` | `X-Request-ID` | Request correlation header |
|
||
|
||
## Contract and catalog
|
||
|
||
| Variable | Meaning |
|
||
|---|---|
|
||
| `CONTRACT_SNAPSHOT` | Path to the normalized snapshot loaded at **cold start** |
|
||
| `CONTRACT_FALLBACK` | `error` (default), `schema-default`, or `fixture` — behaviour for methods **without** a semantic handler |
|
||
| `COMPATIBILITY_EVIDENCE` | Optional evidence JSON used by compatibility reports |
|
||
| `CATALOG_ARTIFACT_URL_6` … `_9` | Official API Viewer URLs used when importing/caching catalog majors |
|
||
|
||
Runtime hot-swap (Web UI / `POST /ui/api/contract/apply`) replaces the in-memory
|
||
route table for majors **6–9** without rewriting `CONTRACT_SNAPSHOT`. A process
|
||
restart restores the cold-start snapshot. See [API versions](api-versions.md).
|
||
|
||
With **100%** handler coverage on majors 6–9, `CONTRACT_FALLBACK` is unused for
|
||
declared methods of the active contract. Keep `error` in production-like labs so
|
||
any accidental gap surfaces as HTTP 501.
|
||
|
||
## Security and tasks
|
||
|
||
| Variable | Meaning |
|
||
|---|---|
|
||
| `TICKET_SIGNING_KEY` | HMAC key for tickets and ticket-bound CSRF tokens (**change outside toy labs**) |
|
||
| `TASK_WORKER_CONCURRENCY` | Number of leased asyncio workers (1–32) |
|
||
| `TASK_LEASE_SECONDS` | PostgreSQL task lease duration |
|
||
| `SIMULATION_TIME_SCALE` | Accelerates simulated task durations |
|
||
|
||
## Seed and client test hooks
|
||
|
||
| Variable | Meaning |
|
||
|---|---|
|
||
| `SEED_PROFILE` | Profile name for the seed CLI (`small`, `medium`, …) |
|
||
| `SEED_LARGE_NODES` | Node count for `large` |
|
||
| `SEED_LARGE_RESOURCES` | Guest count for `large` (default 10 000) |
|
||
| `TEST_DATABASE_URL` | Integration-test DSN |
|
||
| `PROXMOXER_HOST` / `PROXMOXER_PORT` | Compatibility test client target with `--profile tls` (`tls-gateway` / `8443`) |
|
||
|
||
## Ports and TLS
|
||
|
||
### Real Proxmox VE (reference)
|
||
|
||
On a physical / production PVE node the management API listens on **HTTPS
|
||
`:8006`** (`/api2/json/...`). Related management ports (not separate REST APIs):
|
||
|
||
| Port | Protocol | Role |
|
||
|---|---|---|
|
||
| `8006` | TCP, HTTPS | Web UI + REST API |
|
||
| `3128` | TCP | SPICE proxy (graphical console) |
|
||
| `5900–5999` | TCP (WebSocket) | VNC web console |
|
||
| `22` | TCP | SSH / cluster actions |
|
||
| `5405–5412` | UDP | Corosync cluster traffic |
|
||
|
||
Port **`8007`** is **not** the PVE API — it is the usual Proxmox Backup Server
|
||
(PBS) management port. Do not point PVE clients at `:8007` on real hardware.
|
||
|
||
### Simulator lab endpoints
|
||
|
||
| Endpoint | Use |
|
||
|---|---|
|
||
| `http://localhost:8006` | Primary client URL — simulator (curl, browsers, requests, Terraform, …) |
|
||
| `https://localhost:8443` | Optional — `docker compose --profile tls` for proxmoxer-style HTTPS-only clients |
|
||
|
||
Compose publishes plain **HTTP on host `:8006`** (same port number as real PVE,
|
||
which uses HTTPS). The simulator process speaks HTTP on `:8006` inside the Docker
|
||
network as well. For Kubernetes, TLS terminates at Ingress (cert-manager). Host
|
||
**`:8007` is not used** for the lab API (on real hardware that port is typically
|
||
PBS, not PVE).
|
||
|
||
Optional Compose TLS: `docker compose --profile tls` starts an nginx gateway on
|
||
host `:8443` (requires `docker/tls/`). It proxies to `simulator:8006`.
|
||
|
||
The checked-in certificate under `docker/tls/` is disposable development
|
||
material. Never reuse it outside local labs. See [Security](security.md).
|
||
|
||
## Compose notes
|
||
|
||
- `migrate` runs once; `simulator` waits for a successful migrate.
|
||
- Development Compose bind-mounts the repository and enables Uvicorn reload.
|
||
- The default Compose `CONTRACT_SNAPSHOT` pins the bundled PVE **9.2.3**
|
||
revision for cold start.
|
||
|
||
## Open and unused example keys
|
||
|
||
`.env.example` may still list keys such as `PVE_API_VERSION`,
|
||
`SIMULATION_SEED`, `SIMULATOR_ADMIN_ENABLED`, and `SIMULATOR_ADMIN_TOKEN` that
|
||
are **not** consumed by the current settings model. Prefer `CONTRACT_SNAPSHOT`
|
||
for the default major and the Web UI / apply API for runtime switches. Do not
|
||
assume an authenticated `/_simulator` admin API exists today.
|