README
¶
Runtime contracts
Dependency-light Go contracts for the runtime boundary between StackKits and
Techstack: stable type identities, closed validation rules, deterministic
digests and Golden JSON. Not a service, control plane, provider adapter or
state store. The packages are part of the StackKits module
(github.com/kombifyio/stackkits/contracts/...) and ship with its versions;
they have no release line of their own.
Packages
Import path (below contracts/) |
Contract | Owner of the authority behind the wire |
|---|---|---|
runtimelease |
Secret-free lease identity, validation, enrollment and signed snapshot DTOs | Techstack: validity, cancellation, desired state, enrollment, persistence |
providerexecutor/v1beta1 |
Provider-neutral commands, receipts, evidence, digesting and lifecycle validation | Techstack: adapter selection, side effects, custody, durable ledger |
runtimeinventory |
Secret-free inventory read model generated from the Techstack inventory schema | Techstack: schema, collection, freshness, authorization |
stackaction |
Action wire generated from foundation/stack_action.cue |
StackKits: lifecycle meaning, validation, execution, evidence |
runtimeexecutor |
Execution SPI for an authorized Apply grant: sealed request, artifact transport, invocation, result digest | Control plane: authorization, registration, retries, state, policy |
runtimeapply |
Durable operation journal and recovery contract for a sealed runtimeexecutor Apply |
Consumer: persistence |
applyevidence |
Producer contract for Ed25519-sealed pre-Apply evidence bundles | Evidence producer: enrollment, keys, observation |
datasubject |
Account export and erasure request, signed receipt and completion rule | Coordinator and participants |
advancedcapability |
Generated Advanced-capability and trust-bundle wire from contract.json |
Techstack issues, StackKits verifies |
compatibility/ holds the consumer lock schema; it is not a Go package.
Boundary
- Contract sources import only the standard library,
github.com/google/uuidand other packages belowcontracts/. They carry no transport, database or process execution and name only reserved example hosts in URL literals.mise run contracts:checkenforces this together with the generation checks below. - No credential, provider SDK, adapter registry, database or product state belongs here. Wallet host delivery is outside these packages: no secret belongs in a fixture, command, log or receipt.
- No alias or wrapper exists for
vmlease,runtimeaction,serverruntimeor a previous provider-executor wire.
Generated packages
stackaction: editfoundation/stack_action.cueand runmise run contracts:stackaction:generate; the generator writes the bundle (contract.ir.json,openapi.yaml,stackaction_gen.go,manifest.json) in place.mise run contracts:stackaction:checkfails on drift.advancedcapability: editadvancedcapability/contract.jsonand runmise run contracts:advancedcapability:generate; never edit the generated outputs.runtimeinventory: generated in Techstack from its inventory schema; the checked-inmanifest.jsonbinds the schema andtypes.godigests.
Compatibility
JSON names, enum values, API and wire version strings, validation outcomes,
digest inputs and Golden fixtures are compatibility contracts. An additive
change keeps all of them and adds only optional fields. A breaking change
introduces a new contract version (a new import path) with before and after
Golden evidence and migrates every consumer directly, with no retired alias.
A consumer binds the exact StackKits module version and checksum in its lock
(compatibility/consumer-lock.schema.json) and exercises the fixtures it uses.
Apache-2.0, see LICENSE.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package advancedcapability is the generated wire contract for the short-lived, secret-free capabilities that authorize individual StackKits Advanced operations (stackkit.advanced-capability/v1) and for the Owner-imported trust bundle that verifies them offline (stackkit.advanced-trust-bundle/v1).
|
Package advancedcapability is the generated wire contract for the short-lived, secret-free capabilities that authorize individual StackKits Advanced operations (stackkit.advanced-capability/v1) and for the Owner-imported trust bundle that verifies them offline (stackkit.advanced-trust-bundle/v1). |
|
Package applyevidence defines the provider-neutral producer wire contract for StackKits Architecture-v2 pre-Apply evidence.
|
Package applyevidence defines the provider-neutral producer wire contract for StackKits Architecture-v2 pre-Apply evidence. |
|
Package datasubject defines the shared wire contract for account export and erasure requests between the Cloud coordinator and every service that stores data about a subject.
|
Package datasubject defines the shared wire contract for account export and erasure requests between the Cloud coordinator and every service that stores data about a subject. |
|
internal
|
|
|
cmd/advancedcapabilitygen
command
Command advancedcapabilitygen projects the canonical Advanced-capability contract source (contracts/advancedcapability/contract.json) into its generated Go package file, JSON Schema, signed conformance fixtures, and a generation manifest that binds every output to the source by SHA-256.
|
Command advancedcapabilitygen projects the canonical Advanced-capability contract source (contracts/advancedcapability/contract.json) into its generated Go package file, JSON Schema, signed conformance fixtures, and a generation manifest that binds every output to the source by SHA-256. |
|
cmd/contractcheck
command
Command contractcheck enforces the runtime contract boundary below contracts/: package imports, retired namespaces, package-root classification, URL literals and the Runtime Inventory generation digests.
|
Command contractcheck enforces the runtime contract boundary below contracts/: package imports, retired namespaces, package-root classification, URL literals and the Runtime Inventory generation digests. |
|
referenceid
Package referenceid contains the closed grammars shared by otherwise independent provider-free wire packages.
|
Package referenceid contains the closed grammars shared by otherwise independent provider-free wire packages. |
|
providerexecutor
|
|
|
v1beta1
Package providerexecutor defines the provider-neutral execution contract for infrastructure lifecycle operations.
|
Package providerexecutor defines the provider-neutral execution contract for infrastructure lifecycle operations. |
|
Package runtimeapply defines the provider-neutral durable operation journal contract for a sealed runtimeexecutor Apply.
|
Package runtimeapply defines the provider-neutral durable operation journal contract for a sealed runtimeexecutor Apply. |
|
Package runtimeexecutor defines the provider-neutral v1beta1 contract for executing already-authorized governed runtime targets.
|
Package runtimeexecutor defines the provider-neutral v1beta1 contract for executing already-authorized governed runtime targets. |
|
Package runtimeinventory defines the dependency-free, secret-free Go wire model for reading Kombify runtime inventory.
|
Package runtimeinventory defines the dependency-free, secret-free Go wire model for reading Kombify runtime inventory. |
|
Package runtimelease defines the shared runtime-lease wire contract.
|
Package runtimelease defines the shared runtime-lease wire contract. |
|
Package stackaction contains the deterministic Go projection of the StackKits-owned StackAction CUE contract.
|
Package stackaction contains the deterministic Go projection of the StackKits-owned StackAction CUE contract. |
Click to show internal directories.
Click to hide internal directories.