Skip to content

Runes

To add typed configuration, define and register Rune schemas. Phoenix's configuration module is a working example: ObservabilityConfig has path_fragment = Path("observability") and PhoenixSettings adds Path("phoenix"), forming observability/phoenix. The branch cannot own TOML; the leaf can. The registration shim adds both schemas.

Give the contribution a typed Rune

A Rune is a frozen, validated top-level TOML instance. The integration fixture writes an active document at <Codex>/runes/observability/phoenix/desk.toml:

name = "desk-eye"
ui_port = 16006
otlp_port = 14317

[quadlet]
image = "docker.io/arize-ai/phoenix:latest"

PhoenixSettings rejects unknown fields and validates name as a safe service identity. The example overrides the default name and ports; the image repeats the typed default. The loader derives source_file from the path; do not put it in TOML. This example is configuration, not a pull or live-service receipt.

The schema supplies a sample_template whose rendered sample is inactive when its first nonempty line is exactly:

# lychd: sample-rune

Remove the marker in a configured document to activate it. An absent or marked sample Rune produces no Phoenix container even when the package is selected. Codex owns configuration, Rune operations, and binding; Services follows the active Rune into projection.

The configuration integration test checks registered schemas and provenance, inactive samples, the frozen active Rune and its exact source_file. Run it and the extension unit tests using the command in Lifecycle.