Skip to main content

Module plan

Module plan 

Source
Expand description

One typed document that every landing write comes from.

Three verbs used to walk one projection on three paths, which is three places for a rule to drift. A plan is one place: the engine computes it, an operator reads and approves it, and an apply executes exactly its operations or refuses because its inputs moved.

The document keeps five kinds apart, and an addition inside one kind is additive rather than a new shape:

  • Evidence is what was observed.
  • Analysis is what the engine derived: findings, operations.
  • Policy is the requirement each precondition carries.
  • Decisions are workflow state the operator owns.
  • Postconditions are what proves completion.

The planner is pure. Observation, resolution, and the clock are inputs, so the same inputs produce the same plan and the same fingerprint.

Modules§

apply
Execute exactly one stored plan, or refuse because the world moved.
classify
What a target is, read from the target and never from the request.
compatibility
What a release needs of the engine that lands it.
decision
What the operator decides, and how they say it.
derive
Turn one computed target state into the operations that reach it.
evidence
What the plan observed, and how.
finding
What the corpus says about itself, as far as a program can prove it.
fingerprint
What a plan’s identity is, and what it deliberately ignores.
guidance
What a release asks of an instance that takes it.
observe
What the planner is told, and the one place that reads it.
operation
What a plan will do to a target, as a closed set.
planner
The pure function from what was observed to what will be done.
readiness
Whether a plan may be applied, and what stands in the way.
session
One planning session, from an observed target to a stored plan.
store
Where a computed plan waits for its approval.

Structs§

Declared
How much one release’s declaration covers.
DesiredState
What the plan is aiming at.
Identity
Which plan this is, and what produced it.
ObservedState
What the plan found.
Plan
The whole document.
Postcondition
One typed check the apply runs at the end and reports.
ReleaseSource
Where the release came from, and whether it was verified.

Constants§

PLAN_SCHEMA
The machine schema a plan declares.