feat: add the module configuration and secrets contract
Modules had no way to be told anything. Announcements — the first real product Ekklesia will absorb — has zero environment variables and compiles a LAN IP address into its source, so this is the contract standing between it and the module system. - A module declares what it needs in its manifest, using six bounded types (string, integer, boolean, enum, url, secret) with no nesting and no regular expressions. Static declaration is what lets the platform validate configuration *before* deciding whether a module may start: an enabled module missing a required value is reported `blocked · configuration_missing · <key>` rather than taking startup down from inside its own `start` hook, and Doctor reports the same while still importing no module code. That forces `manifestVersion: 5`, a hard cutover. - Ordinary values persist in one Core table (migration 0005), one row per (module_id, key), stored as text until validated against the declaring module's current manifest. Nothing is coerced; an invalid stored value blocks the module rather than falling back to the default. A key the manifest no longer declares is retained and ignored. - Secrets are never persisted. There is no encryption at rest in this repository, so a `secret` key is deployment-supplied and mapped in by the host under a name the module never sees. A secret declaration has no `default` field, the write API refuses secret material, and the HTTP view has no `value` field for one — absent by construction, not filtered. - Modules receive a frozen `context.config` on the registration, runtime, and HTTP handler contexts: the same object identity, per module, beside `services` rather than inside it (services is deliberately one shared instance). No environment access, no database reference, no way to reach another module's values. - Configuration decides eligibility through ADR 0028's existing resolver: three new blocked reasons, each with a distinct operator fix, propagating to required dependents through the same mechanism as a disabled module. - Changes take effect at the next restart; both resources report restartRequired. New restricted permission `core.modules.configuration.manage`, separate from lifecycle, at the sibling prefix `/api/v1/module-configuration`. - Migration participation stays independent of configuration validity. Endpoints and credentials for shared infrastructure stay platform concerns; a module declares which bucket it needs, not an S3 endpoint. See ADR 0029. Co-Authored-By: Claude Opus 5 <[email protected]>
This commit is contained in:
co-authored by
Claude Opus 5
parent
fdaad58848
commit
baa689b2a7
@@ -329,3 +329,30 @@ Migration discovery still spans the deployed inventory regardless of enablement,
|
||||
composition still spans the whole discovered set. `running` means a module's `start` hook completed
|
||||
and nothing more; there is no runtime health-probe contract. Modules remain trusted compiled code —
|
||||
disabling one is an operational control, never a sandbox. No installer exists.
|
||||
|
||||
Phase 7A pass 2 adds the module configuration and secrets contract
|
||||
([ADR 0029](decisions/0029-module-configuration-and-secrets.md)). A module declares what it needs
|
||||
configured in its manifest — `manifestVersion: 5`, a hard cutover — using six types (`string`,
|
||||
`integer`, `boolean`, `enum`, `url`, `secret`) with bounded constraints and no nesting. Static
|
||||
declaration is what lets the platform validate configuration **before** deciding whether a module may
|
||||
start, so an unconfigured module is reported `blocked · configuration_missing` rather than taking
|
||||
startup down from inside its own `start` hook; discovery, `pnpm modules:validate`, and Doctor all read
|
||||
it while remaining manifest-only.
|
||||
|
||||
Ordinary values are persisted in one Core table, one row per `(module_id, key)`, stored as unvalidated
|
||||
text until checked against the declaring module's current manifest. **Secret values are never
|
||||
persisted**: Ekklesia has no encryption at rest, so a `secret` key is supplied by the deployment and
|
||||
mapped into the module's snapshot by the host, under a name the module never sees. A module receives a
|
||||
frozen `context.config` on its registration, runtime, and HTTP handler contexts — the same object
|
||||
identity across all of them — with no environment access, no database reference, and no way to reach
|
||||
another module's values, which is what keeps the same module implementation runnable under a future
|
||||
standalone host.
|
||||
|
||||
Configuration decides eligibility through ADR 0028's existing resolver rather than a parallel concept:
|
||||
three new blocked reasons (`configuration_missing`, `configuration_invalid`, `secret_missing`) name
|
||||
the offending key, and a configuration-blocked module blocks its required dependents exactly like a
|
||||
disabled one. Changes take effect at the next restart and the API reports `restartRequired`; nothing
|
||||
is hot-reloaded. Migration discovery remains independent of configuration validity, exactly as it is
|
||||
independent of enabled state. Endpoints and credentials for shared infrastructure stay platform
|
||||
concerns — a module declares which bucket it needs, not an S3 endpoint — leaving room for the object
|
||||
storage service Core still does not have. There is no settings UI.
|
||||
|
||||
Reference in New Issue
Block a user