Expand description
Application artifact update, activation and rollback lifecycle.
The Runtime treats artifacts as opaque bytes. It verifies generic identity, compatibility and integrity but never knows application code or business data.
Structs§
- Activation
Evidence - Host evidence returned after an adapter activates an artifact.
- Activation
Receipt - Receipt required to commit or roll back one activation.
- Activation
Receipt V2 - Versioned V2 activation receipt kept separately from the V1 receipt.
- Activation
Request - Runtime-owned context passed to a host activation adapter.
- Artifact
Chunk Request V2 - Path-free bounded byte-range request carried by a Peer RPC V2 stream.
- Artifact
Chunk Response V2 - Metadata repeated beside the decoded bytes in a Peer RPC V2 response stream.
- Artifact
Descriptor - Immutable application artifact published by an update provider.
- Artifact
Offer Request V2 - Path-free offer metadata sent through a Peer RPC V2 request stream.
- Artifact
Offer Response V2 - Response metadata for an artifact offer.
- Artifact
Target - Platform and packaging target for one published artifact.
- Artifact
Transfer Policy - Transfer limits applied before reading or allocating a chunk.
- Artifact
Trust Policy - Deployment-owned allowlist applied before signature verification.
- Cache
Options - Configuration for one bounded update cache.
- Cached
Artifact - A fully verified artifact published by
UpdateCache. - Catalog
Entry - One signed descriptor and its location relative to the catalog root.
- Ed25519
Artifact Verifier - Ed25519 verifier backed by deployment-owned public trust roots.
- File
Artifact Source - Local file source for bounded artifact transfer.
- File
Artifact Store - Filesystem artifact store using atomic pointer replacement.
- File
Recovery Store - Filesystem journal for the additive V2 recovery contract.
- File
Update Provider - Local-first update provider backed by a bounded JSON artifact index.
- File
Update Provider Factory - Factory for the local-first file update provider.
- Host
Update Flow - One deployment-owned adapter composition. Use a single external process lock for the journal and host operation. This type never acquires a hidden lock, starts a process, selects providers or performs a domain migration.
- Latest
Compatible Offer Request V2 - Requests the latest signed release compatible with a Runtime host.
- Latest
Compatible Offer Response V2 - Latest compatible signed descriptor selected by an update peer.
- Latest
Compatible Update Identity - Query used to select the latest release compatible with a Runtime host.
- Mobile
Update Policy - Explicit mobile update policy with no store or installer implementation.
- Mobile
Update Request - Request context used to evaluate one mobile update offer.
- NoUpdate
Faults - Fault injector that never interrupts production execution.
- Policy
Artifact Verifier - Composes deployment allowlists with a cryptographic verifier.
- Quarantine
Exclusion - One catalog release excluded by active quarantine.
- Quarantine
Key - Complete release identity used as the quarantine key.
- Quarantine
Record - Persisted bounded quarantine entry.
- Quarantine
Selection - Selection result with bounded quarantine explanations.
- Quarantine
Store - Bounded, restart-persistent quarantine store.
- Recovery
Result - Result of an explicit recovery action.
- Release
Catalog - Validated catalog of signed, platform-specific artifact descriptors.
- Release
Catalog Store - Persistent catalog that serves bytes only for catalog-owned descriptors.
- Staged
Artifact - Opaque staged artifact owned by an artifact store.
- Update
Cache - Filesystem cache for resumable, opaque artifact downloads.
- Update
Coordinator - Coordinates provider, store, integrity, health and rollback boundaries.
- Update
Identity - Local identity used to select one compatible release.
- Update
Request - Query used to select an update candidate.
Enums§
- Activation
Phase V2 - Persisted phase of one V2 activation attempt.
- Artifact
Peer Status V2 - Typed status returned by an update peer before byte streaming begins.
- Mobile
Update Action - Mobile update action owned by the deployment or platform distribution.
- Mobile
Update Decision - Result of the bounded mobile update compatibility gate.
- Quarantine
Reason - Typed reason why a release was quarantined.
- Quarantine
State - Current state of a quarantine entry.
- Recovery
Action - Explicit host action applied to a V2 recovery receipt.
- Recovery
Decision - Read-only conclusion from one recovery inspection.
- Signing
KeyStatus - Lifecycle status of one deployment-owned artifact signing key.
- Update
Error - Update lifecycle failure.
- Update
Fault Point - Controlled lifecycle points available to fault-injection tests.
- Update
Outcome - Final result of one update attempt.
- Update
Preparation - Result of staging and activating an update before process-level health verification.
- Update
Staging - Result of candidate verification and staging before activation.
Constants§
- ACTIVATION_
V2_ FORMAT_ VERSION - Version of the additive activation recovery journal.
- DEFAULT_
ARTIFACT_ CHUNK_ BYTES - Conservative default maximum decoded chunk size.
- FILE_
UPDATE_ PROVIDER_ ID - Provider ID for the local-first JSON index and file artifact adapter.
- QUARANTINE_
FORMAT_ VERSION - Version of the persistent quarantine document.
- QUARANTINE_
MAX_ ENTRIES - Maximum number of release keys accepted by one store.
- RELEASE_
CATALOG_ MAX_ BYTES - Maximum encoded catalog size accepted by the built-in reader.
- RELEASE_
CATALOG_ MAX_ ENTRIES - Maximum number of entries retained by one catalog.
- UPDATE_
CHUNK_ CAPABILITY - Capability used to request one bounded artifact byte range.
- UPDATE_
METADATA_ FORMAT_ VERSION - Stable format version for update pointers and pending activation metadata.
- UPDATE_
OFFER_ CAPABILITY - Capability used to negotiate availability of one immutable artifact.
- UPDATE_
PEER_ METADATA_ MAX_ BYTES - Maximum serialized metadata accepted by the update payload contracts.
Traits§
- Activation
Adapter - Generic host adapter for prepare, activation, health, commit, rollback and recovery.
When composed by
HostUpdateFlow, every boundary must be bounded and idempotent for the same attempt/artifact identity. Inspect actual host state before changing an interrupted attempt; prepared intent does not prove that activation has not happened. Preserve previous artifacts through recovery. - Activation
Health Check - Health gate executed after an artifact becomes active.
- Artifact
Authenticity Verifier - Verifies that an artifact descriptor was published by a trusted identity.
- Artifact
Source - Reads bounded chunks for one immutable artifact.
- Artifact
Store - Store contract for atomic staging and reversible activation.
- Artifact
Writer - Receives chunks without activating or installing the artifact.
- Update
Fault Injector - Fault-injection contract used by deterministic update tests.
- Update
Provider - Provider contract for listing and fetching opaque application artifacts.
- Update
Recovery Gate - Host-owned write exclusion and data recovery preparation. Implementations must impose deadlines, persist installation-bound backups, and keep normal writes blocked on every ambiguous result, including restart.
Functions§
- artifact_
signing_ payload - Builds the stable byte payload covered by an artifact signature.
- receive_
artifact - Receives and verifies one complete artifact through a bounded stream.
Type Aliases§
- Shared
Update Provider - Shared update provider interface produced by deployment factories.
- Update
Result - Result returned by the update lifecycle.