docs(deploy): correct config parameter names in deploy README - #1521
Merged
Conversation
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 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The deploy configuration table named two parameters that no code reads, and omitted two that a deploy cannot succeed without.
Wrong names
gcpProjectIdgcp:projectSet gcp:projectgcpRegiongcp:regionus-central1gcpProjectIdandgcpRegionappear nowhere indeploy/outside this table. All three stack files (Pulumi.gcpProd.yaml,Pulumi.gcpStaging.yaml,Pulumi.local.yaml) already usegcp:project.Missing required secrets
Both are
RequireSecret, so a deploy fails outright without them — yet neither was in the table:mcp-registry:jwtPrivateKey— registry.go:56mcp-registry:googleOauthClientSecret— monitoring.go:463Also
gcp:credentials(read at provider.go:42, set in the staging and prod stacks)gcpProjectIdreads as plausible right up until you notice the real key lives in a different config namespace altogether.Verification
Checked both directions:
deploy/(reference counts confirmed per key)conf.*("...")key found anywhere indeploy/now appears in the table🤖 Generated with Claude Code