Tutorials¶
Step-by-step tutorials covering single-node operation, multi-node fleet updates, crash recovery, OS reconstruction, portability, and validation labs.
Tutorials vs Runbooks — placement rule¶
Section |
Purpose |
Tone |
Audience state |
|---|---|---|---|
Tutorials |
Teach or validate expected behavior. Demonstrate that the system does what the spec says, with reproducible inputs and observable outputs. |
Indicative, demonstrative. “Here is how it works; here is the evidence it works.” |
Calm, learning, producing evidence. |
Runbooks |
Tell operators what to do during bring-up, incidents, failures, drills, or recovery. |
Imperative. “Run X; check Y; if Z, then…” |
Under time pressure, sometimes under fire. |
If a doc teaches a concept or produces an evidence artifact, it belongs
under Tutorials. If a doc tells someone to type a command right now
to recover or proceed, it belongs under Runbooks. The Demo Runbook is
the canonical example: it walks the operator through make demo-up /
make demo-run step-by-step including failure drills — so it lives
under Runbooks → Demo Runbook, not here.
Installed: the same Demo Runbook documents the installed-operator
equivalents (bash demo/scripts/demo_up.sh plus the three numbered
scripts) in its “Operator paths” preamble; the placement rule applies
to both forms.
Contributor placement guidance for new docs lives at contributing/doc-placement.md.
CE Concepts¶
Numbered conceptual tutorials covering the single-node and multi-node flows on CE-tier (Community Edition) artifacts. These teach the deterministic-relay model end-to-end without requiring a Controlled Deployment / orchestrator / fleet topology.
CE Concepts
- Tutorial 01 — Single Node: Receive, Verify, and Activate Offline
- Tutorial 02 — Multi-Node: Seed Once, Update Everywhere (Peer Propagation)
- Tutorial 03 — Crash and Recovery: WAL + Safe-Point
- Tutorial 04 — OS Replacement Survival and Mission Runtime Reconstruction
- Tutorial 05 — Portability: Run Everywhere (amd64, arm64, riscv64)
- Tutorial — Container Hardening Hands-On
Controlled Concepts — A future group covering orchestrator-backed, fleet-scale concepts (signed-bundle provenance, staged rollout policy, fleet-state derivation, audit-completeness in the controlled deployment). The pages will land here when the Controlled-deployment docs surface stabilizes.
Validation Evidence¶
Validation labs and proof reports — reproducible-input, reproducible-output tutorials that double as evidence artifacts for audit and partner-readiness review. Each page captures a specific claim (rollout latency, HA failover, relay throughput, etc.) and walks through how to produce the evidence.
Validation Evidence
- CLI Audit And Support Bundle Lab
- VAL 01 — Zero-Downtime Certificate Rotation Validation
- VAL 02 — Trust-Chain Rejection Validation
- VAL 03 — RBAC Permission Enforcement Validation
- VAL 04 — Audit Completeness Validation
- VAL 05 — OTel Integration Validation
- VAL 06 — Support Bundle Validation
- VAL 07 — Fleet Rollout Latency Baseline
- VAL 08 — Fleet Rollout Throughput Validation
- VAL 09 — Stuck Rollout Detection Validation
- VAL 10 — Rollback Reliability Validation
- VAL 11 — Fleet Rollout Chaos Test Pack
- VAL 12 — Fleet Rollout 30-Day Soak
- VAL 13 — HA Failover Validation
- VAL 14 — HA Replication Lag Baseline
- VAL 15 — Backup/Restore Validation
- VAL 16 — Split-Brain Chaos Validation
- VAL 17 — Quorum Loss Validation
- VAL 18 — HA 30-Day Soak Validation
- VAL 19 — Relay Local-Network Impairment Validation
- VAL20 — Relay Throughput Benchmark
- VAL21 — Relay Queue Depth and Overflow Validation
- VAL22 — Deadletter Workflow Validation
- VAL23 — Relay Bandwidth Management Validation
- VAL24 — Relay 30-Day Soak Validation
- VAL27 — Relay Proof Report Generator
- VAL25 — Fleet Rollout Proof Report Generator
- VAL26 — HA Proof Report Generator
- VAL28 — Cross-Cutting Proof Report Generator
- VAL29 — AutonomyOps v1 Public-Claim Evidence Matrix
Other Tutorials¶
Mixed-purpose tutorials that don’t yet fit cleanly into CE Concepts
or Validation Evidence. Concept-shaped pages here are candidates for
CE Concepts; the previously-listed runbook-shaped pages
(operator-runbook, orchestrator-ha-runbook,
integrity-failure-drill) have been moved to
Runbooks per the placement rule.
Other Tutorials
- Edge Relay Deadletter Lab
- FI Traceability: Invariant → Test → Expected Output
- Offline-first Runbook: Buffer Then Drain
- Policy Deny in Strict Mode
- Public Claims Correction Package
- Repo Findings Checklist
- Resource Envelope: Disk Ceiling + Eviction Proof
- ROS 2 Governed Bridge Quickstart
- ROS 2 SROS 2 / DDS-Security Quickstart
- Story Script — “Seed Once, Update Everywhere”
- Transport Hardening: mTLS Identity + Domain Boundaries
- AutonomyOps ADK — Tutorial Pack
The HA orchestrator operator runbook is published in the self-hosted tier: see the self-hosted tier site.