Service Production Readiness Standards

Source

AppCat Product Owner

Stimulus

Approve service production readiness (new and changing services)

Environment

AppCat enabled Kubernetes cluster

Artifact

AppCat Documentation

Response

Documentation and specification of all services adhere to a common standard.

Response measure

Each service documentation contains at least the following content:

  • Metrics and alerts

  • SLIs

  • Runbooks

  • Tutorials (Getting started)

  • How-to guides

  • Backup and restore reference

  • API reference

  • Operational constraints

Rationale

Each service must adhere to a checklist for production readiness. The documentation shall be consistent across all services.