Skip to main content

Module orchestration

Module orchestration 

Source
Expand description

The orchestration piece of the ontology (docs/ONTOLOGY.md §2.7, docs/ORCHESTRATOR-IR.md §2): a harness’s operational home as ONE typed value. These are the records the orchestrator loads, steps and saves; a Hermes or OpenClaw home compiles into them and decompiles back (the codecs are ONT-3’s). The wire form is the orchestrator IR’s canonical JSON: the runtime half is never persisted and is not here.

Re-exports§

pub use access::Access;
pub use access::AccessPolicy;
pub use access::PendingPairing;
pub use channel::ChannelConfig;
pub use fire::Fire;
pub use fire::FireStatus;
pub use job::Job;
pub use job::JobOrigin;
pub use job::Repeat;
pub use job::Schedule;
pub use job::Target;
pub use obligation::Attachment;
pub use obligation::Obligation;
pub use obligation::ObligationSource;
pub use obligation::ObligationState;
pub use obligation::OutboundContent;
pub use obligation::Posted;
pub use profile::ExpiryPolicy;
pub use profile::ExpiryScope;
pub use profile::Orchestration;
pub use profile::PersonaRef;
pub use profile::Profile;
pub use profile::ProfileResidue;
pub use route::resolve_route;
pub use route::route_specificity;
pub use route::Route;
pub use route::RouteMatch;
pub use subscription::WebhookSubscription;
pub use worker::EnvValue;
pub use worker::PermissionDefault;
pub use worker::PermissionPolicy;
pub use worker::WorkerSpec;

Modules§

access
Allowlists, admins and pairing (§2.4; Hermes gateway “Security & Access”).
channel
A channel: one platform block of config.yaml (§2.4). Credential values never enter the model; they are references.
codec
The orchestration codecs (docs/ONTOLOGY.md §2.5, §3): a home folder ⇄ [Orchestration].
fire
Fires: one execution of a job (§2.6; Hermes cron/executions.db).
job
Scheduled jobs (§2.6; Hermes cron/jobs.json).
obligation
Delivery obligations (§2.6; Hermes delivery_obligations).
profile
The home and its profiles (§2.1): the root folder IS the default profile; profiles/<name>/ are the named ones.
route
Routes: which profile answers a surface (§2.3, Hermes gateway.profile_routes).
subscription
Webhook subscriptions (§2.6; Hermes webhook_subscriptions.json).
worker
The worker: which harness runs a profile’s conversations, and how (§2.2).

Constants§

RECORDS
Every name schema_for answers.

Functions§

schema
The JSON Schema of the whole orchestration value, with every record it contains as a definition — what supercode ontology schema prints and what the TypeScript types are generated from (ONT-6).
schema_for
The schema of one record by name, for readers who want a single type.