8.11 - Fix runbook's health-check endpoint, add a mainnet section - #180
Open
kelvinokwudili52-stack wants to merge 1 commit into
Open
Conversation
…ction Step 3 of the deploy section told the operator to watch /health go green. Both render.yaml and render.mainnet.yaml gate traffic on /ready (healthCheckPath), and the Dockerfile HEALTHCHECK targets /ready too - /health is liveness-only and returns ok: true unconditionally, so an operator could watch the wrong endpoint go green while /ready was still 503ing on an unreachable database and no traffic was flowing. Corrected the step to /ready and added a line explaining the distinction so it isn't reintroduced. Added a new 'Mainnet: a second, separate service' section covering which Render service, which blueprint, which URL, and which secrets differ from testnet, plus what's shared vs. per-environment for each of deploy, rollback, restore and key rotation - cross-referencing docs/MAINNET.md for the cutover procedure and Phase 5 verification checklist it must line up with.
|
@kelvinokwudili52-stack Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
|
@kelvinokwudili52-stack is attempting to deploy a commit to the determined's projects Team on Vercel. A member of the Team first needs to authorize it. |
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.
closes #165
Summary
Two gaps in
docs/RUNBOOK.md, both confirmed against the actual current code before writing anything:1. Wrong health-check endpoint in the deploy step
Step 3 told the operator to watch
/healthgo green. Checked against the actual gating logic:render.yaml:33andrender.mainnet.yaml:44both sethealthCheckPath: /ready.apps/api/Dockerfile:113'sHEALTHCHECKalso targets/ready.apps/api/src/index.ts:/healthreturnsok: trueunconditionally (liveness only);/readycallscontainer.ready()and returns 503 when the database isn't reachable.So an operator following the old step could watch
/healthgo green while/readywas still 503ing and no traffic was flowing. Corrected the step to/readyand added a line explaining the liveness/readiness distinction so it doesn't get reintroduced.2. No mainnet section
Added "Mainnet: a second, separate service", placed right after the existing "Scaling past one instance" note (before the shared Deploy/Rollback/Restore/Key rotation procedures it references). It covers:
quay-apivsquay-api-mainnet), blueprint file,STELLAR_NETWORK, API URL, database, off-ramp mode.### ... — mainnetsubsection under each of Deploy / Rollback / Restore / Key rotation, cross-referencing the shared procedure below it and calling out only what's actually different (which service's logs to watch, which backup belongs to which database,ANCHOR_URL/ANCHOR_HOME_DOMAIN/METRICS_TOKENbeing mainnet-only secrets perrender.mainnet.yaml's own header comment, etc.).docs/MAINNET.md(the cutover procedure and Phase 5 verification checklist) rather than duplicating its content.Verification
/readyvs/healthbehavior by readingapps/api/src/index.tsdirectly (lines 64-110), not just trusting the issue text.render.yaml,render.mainnet.yaml, andapps/api/Dockerfile's healthcheck all target/ready.render.mainnet.yaml's secret list anddocs/MAINNET.md's Phase 3/5/Rollback content for consistency.pnpm typecheck/pnpm test/pnpm buildrun was needed, and none is available in this environment regardless (no pnpm/node_modules install here).