weave
module · Comms & Incident

Statuspage

Statuspage — components, incidents, maintenances

Namespace: weave statuspage Env: STATUSPAGE_API_KEY
4
Commands
1
State kinds
Comms & Incident
Category
1
API docs

Setup

Configure credentials via environment variables. We recommend sourcing them through 1Password or your secrets manager rather than committing them to the shell rc.

Official API reference

weave commands for this module are checked against the vendor's published API.

Variable Description Status
STATUSPAGE_API_KEYRequired for authentication.required
STATUSPAGE_PAGE_IDRequired for authentication.required

Sanity-check the wiring:

weave secrets check
weave statuspage --help
weave doctor   # reports STATUSPAGE_API_KEY status

Capabilities

What this module can do, by entity and verb. means a working CLI surface; · means not (yet) wired.

Entity findlistshowdosnapshotdiffapply
component···
incident·····

Commands

Every registered CLI command, grouped by verb. Each example uses placeholder arguments — substitute real values for your environment.

list (2)

list components

read

List page components.

weave statuspage list components <arg>

list incidents

read

List recent incidents.

weave statuspage list incidents <arg>

do (2)

do create-incident

write

Open a new incident (status: investigating).

weave statuspage do create-incident <name>

do resolve-incident

write

Resolve an open incident.

weave statuspage do resolve-incident <incident-id>
snapshot / diff / apply are generated automatically from the State Kinds declared on this module — see the State kinds section below for per-kind details. Workflow: snapshot → edit YAML → diffapply --yes (or confirm interactively; apply --dry-run previews the same diff).

State kinds

Resources this module can snapshot and diff; apply where the kind supports live writes (see Round-trip per kind). Always run diff before apply; use --yes in automation after review. Files live under .weave-state/statuspage/.

This module is on the thinner integration path — use snapshot / diff for audit; confirm apply per kind below before relying on writes.

components

snapshot diff apply

Statuspage components — rename / set status via PATCH.

Scope
Round-trip
Full round-trip — snapshot, diff, apply.

State file skeleton

module: statuspage
kind: components
items:
  - # <fields specific to this kind — see snapshot output>

Workflows

End-to-end recipes from operators who already run this module in production. Copy, adapt, and put under change-control.

Resources audit

Snapshot and diff resources.

weave statuspage snapshot resources
$EDITOR .weave-state/statuspage/resources.yaml
weave statuspage diff resources
weave statuspage apply resources

Terraform parity

For each Terraform resource in the canonical provider, here's the equivalent live-API verb in weave. Use this as a migration cheat-sheet, not a 1:1 contract — weave deliberately stays in the live-state lane, not the desired-state lane.

Terraform resource weave equivalent
statuspage_resourcesweave statuspage snapshot/diff/apply resources
Snapshot/diff for audit; confirm apply on the module page.

Troubleshooting & source

Missing credentials

Run weave doctor — it reports which env vars (including STATUSPAGE_API_KEY) are set and which are blank.

Unexpected behaviour from a state apply

Re-run weave statuspage diff <kind> to confirm the controller's current state, then re-snapshot before the next apply. The driver always re-snapshots before diffing.