Added Backend Configuration to Terraform

.gitignore

@@ -25,7 +25,9 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+yarn.lock
 
 # terraform
 .terraform
 terraform.tfvars
+terraform/.terraform.lock.hcl

README.md

@@ -125,31 +125,37 @@ Before deployments or initializing terraform you must have aws sso configured an
 
 `aws sso login --profile BWTC-Developer`
 
-Terraform also needs the project secrets saved in `terraform/staging/terraform.tfvars`. This file is not committed to version control since it can contain sensitive information such as database credentials and should be added locally. Create the `terraform/staging/terraform.tfvars` file with the following structure:
+Terraform also needs the project secrets saved in `terraform/environment/staging.tfvars` and `terraform/environment/staging.backend.conf`. This new configurations will allow us to utilize terraform workspaces.
 
-```
-profile = "BWTC-Developer"
+Terraform workspaces are a way to manage multiple instances of the same infrastructure stack in parallel, such as for different environments like development, staging, and production. They allow you to switch between workspaces to update configurations and make changes without affecting other environments or duplicating your code.
 
-region = "us-west-2"
+### Configuring Terraform Environment Files
 
-web_domain_name = ""
+To configure staging environment you will need to change two values
 
-```
+1. navigate to `terraform/environment/staging.backend.conf` and change the key, replace the folder name in `<test-staging-boilerplate-client-react>` with the name of your project and then add a `-staging`.
 
-| Secret          |                                                                                             Note |
-| :-------------- | -----------------------------------------------------------------------------------------------: |
-| profile         |                              This must match the AWS credentials name on the development machine |
-| region          |                                                                      This is usually `us-west-2` |
-| web_domain_name | This will be the web domain name for the project, an example may be: `example.shift3sandbox.com` |
+The value will look like this in the file
+`key     = "<test-staging-boilerplate-client-react>/terraform.tfstate"`
 
-After adding the `terraform/staging/terraform.tfvars` file, `cd` into the `terraform/staging` directory and run the following commands to configure and build the AWS infrastructure for the sandbox environment
+2. navigate to `terraform/environment/staging.tfvars` and set the webdomain to `project-name-environment.shift3sandbox.com`
 
-```
-terraform init
-terraform apply
-```
+To initialize or switch to the staging environment run
+
+`yarn env:staging`
+
+To then deploy staging aws infrastructure run
+
+`yarn provision:staging`
+
+### Description of .backend.conf variables and values.
 
-The infrastructure can be updated by changing the Terraform configuration files and running these commands again.
+| Variable |                                                                                                          Note |
+| :------- | ------------------------------------------------------------------------------------------------------------: |
+| profile  | This must match the AWS credentials name on the development machine. You can locate the name in `.aws/config` |
+| region   |                                                                                   This is usually `us-west-2` |
+| bucket   |                                                 This will be a S3 bucket that holds your terraform state file |
+| key      |                               This will be the path to your Terraform state file located within an S3 bucket. |
 
 ### Environment Configuration
 

package.json

@@ -43,14 +43,28 @@
     "build": "tsc && vite build",
     "predeploy:staging": "tsc && vite build --mode staging",
     "predeploy:production": "tsc && vite build",
-    "deploy:staging": "aws s3 sync ./dist s3://<< replace-with-s3-bucket-name >> --profile shift3 --delete",
-    "deploy:production": "aws s3 sync ./dist s3://<< replace-with-s3-bucket-name >> --profile shift3 --delete",
+    "deploy:staging": "aws s3 sync ./dist s3://<< replace-with-s3-bucket-name >> --profile BWTC-Developer --delete",
+    "deploy:production": "aws s3 sync ./dist s3://<< replace-with-s3-bucket-name >> --profile client-profile --delete",
     "test": "echo",
     "test-ci": "echo",
     "test-cov": "echo",
     "test-cov-ci": "echo",
     "eject": "react-scripts eject",
     "prepare": "husky install",
+    "switch-state": "npm run terra:init -target=\"$npm_config_target\" -- -reconfigure",
+    "env:staging": "npm run switch-state -target=staging",
+    "env:production": "npm run switch-state -target=production",
+    "terra:init": "cd terraform && terraform init -backend-config=\"environment/$npm_config_target.backend.conf\"",
+    "terra:init-wrks": "cd terraform && if ! terraform workspace list | grep -q \"\\s$npm_config_name$\"; then terraform workspace new \"$npm_config_name\"; fi",
+    "terra:update": "cd terraform && terraform get -update",
+    "preprovision": "npm run terra:init && npm run terra:init-wrks -name=\"$npm_config_target\"",
+    "provision": "cd terraform && terraform workspace select \"$npm_config_target\" && terraform apply -var-file \"environment/$npm_config_target.tfvars\"",
+    "provision:staging": "npm run provision -target=staging",
+    "provision:production": "npm run provision -target=production",
+    "plan": "cd terraform && terraform workspace select \"$npm_config_target\" && terraform plan -var-file \"environment/$npm_config_target.tfvars\"",
+    "plan:dev": "npm run plan -target=development",
+    "plan:stg": "npm run plan -target=staging",
+    "plan:prod": "npm run plan -target=production",
     "i18n": "i18next **/*.tsx"
   },
   "browserslist": {

terraform/environment/production.tfvars

@@ -0,0 +1,2 @@
+# production site domain, livesite.com
+web_domain_name = ""

terraform/environment/productions.backend.conf

@@ -0,0 +1,4 @@
+bucket  = "production-terraform-state"
+key     = "<test-production-boilerplate-client-react>/terraform.tfstate"
+region  = "us-west-2"
+profile = ""

terraform/environment/staging.backend.conf

@@ -0,0 +1,4 @@
+bucket  = "shift3-terraform-state"
+key     = "<test-staging-boilerplate-client-react>/terraform.tfstate"
+region  = "us-west-2"
+profile = "BWTC-Developer"

terraform/main.tf

@@ -4,12 +4,7 @@ provider "aws" {
 }
 
 terraform {
-  backend "s3" {
-    bucket  = "shift3-terraform-state"
-    key     = "<initials or project name>-boilerplate-client-react/terraform.tfstate"
-    region  = "us-west-2"
-    profile = "BWTC-Developer"
-  }
+  backend "s3" {}
 
   required_providers {
     aws = {