[terraform] Adds aws region export to aws-deploy.sh script
ClosedPublic
Actions

Authored by will on Aug 4 2024, 7:18 PM.

Details

Reviewers

bartek
varun

Commits

rCOMM83d9d1cd0a62: [terraform] Adds aws region export to aws-deploy.sh script

Summary

Ashoat ran into an issue of having a different aws region configured through aws-cli when running aws-deploy which prevented the migrations from running.

We should ensure the script properly sets the region so the user will always be able to run the script

Depends on D12930

Test Plan

I deployed my self-host setup to us-east-1. Through aws configure, I set the region to us-east-2 and ensured the aws-cli region was set by using aws-cli to
describe the keyserver cluster which resulted in a non-existent cluster. However, the script works properly, demonstrating that the script was able to properly
set the region to us-east-1

Diff Detail

Repository

rCOMM Comm

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

will created this revision.Aug 4 2024, 7:18 PM

Herald added subscribers: tomek, ashoat. · View Herald TranscriptAug 4 2024, 7:18 PM

will edited the summary of this revision. (Show Details)Aug 4 2024, 7:19 PM

will added a parent revision: D12930: [terraform] deploy landing on comm services cluster.

Harbormaster completed remote builds in B30876: Diff 43056.Aug 4 2024, 7:35 PM

will requested review of this revision.Aug 4 2024, 7:35 PM

Accepting because according to your test plan, it worked. It should work as long as aws-cli-v2 is used because it supports AWS_DEFAULT_REGION.

But be aware that AWS_REGION env takes precedence over AWS_DEFAULT_REGION in the CLI and generally the former should be used. This script will fail if somebody sets AWS_REGION to something else.

More context: https://stackoverflow.com/a/75670789 and https://docs.aws.amazon.com/sdkref/latest/guide/feature-region.html
It's unfortunate that SO has better explanation than official docs ¯\_(ツ)_/¯

This revision is now accepted and ready to land.Aug 5 2024, 2:41 AM

In D12959#366803, @bartek wrote:

Accepting because according to your test plan, it worked. It should work as long as aws-cli-v2 is used because it supports AWS_DEFAULT_REGION.

But be aware that AWS_REGION env takes precedence over AWS_DEFAULT_REGION in the CLI and generally the former should be used. This script will fail if somebody sets AWS_REGION to something else.

More context: https://stackoverflow.com/a/75670789 and https://docs.aws.amazon.com/sdkref/latest/guide/feature-region.html
It's unfortunate that SO has better explanation than official docs ¯\_(ツ)_/¯