Added readme for tfstate (#1061)

bcgov · Nov 23, 2023 · bfd1f55 · bfd1f55
1 parent 72d21e7
commit bfd1f55
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/infrastructure/aws-opensearch/README.md b/infrastructure/aws-opensearch/README.md
@@ -9,7 +9,7 @@ OpenSearch is Amazon's community-driven, 100% open-source version of Elastisearc
 
 ## Updating DEV
 
-* Connect to the BC Governemtn AWS login application and get your credentials to paste into a terminal
+* Connect to the BC Government AWS login application and get your credentials to paste into a terminal
 * `cd infrastructure/aws-opensearch/dev`
 * `terragrunt apply`
 * Update the main-elasticsearch-secret and develop-elasticsearch-secret on DEV and TEST OpenShift environments to ensure that the settings match AWS.
@@ -20,13 +20,13 @@ OpenSearch is Amazon's community-driven, 100% open-source version of Elastisearc
 
 ## Updating PROD
 
-* Connect to the BC Governemtn AWS login application and get your credentials to paste into a terminal
+* Connect to the BC Government AWS login application and get your credentials to paste into a terminal
 * `cd infrastructure/aws-opensearch/prod`
 * `terragrunt apply`
 * Update the main-elasticsearch-secret on the PROD OpenShift environments to ensure that the settings match AWS.
 
 ## Tearing down an environment
 
-* Connect to the BC Governemtn AWS login application and get your credentials to paste into a terminal
+* Connect to the BC Government AWS login application and get your credentials to paste into a terminal
 * `cd infrastructure/aws-opensearch/<ENVIRONMENT>`
 * `terragrunt destroy` should work, but you might need to use `terragrunt run-all destroy`
diff --git a/infrastructure/aws-opensearch/setup/README.md b/infrastructure/aws-opensearch/setup/README.md
@@ -0,0 +1,6 @@
+# Setting up terraform S3 state
+
+- Log into your terminal with the correct environment creds
+- Run `terraform init`
+- Run `terraform apply`
+- Delete all the extra files and folders that were created
diff --git a/infrastructure/aws-opensearch/setup/tfstate.tf b/infrastructure/aws-opensearch/setup/tfstate.tf
@@ -1,3 +1,7 @@
+variable "environment" {
+  description = "AWS workload account env (e.g. dev, test, prod, tools)"
+}
+
 resource "aws_s3_bucket" "terraform_state" {
   bucket = "bcparks-opensearch-${var.environment}-terraform-remote-state"
   force_destroy = true