operations-runbook

_No description in Cargo.toml._

What it is for

Library crates for operational runbooks.

Runbooks are documented procedures for handling operational tasks. They are content-only (no auto-execute) and designed to guide staff through standard operating procedures.

# Features

• Steps: Ordered instructions with markdown content
• Links: References to documentation, tools, and knowledge base
• Visibility: Control who can see runbooks (staff vs all)
• Categories: Organize runbooks by topic

# Example

use operations_runbook::{Runbook, Step, Link, Visibility, StepType, LinkType};
use uuid::Uuid;

// Create a runbook for password resets
let runbook = Runbook::new(Uuid::new_v4(), "Password Reset", "account")
.with_description("Standard procedure for resetting user passwords")
.with_visibility(Visibility::Staff)
.with_step(
Step::new(Uuid::new_v4(), 1, "Verify Identity", "Ask security questions")
.with_type(StepType::Instruction)
)
.with_step(
Step::new(Uuid::new_v4(), 2, "Note", "Never share the temporary password via email")
.with_type(StepType::Warning)
);

assert_eq!(runbook.step_count(), 2);

Capabilities

No public items.

How to use it

From this crate's own rustdoc:

use operations_runbook::{Runbook, Step, Link, Visibility, StepType, LinkType};
use uuid::Uuid;

// Create a runbook for password resets
let runbook = Runbook::new(Uuid::new_v4(), "Password Reset", "account")
    .with_description("Standard procedure for resetting user passwords")
    .with_visibility(Visibility::Staff)
    .with_step(
        Step::new(Uuid::new_v4(), 1, "Verify Identity", "Ask security questions")
            .with_type(StepType::Instruction)
    )
    .with_step(
        Step::new(Uuid::new_v4(), 2, "Note", "Never share the temporary password via email")
            .with_type(StepType::Warning)
    );

assert_eq!(runbook.step_count(), 2);

Module structure

No public modules: the crate root is its whole surface.

Public surface

No public items.

Re-exports. Exported here, defined elsewhere.

Boundary

Depends on no other workspace tier.

Shares tier operations with 40 other crates: operations-approval-workflow, operations-assessments, operations-block-imaging, operations-boot-media, operations-browser-agent-worker, operations-camera-discovery, operations-camera-liveview, operations-camera-registry, … (40 total).

_What this crate deliberately does NOT own is a judgment. No committed registry records one for it, so none is stated here._

Where it sits

Dependencies

Runtime, from outside the workspace.

Development, from outside the workspace.

Build. None.

Depended on by. 1 workspace crate.

Signal flow — what reaches this crate, and what it reaches.

flowchart LR
  n_application_runbook["application-runbook"] -->|uses| SELF
  SELF["operations-runbook"]
  classDef self fill:#1f883d,stroke:#1f883d,color:#fff;
  class SELF self;

Feature flags

No Cargo features are defined: every capability is unconditional, so no consumer can receive a half-wired crate.

Targets

Error model

No public error type was detected: no public item declares a type named *Error, and no public signature returns one.

Operational characteristics

No unsafe block, unsafe fn, unsafe impl or unsafe trait was found by the parser anywhere in this crate's source.

Configuration

No environment variable is read with a literal name anywhere in this crate. A variable whose key is computed at run time cannot be listed here, and is not claimed to be absent.

Related capabilities

1 workspace crate depends on this one: application-runbook.

Verification

What the tests establish, by name:

• test_create_runbook_input_validation — src/models.rs
• test_link_type_roundtrip — src/models.rs
• test_runbook_builder — src/models.rs
• test_runbook_to_summary — src/models.rs
• test_step_type_roundtrip — src/models.rs
• test_visibility_roundtrip — src/models.rs

Documentation coverage

Metrics

pie showData
    title Rust source composition
    "Code" : 414
    "Blank or comment" : 183

Generation

Rendered by tools-corpus corpus readme from repository evidence alone, renderer schema 2, lexicon current. No model, network service or database was consulted. Regenerate with tools-corpus corpus readme --write; verify with --check.