feat(aso-overlay): document ASO_OVERLAY_API_KEY_PREVIOUS in .env.example#2834
Open
abhishekgarg18 wants to merge 1 commit into
Open
feat(aso-overlay): document ASO_OVERLAY_API_KEY_PREVIOUS in .env.example#2834abhishekgarg18 wants to merge 1 commit into
abhishekgarg18 wants to merge 1 commit into
Conversation
…mple Non-blocking follow-up from Alina's review of PR #2663 (dual-key overlap for API key rotation): the handler already accepts ASO_OVERLAY_API_KEY_PREVIOUS as the previous-key fallback, but the env var was undocumented in the example file, so local devs had no signal it exists. Empty in steady state; operators populate it during a rotation window (populating both aso_keys_previous at Fastly and ASO_OVERLAY_API_KEY_PREVIOUS here in lockstep — see spacecat-infrastructure#627 MIGRATION-lite-e.md for the rotation flow) so dispatcher pods still holding the old key are not 401'd during EVO propagation. Co-Authored-By: Claude <noreply@anthropic.com>
|
This PR will trigger no release when merged. |
2 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
abhishekgarg18
temporarily deployed
to
dev-branches
July 16, 2026 06:09 — with 
GitHub Actions
Inactive
GitHub Actions
Inactive
5 tasks
abhishekgarg18
changed the title
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.
Summary
Documents the
ASO_OVERLAY_API_KEY_PREVIOUSenv var in.env.example. This is a pure docs / dev-onboarding change — no runtime behavior changes.Context
AsoOverlayKeyHandler(src/support/aso-overlay-key-handler.js:109) already readsASO_OVERLAY_API_KEY_PREVIOUSand falls back to it when the current key doesn't match — see the dual-key rotation logic at lines 107-124. But the dev-onboarding template (.env.example) didn't list it, so every new engineer had to reverse-engineer the rotation setup from the handler code + the deploy pipeline.Empty in steady state (the
if (previousKey && ...)guard at handler line 118 treats empty string as falsy). Populated during a key-rotation window so dispatcher pods still holding the old value are not 401'd during EVO secret propagation.Why re-open (replaces #2797)
Original PR #2797 was opened from a personal fork (
abhishekgarg18/spacecat-api-service), which meant several org-scoped CI checks were skipped. Re-opened from an internal branch so the full pipeline runs.Diff
.env.example: addsASO_OVERLAY_API_KEY_PREVIOUS=with a comment block explaining rotation semantics + the vault lookup command aligned with the existingASO_OVERLAY_API_KEYentry. Comment section is 6 lines added, 3 removed.Test plan
aso-overlay-key-handler.js:107-124)ASO_OVERLAY_API_KEY_PREVIOUS(JSDoc + handler read); both consistentASO_OVERLAY_API_KEYtest/support/aso-overlay-key-handler.test.jsdual-key rotation describe block)Related
mysticat-architecture/)resolveEnvironmentwarn-once on missing env — same audit sweep🤖 Generated with Claude Code