Skip to content

Runbook: Adding a New Client Overlay

Status: Draft — implementation pending

Purpose

Create a new per-client GitOps overlay from the shared template.

Prerequisites

  • Stable client-id
  • Knowledge of client's cloud provider and identity provider
  • Access to create directories and files in 7k-inari

Steps

  1. Copy clients/_templates/base/ to clients/<client-id>/base/.
  2. Create environment overlays under clients/<client-id>/overlays/<env>/.
  3. Customize dex-connectors.yaml for the client's IdP.
  4. Customize alloy-config.yaml and certificate references.
  5. Add cloud-specific ProviderConfigs.
  6. Configure the client-local ArgoCD Application to point to clients/<client-id>/overlays/<env>/.
  7. Open a pull request and validate in a dev environment.

TODO

  • Add concrete manifest examples and naming conventions.
  • Add PR checklist.