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§
- apply
- The apply: a stored plan executed exactly, or refused because its inputs moved.
- classify
- Classification: the corpus verdict a target earns before anything lands, and the plan classification derived from it and the record.
- compatibility
- The compatibility axes beyond the payload schema, each evaluated into a precondition with a requirement.
- 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.
- guidance
- The guidance the bundle carries for one target.
- lock
- One target held by one apply at a time.
- 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.
- store
- The plan store: one directory per plan under the state root, holding the plan, the request that computed it, and every byte it names.
Structs§
- Bundle
Identity - One bundle’s identity.
- Choice
- One answer to a decision.
- Compatibility
- What the engine can say about landing this bundle here.
- Configuration
- The landing parameters, resolved, with the layer each one came from.
- Configuration
State - The committed configuration, as found.
- Decision
- One question the operator owns.
- Desired
State - What the target is asked to converge toward.
- Destination
- One destination, as found.
- Destination
Outcome - What the three-way comparison decided for one projected destination.
- Forge
Floor - The forge axis, as declared and observed.
- Generator
Fact - The generator axis, as observed.
- Guidance
- The guidance the bundle carries for this target.
- Guidance
Step - One release’s step, as the target needs it.
- Host
- The engine and the host.
- Identity
- Who computed the plan, when, and under which id.
- Installation
- What release-kit landed at the target.
- Intermediate
Fact - One release the landing must pass through.
- Interval
- The releases a selection spans: above
from, up to and includingto. - Observed
State - What the target was found to be.
- PinState
- The
rkpin a tool manager records. - Plan
- The plan, whole.
- Plan
Request - One request to compute a plan, as the store keeps it beside the plan so an apply can compute the same plan again and compare.
- Planned
- A computed plan with the bytes its operations name, and what the three-way comparison decided per destination, for the fronts that render a per-file report.
- Release
- The candidate bundle and what is known about it.
- Repository
- The repository’s own state, read off the disk and git.
- Resolved
Release - One exact release, resolved at plan time and never again.
Enums§
- Baseline
State - The recorded release’s bundle, as read for the baseline.
- Coverage
- How much of the interval the bundle describes.
coveredwith no step is “no applicable steps”, and it is notunavailable. - Disposition
- The closed set of things the comparison decides for a destination.
- Forge
State - What the forge said, where it was asked.
- Intent
- What the caller asked the plan to be: the open reconciliation, or one of the three fronts, each of which fixes what the plan may contain.
- Postcondition
- One typed check an apply runs at the end and reports.
- Record
State - The landing record, as found.
- Verification
- How a bundle was verified.
Constants§
- DECISION_
CHOICES - Every decision this engine asks, with the closed set of answers each one takes.
- PLAN_
SCHEMA - The version of the plan’s shape.
Functions§
- canonical_
target - One target directory as an absolute, symlink-free path.
- decision_
answered - Whether
answeris one this decision declares. - decision_
choices - The answers one decision takes, where the catalogue names it.