Update DSC workflows to use 'S3_BUCKET' env var #171
Merged
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
Why these changes are being introduced: * The S3 bucket configured for DSC will include MITL's AWS account ID to ensure that the name of the bucket meets S3's requirement of uniqueness "across all AWS accounts in all the AWS regions within a partition". Since the AWS account IDs differ for Dev, Stage, and Prod, it would be difficult to dyna- mically generate the name of the S3 bucket; it also wouldn't be ideal to include the AWS account IDs as part of version control. Accessing the name of the S3 bucket via environment variable is the ideal and most secure option. How this addresses that need: * Add 'S3_BUCKET' as a required env var * Set Workflow.s3_bucket as a final, property method that accesses 'S3_BUCKET' env var via Config * Remove 's3_bucket' property methods from all workflows Side effects of this change: * The environment variable 'S3_BUCKET' must be set as part of the ECS task definition. Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/IN-1227
Pull Request Test Coverage Report for Build 14478397248Details
💛 - Coveralls |
ghukill
approved these changes
Apr 15, 2025
ghukill
left a comment
ghukill
left a comment
There was a problem hiding this comment.
Approved! Left a comment where some additional explanation could be helpful in the README, but not required.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose and background context
The S3 bucket configured for DSC will include MITL's AWS account ID to ensure that the name of the bucket meets S3's requirement of uniqueness "across all AWS accounts in all the AWS regions within a partition". Since the AWS account IDs differ for Dev, Stage, and Prod, it would be difficult to dyna- mically generate the name of the S3 bucket; it also wouldn't be ideal to include the AWS account IDs as part of version control. Accessing the name of the S3 bucket via environment variable is the ideal and most secure option.
How can a reviewer manually see the effects of these changes?
Running
make testand verifying all tests are passing is sufficient for this review.Includes new or updated dependencies?
NO
Changes expectations for external applications?
YES - Env var
S3_BUCKETmust be set in the ECS task definitionWhat are the relevant tickets?
Developer
Code Reviewer(s)