From b6d4cd4cabbb97a612a2bd9c449ce7af981ba1c6 Mon Sep 17 00:00:00 2001 From: Radoslav Dimitrov Date: Mon, 10 Aug 2026 15:59:41 +0300 Subject: [PATCH] docs(deploy): correct config parameter names in deploy README The configuration table named two parameters that no code reads and omitted two that a deploy cannot succeed without. Wrong names: - `gcpProjectId` and `gcpRegion` appear nowhere in deploy/ outside this table. The real keys are in the `gcp` provider namespace: `gcp:project` (deploy/pkg/providers/gcp/provider.go:30, whose error text says "Set gcp:project") and `gcp:region` (:36, default us-central1). All three stack files already use `gcp:project`. Missing required secrets, both RequireSecret so the deploy fails without them: - `mcp-registry:jwtPrivateKey` (deploy/pkg/k8s/registry.go:56) - `mcp-registry:googleOauthClientSecret` (deploy/pkg/k8s/monitoring.go:463) Also documents `gcp:credentials`, which is read at provider.go:42 and set in the staging and prod stacks, and adds the namespace prefixes. The table previously listed bare names, which is part of why the two wrong ones went unnoticed -- `gcpProjectId` looks plausible until you notice the real key lives under a different namespace entirely. Verified in both directions: every key in the table is read by deploy code, and every `conf.*("...")` key in deploy/ now appears in the table. Co-Authored-By: Claude Opus 5 --- deploy/README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/deploy/README.md b/deploy/README.md index 392b2440a..7b407e7c4 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -147,15 +147,20 @@ Pre-requisites: ## Configuration +Configuration keys are namespaced. Set them with `pulumi config set [--secret]`. + | Parameter | Description | Required | |-----------|-------------|----------| -| `environment` | Deployment environment (local/staging/prod) | Yes | -| `provider` | Kubernetes provider (local/gcp) | No (default: local) | -| `githubClientId` | GitHub OAuth Client ID | Yes | -| `githubClientSecret` | GitHub OAuth Client Secret | Yes | -| `imageTag` | Docker image tag for production environment | Yes (prod only) | -| `gcpProjectId` | GCP Project ID (required when provider=gcp) | No | -| `gcpRegion` | GCP Region (default: us-central1) | No | +| `mcp-registry:environment` | Deployment environment (local/staging/prod) | Yes | +| `mcp-registry:provider` | Kubernetes provider (local/gcp) | No (default: local) | +| `mcp-registry:githubClientId` | GitHub OAuth Client ID | Yes | +| `mcp-registry:githubClientSecret` | GitHub OAuth Client Secret | Yes (secret) | +| `mcp-registry:jwtPrivateKey` | Ed25519 seed used to sign registry JWTs | Yes (secret) | +| `mcp-registry:googleOauthClientSecret` | Google OAuth client secret for Grafana login | Yes (secret) | +| `mcp-registry:imageTag` | Docker image tag for production environment | Yes (prod only) | +| `gcp:project` | GCP Project ID | Yes when `provider=gcp` | +| `gcp:region` | GCP Region | No (default: us-central1) | +| `gcp:credentials` | GCP service account credentials JSON | No (secret; set in staging/prod) | ## Database Backups