Requirement
OSBR has no written infrastructure planning policy, so every project starts its
infra decisions from scratch. This adds a policy plus supporting guidelines that
capture OSBR's infrastructure defaults and how we make the recurring decisions,
grounded in big-tech decision frameworks (AWS / Azure / Google Well-Architected,
Google SRE, DORA, The Twelve-Factor App, OWASP / CIS / NIST) right-sized for an
SME.
New pages:
doc/infra-planning-policy.md (Policies) — 12 guiding principles: scale to
zero, Zero Trust, IaC mandatory, one-tool-owns-each-resource, reliability &
delivery measured (SRE/DORA), observability, environments & promotion, backups
& DR, secrets & least-privilege, deploy safely & reversibly, cost as a design
constraint, managed-over-self-hosted & data residency — plus grouped references.
doc/database-guidelines.md (Guideline) — choosing a data store (SQL vs
NoSQL) and structuring relational schemas, including OSBR's SQL house style
(strict lowercase snake_case, singular entity / plural table, short
identifiers driven by a simple ubiquitous language).
doc/style-guide-terraform.md (Guideline → Style Guide) — Terraform /
OpenTofu coding conventions (formatting, naming, structure, version pinning,
remote state, secrets, resource ownership).
doc/.vitepress/config.mts — sidebar entries for the three pages.
Notes
Related Issues
- (none)
Implementation is on branch worktree-infra-planning-policy; a draft PR will
follow.
Requirement
OSBR has no written infrastructure planning policy, so every project starts its
infra decisions from scratch. This adds a policy plus supporting guidelines that
capture OSBR's infrastructure defaults and how we make the recurring decisions,
grounded in big-tech decision frameworks (AWS / Azure / Google Well-Architected,
Google SRE, DORA, The Twelve-Factor App, OWASP / CIS / NIST) right-sized for an
SME.
New pages:
doc/infra-planning-policy.md(Policies) — 12 guiding principles: scale tozero, Zero Trust, IaC mandatory, one-tool-owns-each-resource, reliability &
delivery measured (SRE/DORA), observability, environments & promotion, backups
& DR, secrets & least-privilege, deploy safely & reversibly, cost as a design
constraint, managed-over-self-hosted & data residency — plus grouped references.
doc/database-guidelines.md(Guideline) — choosing a data store (SQL vsNoSQL) and structuring relational schemas, including OSBR's SQL house style
(strict lowercase
snake_case, singular entity / plural table, shortidentifiers driven by a simple ubiquitous language).
doc/style-guide-terraform.md(Guideline → Style Guide) — Terraform /OpenTofu coding conventions (formatting, naming, structure, version pinning,
remote state, secrets, resource ownership).
doc/.vitepress/config.mts— sidebar entries for the three pages.Notes
Related Issues
Implementation is on branch
worktree-infra-planning-policy; a draft PR willfollow.