Skip to main content

Module manifest

Module manifest 

Source
Expand description

Capability manifest schema for subc modules.

All v1 modules are supervised singletons: one long-lived process per per-user machine. The manifest intentionally has no cardinality field. subc routes by module kind plus channel, while any finer demultiplexing (for example, AFT’s per-project actor map) remains internal to the singleton module.

Structs§

Bindings
External storage, vault, and identity bindings supplied through subc.
CapabilityDeclarations
Static, versioned capabilities declared by a module.
CapabilityGrammarError
A safe-to-report capability-schema validation failure.
CapabilityRequirement
One capability a module consumes and whether its absence is tolerated.
IdentityBinding
ManagementOperation
Operation exposed on the management plane.
ManifestProvenance
Build facts a module DECLARES about its own binary at HELLO. The daemon overlays process-identity evidence it alone can attest; the two halves are served together via supervisor.provenance and never merged.
ManifestProvenanceError
ModuleManifest
A module’s full declared participation in the subc mesh.
ModuleManifestBuilder
Incrementally constructs a ModuleManifest without fabricating absent facts.
ObservabilitySurface
Observable state exposed on the management plane.
PipelineAppliesTo
Provider/model selector for a pipeline stage. "*" denotes wildcard.
ProvenanceFormError
A declared build fact did not use its canonical form.
SelfSignalDeclaration
A declared periodic or event-driven behavior that shapes an external surface.
SelfSignalDeclarationError
A raw HELLO declaration error that can be reported before serde drops context.
StorageBinding
Storage backend supplied by subc; the module owns its schema.
Tool
Tool-plane capability exposed by a tool_provider.
VaultGrant

Enums§

BuildGitShaAbsenceReason
A build pipeline’s reason for omitting build_git_sha.
BuildGitShaSource
How the build pipeline obtained (or did not obtain) git revision data.
CapabilityNeed
Closed capability requirement strength vocabulary.
Concurrency
How subc may deliver concurrent in-flight calls to the provider.
ConsumerRole
Consumer capabilities requested by a module.
ExecutionMode
How a tool’s side effects are fenced for durable at-most-once handling.
GitTreeState
The observable state of a git worktree when a build pipeline found a revision.
IdentityScope
A BindIdentity key a provider partitions its state or answers by.
InternalTransport
ManagementOperationKind
ObservabilityKind
PipelineStageKind
Proxy-plane stage kind.
ProviderRole
Provider capabilities exposed by a module.
SelfSignalEffect
The effect a self-signal has on the external surface it targets.
SelfSignalKind
Informative class of a self-signal, tolerant of newer wire values.
SignalAnchor
What establishes a self-signal’s cadence relative to the external surface.
SignalCadence
How a self-signal’s effective cadence is declared.
StorageKind
StorageScope
TrustTier
How this module was sourced, as declared by the module itself.

Constants§

PROVENANCE_SENTINELS
Sentinel strings that build tooling emits where it means “no value”: shell fallbacks and Makefile defaults produce unknown, wire vocabulary uses unavailable, and git describe failures surface as none. Publishing any of them as a fact is the well-formed-lie shape the provenance contract warns against — a present, well-formed field stops the reader asking — so the helper maps them all to field omission. Matched case-insensitively because UNKNOWN/Unknown are equally common from shell fallbacks.

Functions§

attestable_commit
Return a commit only when its source tree was clean at build time.
build_provenance
Build ManifestProvenance from legacy raw build facts.
build_provenance_from_source
Build a ManifestProvenance from source-state-aware build facts.
is_valid_capability_identifier
Return whether identifier has the exact <name>/v<N> capability spelling.
validate_hello_capability_grammar
Validate capability grammar in a raw HELLO body.
validate_hello_self_signal_declarations
Reject raw HELLO self-signal declarations that omit effect or anchored_to.
validate_manifest_capability_grammar
Validate capability grammar in a standalone manifest JSON value.