Files
config-atlas/registry/surfaces/surface.infotech.state-hub.api-config.md
tegwick a52b77a0e7 feat(registry): complete ATLAS-WP-0002 T04 (canon mapping) + T01 (surface schema)
T04: add docs/canon-mapping.md mapping config-atlas concepts to InfoTechCanon
(itc-gov/data/devsecops/land/org/access/sec/tag) and sibling repos with
consume/reference/align/own ownership, plus gaps, validation hooks, and
extension candidates. Resolves the (planned) refs in PRD and ecosystem-boundaries.

T01: add schemas/surface-entry.schema.json (Draft 2020-12, additionalProperties
false to forbid inline values/secrets), docs/configuration-surface-schema.md
(fields, kind taxonomy, L0-L9 ordering, explicit merge rules), a validating seed
entry (surface.infotech.state-hub.api-config), and expand registry/README.md.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-26 22:47:40 +02:00

54 lines
1.8 KiB
Markdown

---
id: surface.infotech.state-hub.api-config
name: State Hub API configuration
kind: app-config
summary: Runtime configuration for the Custodian State Hub API (bind host/port, database URL, environment mode).
owner: custodian
status: active
scope:
allowed_layers: [product-default, company, environment, installation]
default_layer: company
mutability: startup-time
security_class: operational
schema:
type: object
validator: ~/state-hub/config/schema.json
sources:
- repo: state-hub
path: Makefile
role: product-default
- repo: state-hub
path: .env.example
role: company-baseline
relations:
consumed_by:
- service.state-hub-api
overrides: []
depends_on_secret:
- state-hub/database-url
related_to:
- surface.infotech.ops-bridge.tunnel-config
evidence:
last_seen: '2026-06-26'
discovery_method: manual
change_log_ref: ATLAS-WP-0002-T01
---
# State Hub API configuration
The Custodian State Hub API (`http://127.0.0.1:8000`) reads its runtime
configuration at startup: bind host/port, database connection, and environment
mode. This surface **maps** that configuration — it does not duplicate the values.
- **Source of truth:** the `state-hub` repo (`make api` / `.env`); the database URL
is a secret reference (`depends_on_secret`), never stored here.
- **Precedence:** product defaults in the Makefile, overridden by a company/env
`.env`, optionally per-installation. Startup-time mutability — changes require an
API restart (`make api`).
- **Consumers:** the State Hub API service; related to the ops-bridge tunnel config
that exposes it to remote machines.
This is a seed example proving the surface-entry schema
([`../../docs/configuration-surface-schema.md`](../../docs/configuration-surface-schema.md)).
The broader Phase 1 seed is ATLAS-WP-0002-T03.