This version
This is the documentation workspace for the upcoming OpsKnight 2.0.0
release. It is not published by the release-gated documentation sync until
v2.0.0 is added to releasedVersions in docs/versions.json.
The 2.0.0 documentation is rebuilt from current product evidence. Historical documentation can help locate a topic, but it is never authoritative.
Start here
- Evaluate with Docker Compose
- Create and resolve a first incident
- Plan a production installation
- Migrate from a 1.x deployment
Respond and operate
- Create, acknowledge, assign, and resolve incidents.
- Build an on-call schedule and manage temporary overrides.
- Configure escalation and notification routing.
- Publish a status update and create a ChatOps war room.
Connect systems
- Browse the integration catalog for monitoring, cloud, uptime, source-control, communication, issue-tracking, and generic webhook providers.
- Configure Slack, Microsoft Teams, voice paging, or Jira.
Run in production
- Choose a deployment topology, then follow the complete Compose, Kubernetes, or multi-node path.
- Plan scaling, hardening, backup and restore, and upgrades.
Exact contracts
- API inventory
- Configuration
- Permissions
- Notification delivery
- Webhooks
- Health, metrics, and runtime limits
Evidence order
When sources conflict, use this order:
- Current executable behavior
- Current tests
- Current source code and configuration
- Historical documentation
Documentation must not claim behavior that cannot be verified against one of the first three sources.
Documentation sections
- Start — install OpsKnight and complete a first incident.
- Concepts — understand the product model and why it behaves as it does.
- Guides — complete responder and administrator tasks.
- Integrations — connect alert sources and collaboration systems.
- Operate — deploy, secure, scale, back up, and upgrade OpsKnight.
- Reference — exact API, configuration, permission, and runtime contracts.
- Troubleshooting — diagnose symptoms using observable evidence.
- Develop — build, test, and contribute to OpsKnight.