mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-17 18:52:30 -05:00
Note about the purpose of deployers in main.tf
This commit is contained in:
@@ -1,6 +1,10 @@
|
||||
# Terraform
|
||||
|
||||
This directory holds the Terraform modules for maintaining Notify.gov's infrastructure. You can [read about the structure](#structure) or [get set up to develop](#retrieving-existing-bucket-credentials).
|
||||
This directory holds the Terraform modules for maintaining Notify.gov's API infrastructure. You can might want to:
|
||||
* [read about the directory structure](#structure), or
|
||||
* [get set up to develop HCL code](#retrieving-existing-bucket-credentials).
|
||||
|
||||
The Admin app repo [has its own terraform directory](https://github.com/GSA/notifications-admin/tree/main/terraform) but a lot of the below instructions apply to both apps.
|
||||
|
||||
## Retrieving existing bucket credentials
|
||||
|
||||
@@ -70,6 +74,8 @@ deploy the application from the CI/CD pipeline. Create a new account by running:
|
||||
|
||||
`./create_service_account.sh -s <SPACE_NAME> -u <ACCOUNT_NAME>`
|
||||
|
||||
SpaceDeployers are also needed to run Terraform locally — they fill user and password input variables (via `deployers` within `main.tf`) that some of our Terraform modules require when they start running. Using a SpaceDeployer account locally is covered in [the next section](#workflow-for-deployed-environments).
|
||||
|
||||
## Workflow for deployed environments
|
||||
|
||||
These are the steps for developing Terraform code for our deployed environment modules (`sandbox`, `demo`, `staging` and `production`) locally on your laptop. Or for setting up a new deployment environment, or otherwise for running Terraform manually in any module that uses remote state. You don't need to do all this to run code in the `development` module, because it is not a deployed environment and it does not use remote state.
|
||||
|
||||
Reference in New Issue
Block a user