Cleanup and naming config #10
Open
Conversation
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
… the project - Updated README.md to include environment and naming guidelines for multi-environment deployments. - Modified app.py to support environment-specific naming for resources and tags. - Adjusted Dockerfiles to remove hardcoded AWS region and rely on task execution environment. - Refactored secret retrieval in autotag.py and main.py files to use dynamic naming based on environment variables. - Updated JavaScript files to utilize environment variables for AWS region configuration.
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.
This pull request introduces environment-aware resource naming and configuration across the project to support multi-environment deployments (e.g., dev, prod) and improve AWS resource management. The changes standardize how stack names, S3 buckets, ECS clusters, Lambda functions, Step Functions, dashboards, and Secrets Manager secrets are named and accessed, using context variables or environment variables. Documentation and code are updated to reflect these conventions, and resource policies are adjusted to ensure correct permissions.
Environment-aware resource naming and configuration:
All AWS resources (S3 buckets, ECS clusters, Lambda functions, Step Functions, CloudWatch dashboards) now use names based on
<stackBase>-<env>and include account/region where needed for uniqueness. This is set via CDK context or environment variables. (app.py,README.md) [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]Lambda functions and ECS tasks receive
STACK_BASEandENVas environment variables for runtime awareness. (app.py) [1] [2] [3]Secrets Manager and permissions:
/<stackBase>/<env>/client_credentials), and resource policies for Lambda and ECS roles are updated to match. (app.py,README.md,docker_autotag/autotag.py,lambda/accessibility_checker_before_remidiation/main.py,lambda/accessability_checker_after_remidiation/main.py) [1] [2] [3] [4] [5] [6] [7]Documentation updates:
README.mdis expanded with clear instructions and examples for environment-aware deployment, stack/resource naming, and credential management. (README.md) [1] [2] [3] [4]Container and runtime environment handling:
docker_autotag/Dockerfile,javascript_docker/Dockerfile,javascript_docker/alt-text.js) [1] [2] [3]CloudWatch and Step Functions:
app.py) [1] [2]These changes make the project much easier to deploy and manage across multiple environments, reduce risk of resource naming collisions, and improve security by scoping secrets and permissions appropriately.
Closes #9