Skip to main content

Crate omnigraph_cluster

Crate omnigraph_cluster 

Source

Modules§

failpoints
Fault-injection hooks for the cluster apply protocol, mirroring the engine’s omnigraph::failpoints pattern. With the failpoints feature off, every call site compiles to Ok(()).

Structs§

ApplyOptions
Config-only cluster apply (Stage 3A): execute the query/policy subset of the plan against the local cluster catalog. The plan is recomputed under the state lock, so freshness is structural; the state CAS inside write_state is the second fence. Graph/schema changes are never executed here — they are deferred to the graph-lifecycle phase and reported loudly.
ApplyOutput
Output of config-only cluster apply. “Applied” means recorded in the local cluster catalog (__cluster/); nothing applied here serves traffic — the server still boots from omnigraph.yaml until the server-boot stage.
ApprovalRequirement
ApproveOutput
BlastRadius
Dependency
DesiredRevision
Diagnostic
EmbeddingProviderConfig
A named cluster embedding provider profile (RFC-012 Phase 5). kind/base_url/ model default exactly as the engine’s EmbeddingConfig::from_env does. api_key, when required, must be a ${NAME} env reference resolved at serving boot, never an inline secret.
ForceUnlockOutput
PlanChange
PlanOutput
ResourceStatusRecord
ResourceSummary
ServingGraph
One graph in a serving snapshot: its id and on-disk root.
ServingPolicy
One policy bundle: its verified catalog blob path and applied bindings (normalized typed refs: cluster | graph.<id>).
ServingQuery
One stored query: its graph binding, registry name, and verified source.
ServingSnapshot
Everything a server needs to boot from the cluster catalog (RFC-005 §D2).
StateObservations
StateSyncOutput
StatusOutput
ValidateOutput

Enums§

ApplyDisposition
How cluster apply treats a planned change in the current stage.
DiagnosticSeverity
PlanMetadataChange
PlanOperation
ResourceLifecycleStatus
StateSyncOperation

Constants§

CLUSTER_APPROVALS_DIR
CLUSTER_CONFIG_FILE
CLUSTER_GRAPHS_DIR
CLUSTER_LOCK_FILE
CLUSTER_RECOVERIES_DIR
CLUSTER_RESOURCES_DIR
CLUSTER_STATE_DIR
CLUSTER_STATE_FILE

Functions§

apply_config_dir
apply_config_dir_with_options
approve_config_dir
Record a digest-bound human approval for a gated (irreversible) change — today: graph deletes. The artifact binds to the exact desired config digest and the change’s before/after digests, so config or state drift invalidates it automatically (a stale approval can never authorize a different change).
cluster_graph_ids
List the graph ids applied in a cluster’s served state (sorted). Reads the ledger only — no catalog validation — like resolve_graph_storage_uri, so it works on a degraded cluster. Used to enumerate candidates when no --graph is selected (RFC-011 Decision 7).
cluster_root_for_graph_uri
Cluster root for a graph storage URI of the cluster layout (<root>/graphs/<id>.omni), if <root> is actually a cluster (holds __cluster/state.json); otherwise None. Used by the CLI to refuse init into a cluster-managed location — graphs there are created by cluster apply, not init.
force_unlock_config_dir
import_config_dir
plan_config_dir
read_serving_snapshot
Read the applied revision as a serving snapshot — the read-only loader for the Phase-5 server boot. Cluster-global readiness failures are still all-or-nothing, but graph-attributed pending recovery sidecars quarantine only that graph so healthy graphs can continue serving. This loader never runs a recovery sweep. Takes no lock: the state file is replaced atomically, so this reads a consistent point-in-time ledger.
read_serving_snapshot_from_storage
Read the applied revision directly from a storage root URI — config-free serving: a --cluster s3://bucket/prefix server needs no local files at all, only the bucket and credentials. The ledger and catalog ARE the deployment artifact.
refresh_config_dir
resolve_graph_storage_uri
Resolve a graph’s storage URI (<root>/graphs/<id>.omni) from a cluster’s applied state ledger — the lightweight path for storage-plane maintenance (optimize/repair/cleanup).
status_config_dir
validate_config_dir