Skip to content

Write the Admin Operations and Incident Response Runbook #468

Description

@codebestia

Document the routine and emergency operations the protocol admin performs day to day — fee changes, token listing, merchant status changes, role management — and the incident response procedure when something goes wrong.

Proposed steps:

  • Create docs/operations/admin-runbook.md.
  • Document routine procedures with exact commands and verification steps: changing a fee via propose_fee/execute_fee, listing and de-listing tokens, activating/deactivating and verifying merchants, granting and revoking roles, and rotating the platform account.
  • Document the admin key custody policy, approval requirements, and change-log expectations for every privileged action.
  • Document the incident response procedure: detection signals, the decision criteria for pausing, the pause execution steps, triage and diagnosis using on-chain reads and events, remediation options, and the criteria for unpausing.
  • Document severity levels with target response times and the escalation path.
  • Document the post-incident process: timeline reconstruction from events, merchant communication, and remediation follow-ups.
  • Cross-link the pausable, admin transfer, upgrade runbook, and threat model documents.

Acceptance criteria:

  • docs/operations/admin-runbook.md exists.
  • Every routine admin procedure is documented with commands and verification.
  • The incident response flow covers detection, pause decision, triage, remediation, and unpause criteria.
  • Severity levels, escalation, and the post-incident process are defined.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions