← All runbooks
Under construction · working draft requires a release manifest
Technical runbook
What must the installation package contain?
A clear contract between a specific release, implementer, and operation.
01
Manifest release
- Identify the product, release, release date, supported channel, and support status.
- For each service, provide the full image name, immutable tag, and SHA-256 digest.
- Attach a compatibility matrix of services, database, Docker Engine/Compose, OS and CPU architecture.
- List schema changes, migration order, breaking changes, known issues, and supported path from previous versions.
02
Delivery files
- compose.yaml and any profiles for minimal, full and integration deployments
- .env.example without passwords, certificates and actual tokens
- a list of secrets and how to transfer them securely
- reverse proxy configuration or its exact requirements
- migration and initialization commands
- health checks, smoke tests and expected results
- backup, restore and rollback procedure
- release notes, SBOM and list of known limitations
03
What not to think about
If the value is not in the manifest or runbook, the installation stops and the release owner is asked to add it.
- image name or tag
- port exposed outside the internal network
- default password
- database migration order
- component compatibility
- health endpoint and the meaning of its states
Next runbook