Skip to main content

Module contract

Module contract 

Source
Expand description

Stable serialized configuration and artifact contract.

Concrete ownership is split by concern while this module remains the deliberate public contract surface consumed by application and adapters.

Structs§

ArtifactBinding
ArtifactFile
ArtifactManifest
ArtifactSet
CanonicalConfig
ConfigMetadata
ConfigSpec
ContractValidationError
DeploymentTarget
ErrorEnvelope
ErrorMetadata
ErrorSpec
Machine
ManifestMetadata
ManifestSpec
OperationSet
ProviderInstance
ProviderOwnedResource
Provider-owned resource envelope: common fields for core; desired is the full wire document for the owning provider (opaque vendor schema).
SecretBinding
SecretResolverInstance
Pinned secret resolver/sink executable declared in canonical configuration.
SyntheticResource

Enums§

CanonicalKind
ErrorCategory
ErrorKind
ManifestKind
Resource
Canonical resource. Only core lifecycle kinds remain first-party. All infrastructure/vendor kinds (PVE, PBS, Headscale, …) that declare a provider instance are Resource::ProviderOwned envelopes: core sees association and secret fields only; vendor schema is owned by the provider handshake.

Constants§

API_VERSION
NXD_KEXEC_AARCH64_ARTIFACT_SET_ID
NXD_KEXEC_ARTIFACT_SET_ID
NXD_KEXEC_X86_64_ARTIFACT_SET_ID
PROVIDER_PROTOCOL_V1
Supported provider protocol identifiers in canonical configuration.
SECRET_PROTOCOL_V1
Supported secret resolver protocol identifier in canonical configuration.

Functions§

canonical_json
canonicalize_json_value
nxd_kexec_artifact_set_id
parse_artifact_manifest
parse_canonical_config
resource_associated_deployment_target
Explicit lifecycle association to a deployment target, if any.
resource_depends_on
Declared dependency edges for graph validation / action rewrite.
resource_desired
Full desired JSON document for provider-owned resources.
resource_id
Stable resource id for any resource variant.
resource_kind
Wire kind for a provider-owned envelope (guest, backupJob, …).
resource_provider
Owning provider instance id when the resource is provider-routed.
resource_secret_binding
Optional confidential binding declared on the resource (ensure/mint producers).
validate_canonical_config