New Product Package: authority-portal

[AbdullahMuk]

Maturity Stages

When deploying a new product package, the target product package maturity is important.

Target stages of maturity:

• [ ] "Brownfield Deployment":
  • Current deployments outside of SCM, no home repo, no deployment guides, etc.
  • Will not be accepted anymore!
• [ ] "Minimal Requirements for any Deployment"
  • Infra will deny anything that does not fulfill this
  • Minimal requirements for anything that wants to be deployed once
• [ ] "Alpha"
  • Realistic minimal requirements for anything deployed that wants to be updated
• [ ] "Validation"
  • First "real deployment"
  • Product Package deployable via Customer Portal
• [ ] "Scale"
  • Additional hardening for more than X customers
  • Additional hardening for frequent version bumps
  • Guaranteed Quality

Reviews

Reviews are independant of the maturity stages, but need to be done at some point. Plan accordingly!

• [ ] Initial Resource Requirements & DB Model Review
  • Recommended once for deployment units written by us
  • If done earlier, less effort down the line
  • [ ] Please schedule a meeting with infra
• [ ] Service-Level Guarantees Review
  • Done as soon as contracts with a customer exist
  • [ ] Please schedule a meeting with infra
  • [ ] Afterwards: Include in deployment guide for infra under SCM
• [ ] Productive Computation Requirement Review
  • Do this after a certain productive scale has been reached or problems have been noticed
  • [ ] Infra will do this proactively with you

Must-Have Requirements

Delete sections depending on target maturity stage Subsequent stages also require the previous stages If you're smart, try to prepare the deployment units rather early than late

"Minimal Requirements for any Deployment"

• [ ] "Home Repo" for the Product Package
  • [ ] Readme: What is this package? Why do we need this package?
  • [ ] Deployment Guide for Infra:
  • [ ] Table of Deployment Units (Name, Description, Pinned Version!)
  • [ ] Table of Vault Secrets if used / required (Name, Description, Example content / format)
  • [ ] Table of Keycloak Clients (Name, Description, Explicit configuration)
  • [ ] Port / Path mapping, Auth Proxies, Reverse Proxy, TLS Termination, etc.
  • [ ] Configuration of all Deployment Units as needed for the infra deployment
• [ ] Communication: Given to infra in a pinned state, e.g. via Commit Hash

"Alpha"

• [ ] "Home Repo" for the Product Package
  • [ ] Local Development Guide (if developed component)
  • [ ] Deployment Guide: For infra / support: How to enable debug logging?
  • [ ] CHANGELOG
  • [ ] SemVer
  • [ ] Deployment Migration Notes
  • [ ] Compatible Versions
  • [ ] Release Guide
  • [ ] Release on GitHub: Pinned documentation, versions, artifacts
• [ ] Infra: Terraform Modules
• [ ] Communication: Release-pinned Deployment Guide + Deployment Migration Notes given to infra

"Validation"

• [ ] Telemetry and Observability
  • [ ] OTEL configuration
  • [ ] Health checks (live, ready, health) are documented
  • [ ] Observabillity of all deployment units
  • [ ] Logging format is json
• [ ] Recommended: "Computation Requirements Review"
• [ ] Recommended: "Service-Level Guarantees Review"
• [ ] Infra: Create Product Package

"Scale"

• [ ] E2E Tests:
  • [ ] Integrated into CI
  • [ ] UI with HTML data-testid attributes for our code
  • [ ] Product Feature document for E2E Test QA
• [ ] Required: "Computation Requirements Review"
• [ ] Required: "Service-Level Guarantees Review"
• [ ] Biz: Support requirements are clarified and documented
• [ ] Ensure Biz Continuity - Infra: Update Product Package via Customer Portal

[AbdullahMuk]

@kamilczaja when you tackle this task, please review the content above such that it is adapted for AP repo (I copied the template from ECU repo).