- Description: Brief summary of the application's purpose and business function.
- Owner: Internal POC / customer contact.
- Supported By: L1 / L2 / PS teams involved.
- Environment(s): [Production / Staging / Dev / UAT]
- Status: [Live / In Development / Deprecated]
- Deployment Type: [ECS / EKS / VM / Bare Metal]
- Platform: [AWS / Azure / Oracle / On-Prem]
- Region(s): [e.g., us-east-1, UAE Central]
- Diagram: [Embed or link to Lucidchart / Draw.io / PNG]
- Components:
- Frontend:
- Backend:
- Database:
- File Storage:
- External APIs:
- Secrets/Configuration: Location and management method (e.g., AWS Secrets Manager)
- Repository: [GitLab/GitHub link]
- Branching Strategy: [main/preprod/dev]
- CI/CD Tool: [GitLab CI / Jenkins / GitHub Actions]
- Deployment Steps: (link or describe)
- IaC Used: [Terraform / CDK / None]
- Environment Variables: [list key vars or link to config doc]
- Startup Commands: [Docker entrypoint, service scripts, etc.]
- Service Ports: [HTTP: 80, HTTPS: 443, etc.]
- Health Check: [Path / method / expected result]
- Monitoring Tool: [CloudWatch / Prometheus / Datadog / others]
- Dashboards: [Link to Grafana / CloudWatch]
- Critical Alerts:
- Alert Name: Description – Notification Channel
- ...
- Log Location: [CloudWatch Group, Loki, File path]
- Authentication Method: [SSO / IAM / JWT]
- Authorization: [RBAC / ABAC / none]
- Vulnerability Scanning: [e.g., Amazon Inspector, Trivy]
- Encryption: [At-rest / in-transit details]
- Known CVEs: [Link to ticket or leave blank]
- Backup Frequency: [Daily / Weekly / Ad-hoc]
- Backup Location: [S3, Oracle Cloud, On-prem]
- Restore Process: [Link to SOP]
- Last Recovery Drill: [Date or N/A]
- Internal Dependencies: [Microservices, shared libraries]
- External APIs / Services: [Stripe, Twilio, etc.]
- Database Used By: [List apps sharing this DB]
- Upstream/Downstream Systems: [Data flow]
- Issue 1: Description – workaround steps
- Issue 2: Description – ticket link (if any)
- Test Strategy: [Unit / Integration / E2E]
- Testing Framework: [PyTest, Postman, etc.]
- Test Coverage: [% or N/A]
- Validation Steps Post Deployment: [Checklist or link]
- [Confluence / Wiki Links]
- [Runbook]
- [Escalation Procedures]
- [Handover Notes]