Skip to main content

Module plan

Module plan 

Source
Expand description

The plan: one typed, immutable document that is the input to every landing write.

The document keeps five kinds apart, and an addition inside one kind is additive. Evidence is what was observed. Analysis is what the engine derived from it: the operations, the compatibility, the guidance. Policy is the requirement each precondition carries. Decisions are workflow state the operator owns. Postconditions are what proves completion. rk reconcile plan computes one and prints it; nothing here writes into a target.

Re-exports§

pub use classify::Classification;
pub use classify::Finding;
pub use classify::Verdict;
pub use evidence::EvidenceItem;
pub use evidence::EvidenceKind;
pub use operation::Operation;
pub use readiness::Evaluation;
pub use readiness::Precondition;
pub use readiness::Readiness;
pub use readiness::Requirement;

Modules§

classify
Classification: the corpus verdict a target earns before anything lands, and the plan classification derived from it and the record.
evidence
The evidence ledger: every observed value, with who observed it, when, how, and what it digested to.
fingerprint
The input fingerprint: one canonical digest over the semantic inputs of a plan, and nothing else.
gather
The observation: everything the planner reads off the target, the host, and — where asked — the forge, gathered once and stamped in the evidence ledger.
operation
The closed set of things an apply may do.
planner
The pure planner: from an observation, a desired state, and two bundles read through the seam, one plan.
readiness
The readiness policy: what a plan’s preconditions require, what each one was found to be, and the one derivation that turns the two into a verdict.

Structs§

BundleIdentity
One bundle’s identity.
Choice
One answer to a decision.
Compatibility
What the engine can say about reading this bundle.
Configuration
The landing parameters, resolved, with the layer each one came from.
ConfigurationState
The committed configuration, as found.
Decision
One question the operator owns.
DesiredState
What the target is asked to converge toward.
Destination
One destination, as found.
Guidance
The guidance the bundle carries for this target.
Host
The engine and the host.
Identity
Who computed the plan, when, and under which id.
Installation
What release-kit landed at the target.
ObservedState
What the target was found to be.
PinState
The rk pin a tool manager records.
Plan
The plan, whole.
Planned
A computed plan with the bytes its operations name.
Release
The candidate bundle and what is known about it.
Repository
The repository’s own state, read off the disk and git.
ResolvedRelease
One exact release, resolved at plan time and never again.

Enums§

BaselineState
The recorded release’s bundle, as read for the baseline.
ForgeState
What the forge said, where it was asked.
Postcondition
One typed check an apply runs at the end and reports.
RecordState
The landing record, as found.
Verification
How a bundle was verified.

Constants§

PLAN_SCHEMA
The version of the plan’s shape.