Skip to main content

Environments

This page is a starting point for deployment environment documentation.

Current known state

The repositories include deployment-related indicators such as:

  • docker-compose.yml in some projects
  • kubernetes/ folders in multiple services
  • multiple frontend build targets such as development, staging, qa, and sit

Environment topics to document

  • environment list and purpose
  • hostnames and ingress URLs
  • required secrets per environment
  • deployment owner for each environment
  • DB and cache dependencies
  • release approval path

Initial checklist

For each environment, document:

  • purpose
  • who uses it
  • frontend build command
  • backend deployment method
  • smoke test steps
  • rollback path