Skip to content

Add content API runbook - #446

Merged
kenoir merged 10 commits into
mainfrom
rk-6792-content-api-runbook
Nov 16, 2026
Merged

kenoir merged 10 commits into
mainfrom
rk-6792-content-api-runbook

Conversation

@kenoir

@kenoir kenoir commented Nov 13, 2026

Copy link
Copy Markdown
Contributor

What does this change?

Adds docs/runbook.md for the content API (API, pipeline, webhook, unpublisher and Prismic backups) and a Runbook link on the content-api System in manifest.yml.

How to test

Read the runbook on the branch. The Runbook link shows on the Backplane entity page once merged.

Have we considered potential risks?

Docs and catalogue metadata only, no code or deploy changes.

Adds a runbook for the content API and links it from the System in
manifest.yml.

For wellcomecollection/platform#6792, part of wellcomecollection/platform#6790.
@kenoir
kenoir requested a review from a team as a code owner November 13, 2026 13:42
Copilot AI balanced review requested due to automatic review settings November 13, 2026 13:42

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The runbook’s inaccurate guidance on unpublishing, deletion recovery, and snapshot recency could misdirect incident diagnosis and content restoration.

3 open issues
What changed in this PR

Adds an operational runbook for the Content API and its supporting services, with a Backplane link so responders can find it. This is documentation and catalogue metadata only; runtime behaviour and deployment configuration are unchanged.

Changes:

  • Documents service architecture, alerts, troubleshooting, recovery and rollback procedures.
  • Links to dependency status pages and incident escalation guidance.
  • Adds a Runbook link to the content-api System metadata.
File Description
manifest.yml Adds the System’s Backplane Runbook link.
docs/​runbook.md Adds operational guidance for the API, pipeline, webhook, unpublisher and Prismic backups.

Review effort: Balanced

Comment thread docs/runbook.md Resolved
Comment thread docs/runbook.md Resolved
Comment thread docs/runbook.md Resolved
@rcantin-w rcantin-w self-assigned this Nov 16, 2026

@rcantin-w rcantin-w left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude suggested a change to the Readme that was contradicting the runbook, also suggesting we add a link to said runbook.

## Developing

- Deployment is all done in CI, see `.buildkite/pipeline.yml` — except the Prismic backup Lambdas and the Terraform in `infrastructure/`, which are deployed from a laptop
- `husky` will set up a pre-commit hook for autoformatting when you first install dependencies
- [Runbook](docs/runbook.md): alarms, common failures, rollback

Comment thread docs/runbook.md Resolved
Comment thread docs/runbook.md Resolved
Comment thread docs/runbook.md Resolved
kenoir and others added 3 commits November 16, 2026 11:30
Co-authored-by: Raphaelle Cantin <110461050+rcantin-w@users.noreply.github.com>
Also say which parts of the README deploy outside CI and link the runbook.
@kenoir

kenoir commented Nov 16, 2026

Copy link
Copy Markdown
Contributor Author

Thanks, applied in 3acfe90: the README now says which parts deploy from a laptop and links the runbook.

@rcantin-w rcantin-w assigned kenoir and unassigned rcantin-w Nov 16, 2026
@kenoir
kenoir merged commit e9ec380 into main Nov 16, 2026
8 checks passed
@kenoir
kenoir deleted the rk-6792-content-api-runbook branch November 16, 2026 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants