Repository navigation
docs(gcp-install): close the guide gaps from a clean-project install (#492) - #495
Merged
Merged
Conversation
…492) - Step 14: the Ingress can take 15 to 20 minutes to get its address; the first-sync "no BackendConfig for service port exists" warning is harmless when it does not repeat. 502 on paths routed to the edge-deny Service is by design, not an outage. - Step 1: installing from a checkout needs helm dependency build for sessions-pipeline before agent-relay. - Step 4 and terraform/examples/gcp: relay-control exits when the Desktop feed storage env is set without a signer. The guide says to set the bucket only once the signing key exists and how to recover; the new desktop_feed_has_signing_keys input (default true, so current outputs are unchanged) leaves the storage env out of chart_values and desktop_feed. - Step 7: SERVICES_IMAGE, PSQL_IMAGE and the .tgz name belong to the pinned release; how to read them for another release or a checkout. - first-admin.sh: optional API_HOST (default api.<app hostname>) and PASSWORD_FILE (a new 0600 file instead of Secret Manager), with tests. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
[Medium impact] The follow-up changes appear safe to merge.
|
…nge on apply - gcp-first-admin-test.sh brings its own openssl mock. Under run-tests.sh it inherited the runner's mock, which prints nothing for "rand", so the password was empty and the static job failed. - desktop_feed_has_signing_keys: say that outputs are read from the state, so changing the input needs an apply before chart_values is saved again (example README, variable description, guide step 4). Co-Authored-By: Claude Fable 5.2 <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
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.
Fixes #492
Six gaps found by following
docs/gcp-installon a clean project. None is a regression. Docs, one guide script and the Terraform example only: no chart is touched, and the release the guide pins is unchanged.What changed, per item
0-START-HERE.mdstep 14). The step now says the Ingress can take 15 to 20 minutes to get its address, gives the commands to look (kubectl get ingress,kubectl describe ingressevents), names theTranslation failed ... no BackendConfig for service port existswarning as harmless when it does not repeat, and says when to worry (address still empty or warning still repeating after about 20 minutes).1-BRING-YOUR-OWN.mdhas no Ingress check of its own (it points at step 6 and 14), so it is unchanged.helm dependency buildforcharts/sessions-pipelinebeforecharts/agent-relay, and why (without it the read API and workers are not rendered).managed-values.jsoncan crash-loop relay-control (step 4,terraform/examples/gcp). Two parts:desktop_feed_bucket_namefrom 2026.11.9 and said the signing key comes later, which is exactly the storage-without-signer state relay-control refuses. It now says to uncomment the bucket only once the signing key is in place, quotes the exit message, and gives the recovery for an install that already applied with the bucket (jq 'del(.["relay-control"].extraEnv)'onmanaged-values.json). This part is needed on its own because the guide's Terraform comes from the pinned release tag, which cannot have a new input.desktop_feed_has_signing_keys(bool, defaulttrue). Withfalse,chart_values["relay-control"]has noextraEnvanddesktop_feed.envis empty; the bucket, the service account and the annotations are unchanged. Terraform cannot see the signer (it isrelay-control.desktopFeed.signingKeysin the site values), so a plan-time check is not possible; an explicit input is the smallest thing that lets the output omit the env. The default istrueso that an existing install with a signer renders exactly the same: defaulting tofalsewould drop the storage env from such an install on its nextterraform outputand break it the other way round (signer without storage). The existing test now asserts the three entries by value, and a new run coversfalse.SERVICES_IMAGE,PSQL_IMAGEandagent-relay-0.7.54.tgzbelong to agent-relay-2026.11.16 (chart 0.7.54), and shows how to read the three values for another release from its assets (release-manifest.json, the.tgzname), and for a checkout fromreleases/<tag>/pins.jsonand thesessions-pipelinechart values. The repo has no check that compares the guide's pins with release metadata (the release workflows only carry a manual checklist line fordocs/gcp-install/), so there was nothing to keep passing.first-admin.sh(and step 15). OptionalAPI_HOST(defaultapi.<app hostname>, so current callers are unaffected), validated with the same rule as the app hostname; theOriginheader stays the app hostname. OptionalPASSWORD_FILE: the password goes to a new local file (mode 0600, created withnoclobber, refused if it exists) instead of Secret Manager, andgcloudis then not required. The Secret Manager requirement of the default mode is now stated. The password and setup key are still never printed or put on a command line. New offline testscripts/selfhost/tests/gcp-first-admin-test.sh, run fromrun-tests.sh(which also syntax-checks and shellchecks the script now)....-cast-edge-denyService (/internaland other closed paths) answer 502 from the load balancer when no Cloud Armor policy is attached, by design, so it is not read as an outage.Overlap with #487 and #493
Both authors confirmed no conflicting passages. This PR stays out of
3-EDGE-HARDENING.md,edge.tf, theedgeoutput andmodules/gcp/edge-security. In the shared files the hunks are apart: the new variable sits next to the otherdesktop_feed_*inputs (theirs are appended at the end), and its name sorts beforedesktop_feed_service_account_idso the generated README row does not land on the lines #487 adds. Whichever merges second should re-runterraform-docsforterraform/examples/gcpinstead of hand-merging the table.Verification (local)
The commands the guide now shows were run against repository data or a stand-in file: the
pins.jsonandgreplines print the two digests the guide pins today, and therelease-manifest.jsonfilter and thejq del(...)line were run on sample JSON of the same shape.Not fully run locally:
scripts/selfhost/tests/run-tests.sh(the static job's "Self-hosted operator script tests"). On macOS it stops inagent-relay-upgrade-test.shatan interrupted (INT) census plan succeeded, before it reaches the new test; unmodifiedmainfails at the same line on the same machine, so this is a local platform difference and the Linux CI run is the evidence for that step. Everything before it passed, including the runner's syntax check and shellcheck offirst-admin.shand the new test. No YAML file changed, so there was nothing for yamllint. tflint and checkov were not installed locally; CI runs them. The repo has no markdown or link check in CI. Nothing was applied to any cloud project or cluster.🤖 Generated with Claude Code
Open in [code]smith · Need help on this PR? Tag
@codesmith-botwith what you need.