docs(self-hosting): add per-cloud reference architectures

Closed
WA
2mo ago
+177-0

Summary

  • Answers a recurring enterprise question — "do you have CloudFormation or Terraform templates?" — with a page instead of a per-conversation reconstruction. Sim ships a Helm chart; the chart is what your own IaC should call.
  • Documents what the chart provisions by default versus what production needs you to bring, the prerequisites for EKS, AKS and GKE, how the three secret strategies map onto what your pipeline creates, and how to wrap the chart in a helm_release.

Why docs rather than a Terraform module

The one strong vendor precedent, GitLab's Environment Toolkit, lives in a separate repository and is framed as-is. Comparable products ship a chart and docs and leave the modules to the community. Maintaining Terraform across three clouds is a standing cost that buys less than documenting the boundary precisely.

Two things the page is careful about

  • The Terraform snippet overrides every secret. The example values files ship literal placeholders, and the chart only rejects empty values and its own CHANGE-ME strings — so inheriting them installs cleanly with a publicly known session-signing secret.
  • It states that existingSecret and External Secrets fail in opposite directions: the first silently, because app.env is inlined onto the pod spec and shadows the Secret; the second loudly, by refusing to render.

Sizing, the secret inventory and the pre-launch checklist are cross-references rather than copies, so there is one place for each to drift.

Type of Change

  • Documentation

Testing

bun run lint, bun run docs-manifest:check, and MDX structural checks (frontmatter, imports, balanced Tabs/Callout, fences) pass. Every claim was verified against helm/sim/values.yaml, the three helm/sim/examples/values-*.yaml files, apps/sim/lib/uploads/config.ts, and the chart templates; the HCL was corrected after review found the original snippet could not terraform apply.

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

šŸ¤– Generated with Claude Code

https://claude.ai/code/session_015BwsJTEQRzWJaY4BRCkPZt