Standards & conventions
Engineering standards are maintained in a central dev standards repository (topic files). This page summarizes themes that apply across examplerep repositories; follow the authoritative sources when they differ.
General
| Topic |
Convention |
| Preferred cloud region |
AWS us-east-2 (where applicable). |
| Auth |
OIDC with JWT; implementation agnostic to provider. |
| Secrets |
Never commit secrets; use vaults or secret operators. |
| YAML filenames |
.yaml, not .yml, for new files. |
Containers
| Topic |
Convention |
| Runtime |
Podman assumed for local builds. |
| Container definition |
Containerfile at the service repository root (not Dockerfile). |
Java / Quarkus
| Topic |
Convention |
| Build |
Maven; latest LTS Java for new code. |
| Config |
YAML with %dev, %test, %prod profiles. |
| APIs |
OpenAPI; three-layer structure (api, service, repository). |
Frontends (Angular)
When using Angular, prefer LTS releases, ng-bootstrap where it fits, signals, and inject() for dependency injection.
OpenShift & GitOps
| Topic |
Convention |
| Target |
OpenShift as the Kubernetes environment. |
| GitOps |
Argo CD, Kustomize, sync waves for ordering. |
| Secrets |
External Secrets Operator (or equivalent) in cluster. |
Databases (PostgreSQL)
| Topic |
Convention |
| Migrations |
Flyway for schema; singular table names; BIGSERIAL keys for IDs. |
Link to the canonical topic files or internal docs from your standards repo when you want a single index; keep this page short.