Module contracts

Normative module contracts define module behaviour, interfaces, dependencies, and evidence requirements.

Module contracts are not runbooks. Operator procedures belong under runbooks. Task-focused walkthroughs belong under HOWTO content.

Scope

A module contract specifies:

• module identity and lifecycle entry points
• required inputs and supported overrides
• dependencies on init targets and drivers
• produced outputs and evidence requirements
• failure semantics and security rules
• change control expectations

Related contracts

• Global init behaviour: hyops init
• Init target prerequisites: init annexes
• Driver interfaces: driver contracts

Placement

• Template: module contract template
• Module-specific contracts: 2026E/<module>.md (by epoch)

Current draft target-state module contracts:

• 2026E/org-gcp-cloudsql-postgresql.md
• 2026E/platform-onprem-postgresql-dr-source.md
• 2026E/org-gcp-cloudsql-external-replica.md
• 2026E/core-onprem-vyos-template-seed.md
• 2026E/core-onprem-vyos-template-import.md
• 2026E/platform-onprem-vyos-edge.md

Standards

• Normative language only: MUST, MUST NOT, SHOULD, MAY.
• Contracts define stable behaviour and interfaces, not implementation detail.
• Outputs and evidence paths MUST be expressed relative to the runtime root where applicable.
• References to runbooks and HOWTOs SHOULD link to canonical pages where available.