Migrate from deprecated LOCALSTACK_API_KEY to LOCALSTACK_AUTH_TOKEN #265
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
This PR migrates all usages of the deprecated
LOCALSTACK_API_KEYenvironment variable to the newLOCALSTACK_AUTH_TOKENto ensure continued authentication with LocalStack Pro services.Background
The
LOCALSTACK_API_KEYhas been sunset and will no longer work for authentication. Without this migration, sample tests will fail due to authentication errors since the API key mechanism is deprecated. FIXES #262Changes Made
Core Migration
.github/workflows/makefile.yml: Updated CI workflow to useLOCALSTACK_AUTH_TOKENinstead ofLOCALSTACK_API_KEYemr-serverless-python-dependencies/docker-compose.yml: Removed deprecatedLOCALSTACK_API_KEYenvironment variableDocumentation Updates
testcontainers-java-sample/LocalStackTestcontainers/src/test/java/TestRDS.java: Updated variable name fromapi_keytoauthTokenfor consistencysample-archive/spring-cloud-function-microservice/.env.example: Updated placeholder format from<your-pro=api-key>to<your-auth-token>java-notification-app/README.md: Updated documentation to use<your-auth-token>formatroute53-dns-failover/README.md: Updated documentation to use<your-auth-token>formatTesting Steps
1. Verification of Migration
2. Local Testing
3. Sample Testing
4. Docker Compose Testing
5. CI Workflow Validation
LOCALSTACK_AUTH_TOKEN: ${{ secrets.TEST_LOCALSTACK_AUTH_TOKEN }}TEST_LOCALSTACK_API_KEYtoTEST_LOCALSTACK_AUTH_TOKENImpact