My Dream Service

Requirements divided by necessity and DevOps SDLC stages.

Minimum Requirements

Plan

• Owner responsible for development and stability.
• Supported tech stack.
• README.md with key points.
• OpenAPI spec for APIs.

Code & Build

• Dependency managers (npm, go, etc.).
• Standalone Docker image.
• Automated CI/CD (GitHub, GitLab, etc.).

Testing & Deployment

• Tests in CI/CD; failures block deployment.
• Orchestrator (K8s/Nomad).
• Infrastructure as Code (Terraform/Helm).
• At least 2 instances in stage, 3 in prod.

Operations & Monitoring

• Logs to stdout.
• Config via env vars.
• /liveness and /readiness endpoints.
• Timeouts for all external requests.
• Prometheus metrics (Golden Signals).

Additional Requirements

• Team knowledge sharing.
• Code style and static analysis.
• Vulnerability scanning.
• SemVer and conventional commits.
• Semantic Versioning.
• Graceful shutdown (SIGTERM).
• Exponential backoff and circuit breakers.