Open
Description
What needs to be done
We received feedback from a CDC SWE who attempted to run through the installation instructions on the dibbs-aws
repo on their own.
Why it needs to be done
We should address this feedback to ensure the README is as accurate as possible.
Acceptance Criteria
Feedback is verbatim below:
Changes from the README in dibbs-aws
.
- Had to pin my terraform to version1.9.0
- 4.2.2 of the README indicates we should clone dibbs-cloud but I think it should really be dibbs-aws
- I think that section 4.3 should be removed entirely. As the steps are all handled inside of the setup.sh (which is discussed in 4.5)
- 4.3.1 tells us to navigate to terraform/implementation and then do a terraform init but you can't do an init from that directory.
- init is also handled by the setup.sh script, so it's unclear if we should run init our selves or just run the setup script.
- 4.3.2 tells the user to create a new terraform workspace, but this is also handled by setup.sh
- 4.3.1 tells us to navigate to terraform/implementation and then do a terraform init but you can't do an init from that directory.
- When running setup.sh we had to update all our aws providers to v5.70.0 because of some dependency conflicts.
- 4.6.1 - When trying to run the deploy.sh in the ecs folder, terraform needs access to the .env file created in the /implementation/setup directory in addition to the $WORKSPACE.tfvars file. I had to copy both into implementation/ecs
- 4.6.1 - I also had to manually update the aws provider in /ecs/.terraform/modules/ecs to match 5.70.0 to avoid version conflicts with other dependencies.