Skip to content

chore(aso-overlay): document ASO_OVERLAY_API_KEY_PREVIOUS in .env.example#2797

Closed
abhishekgarg18 wants to merge 1 commit into
adobe:mainfrom
abhishekgarg18:chore/aso-overlay-api-key-previous-env-example
Closed

chore(aso-overlay): document ASO_OVERLAY_API_KEY_PREVIOUS in .env.example#2797
abhishekgarg18 wants to merge 1 commit into
adobe:mainfrom
abhishekgarg18:chore/aso-overlay-api-key-previous-env-example

Conversation

@abhishekgarg18

Copy link
Copy Markdown
Member

Summary

  • Adds ASO_OVERLAY_API_KEY_PREVIOUS= (empty) to .env.example for
    discoverability + local parity, so devs know the previous-key fallback
    env var exists without having to grep the auth handler.
  • Extends the surrounding comment block with the rotation-time rationale
    (empty in steady state; populated in lockstep with aso_keys_previous
    on the Fastly edge during rotation — see spacecat-infrastructure#627
    MIGRATION-lite-e.md).

Background

Non-blocking follow-up from @alinarublea's approving review on the
already-merged #2663 (dual-key overlap for API key rotation, ADR I13):

Non-blocking nit (still open): add ASO_OVERLAY_API_KEY_PREVIOUS=
(empty) to .env.example for discoverability/local parity.

Test plan

🤖 Generated with Claude Code

…mple

Non-blocking follow-up from Alina's review of PR adobe#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>
@abhishekgarg18

Copy link
Copy Markdown
Member Author

Superseded by #2834 (re-opened from internal branch so full CI runs).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants