Skip to content

Platform Engineering Standards

The conventions every Codevertex service is expected to follow, and the shared Go libraries (github.com/Bengo-Hub/shared-* — shared-events, shared-auth-client, shared-service-client, shared-ratelimit, httpware, cache) that implement them. Each page below documents what's actually implemented and where — not aspirational advice — so you can go straight to the real code.

Standard Where it lives
Engineering Principles Umbrella reference — start here
Webhooks vs Polling treasury-api/internal/http/router webhook group
Connection Pooling & PgBouncer devops-k8s/manifests/databases/pgbouncer.yaml
Read Replicas pos-api/inventory-api ReadOnlyURL + PgBouncer *_ro aliases
Caching shared/cache
Idempotency & the Outbox Pattern shared/events
Resilience — Circuit Breakers & Retries shared/service-client
Rate Limiting ingress annotations + per-service middleware
Service-to-Service (S2S) Conventions shared/auth-client
Swagger/OpenAPI Docs Gating treasury-api/auth-api/notifications-api swagger.go
Secrets Management devops-k8s/scripts/infrastructure/create-service-secrets.sh
Observability shared/httpware (logging), shared/service-client (tracing)
AI Integrations & pgvector shared/infrastructure/{pgvector,ollama,onnx}
N+1 Queries & Preloading Ent's generated .IDIn()/eager-load
Approvals internal/modules/approvals in treasury-api, inventory-api and maskani-api

Each page below describes the pattern as it exists today, grounded in the actual code and infrastructure rather than aspirational design docs.