Add Github Action deploy #75
Merged
Conversation
This file contains 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
With this configuration a Github Action will run when a release tag `release-YYYY-MM-DD` has been created during weekly dependency updates, The action will build the Docker container and deploy it to the development (qa in SDR) and staging AWS environments. This will allow the First Responder for the week to test it using the speech-to-text integration tests. When the tag has been tested and is ready for production a developer will need to create a release in Github using the release tag. This will cause a build and deploy to the production AWS environment. We may want to think about automated ways for this to happen, but the "serverless" nature of AWS Batch means there really isn't a server for capistrano (what we use to do other infra deploys) to talk to. The keys for the different environments need to be set as [Github Action Secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions). - AWS_ACCESS_KEY_ID_DEVELOPMENT - AWS_SECRET_ACCESS_KEY_DEVELOPMENT - AWS_ECR_DOCKER_REPO_DEVELOPMENT - AWS_ACCESS_KEY_ID_STAGING - AWS_SECRET_ACCESS_KEY_STAGING - AWS_ECR_DOCKER_REPO_STAGING - AWS_ACCESS_KEY_ID_PRODUCTION - AWS_SECRET_ACCESS_KEY_PRODUCTION - AWS_ECR_DOCKER_REPO_PRODUCTION Note: only dlss-ops has permission to see the keys for the speech-to-text user in production. So for now this is commented out, until we actually do need to run in production. Maybe this could be ticketed as follow on work? Closes #46
jmartin-sul
approved these changes
Jan 30, 2025
| text_to_speech_access_key_id = "XXXXXXXXXXXXXX" | ||
| text_to_speech_secret_access_key = <sensitive> | ||
|
|
||
| $ terraform output text_to_speech_secret_access_key |
There was a problem hiding this comment.
ah, good to know you can do this, definitely more convenient than doing terraform show -json and then text searching the terminal output.
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.
With this configuration a Github Action will run when a release tag
release-YYYY-MM-DDhas been created during weekly dependency updates. The action will build the Docker container and deploy it to the development (qa in SDR) and staging AWS environments. This will allow the First Responder for the week to test the latest code using the speech-to-text integration tests.When the tag has been tested and is ready for production a developer will need to create a release in Github using the release tag. This will cause a build and deploy to the production AWS environment. We may want to think about automated ways for this to happen, but the "serverless" nature of AWS Batch means there really isn't a server for Capistrano (what we use to do other infra deploys) to talk to.
The keys for the different environments need to be set as Github Action Secrets.
Note: only dlss-ops has permission to see the keys for the speech-to-text user in production. So for now the production deploy is a no-op until we actually do need to run in production. Maybe this could be ticketed as follow on work?
I tested using the rel-2025-01-29 release tag, which triggered the deploy Github Action, built and pushed the Docker image to the development and staging AWS environments. I confirmed I could see them in the ECR AWS Console and then watched the speech to text integration test pass.
I also created a Github Release for rel-2025-01-29 which triggered the deploy-prod Github Action which is currently a no-op until we configure the Github repository with the necessary secrets for the speech-to-text user in the production AWS environment.
Closes #46