Anolis Docs

Appearance

Runtime Configuration ​

Anolis runtime is configured with YAML.

Contract authority is machine-validated:

  1. schemas/runtime/runtime-config.schema.json
  2. tests/contracts/runtime-config/validate-runtime-configs.py
  3. anolis-runtime --check-config (semantic/load-time checks)

Use this document for authoring workflow and operational guidance.

Where Runtime YAML Lives ​

  1. Checked-in examples: config/anolis-runtime*.yaml, config/**/anolis-runtime*.yaml
  2. Commissioning-generated outputs are managed in anolis-workbench and are intentionally not tracked in this repository.

Out of scope for this contract:

  1. Provider-local YAML (provider-*.yaml)
  2. Telemetry-export tool YAML (telemetry-export*.yaml)

Authoring Workflow ​

  1. Start from a known profile (manual, telemetry, automation, full variants when available).
  2. Edit runtime concerns only in runtime YAML.
  3. Validate schema fixtures:
    • python3 tests/contracts/runtime-config/validate-runtime-configs.py
  4. Validate runtime semantics:
    • anolis-runtime --check-config --config <path>
  5. Run runtime normally after both checks pass.

Minimal Runtime Skeleton ​

yaml
runtime:
  name: anolis-main

http:
  enabled: true
  bind: 127.0.0.1
  port: 8080

providers:
  - id: sim0
    command: ./build/dev-release/anolis-provider-sim

polling:
  interval_ms: 500

logging:
  level: info

telemetry:
  enabled: false

automation:
  enabled: false

Operational Notes ​

Runtime modes ​

  1. Startup mode is always IDLE (not YAML-configurable).
  2. Mode changes happen at runtime via POST /v0/mode.
  3. IDLE blocks control operations; AUTO applies manual-call gating policy.
  4. FAULT is a recovery mode with constrained transitions (FAULT -> MANUAL only).
  5. See automation.md for full mode semantics.

HTTP and CORS ​

  1. http.cors_allowed_origins should be explicit in non-dev environments.
  2. Wildcard origin (*) cannot be combined with cors_allow_credentials: true.

Providers and supervision ​

  1. Provider IDs must be unique.
  2. Provider command is required.
  3. Restart policy is optional but recommended for hardware processes.

Telemetry ​

  1. Telemetry is off by default.
  2. Use nested telemetry.influxdb.* settings.
  3. Flat telemetry.influx_* keys remain accepted for compatibility, but are deprecated.

Compatibility behavior ​

  1. Unknown keys are warn-and-ignore for forward compatibility.
  2. automation.behavior_tree_path is an accepted alias for automation.behavior_tree.
  3. runtime.mode in YAML is rejected.
  1. configuration-schema.md - compact section-by-section schema narrative.
  2. docs/contracts/runtime-config-baseline.md - locked behavior baseline.
  3. schemas/README.md - canonical schema and validator map.