Skip to content

Commit

Permalink
Merge pull request #68 from hackforla/67-move-backend-tfvars-block
Browse files Browse the repository at this point in the history
67 - Move local tfvars documentation block
  • Loading branch information
ale210 authored Sep 12, 2024
2 parents 58ba8b1 + 3a87d64 commit 3abf4ab
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ Below are guidelines for contributing to the devops-security repository hosted o
- [**Generating Access Keys for AWS CLI**](#generating-access-keys-for-aws-cli)
- [**Installing Terraform**](#installing-terraform)
- [**Creating Backend State**](#creating-backend-state)
- [**Creating Local tfvars file**](#creating-local-tfvars-file)
- [**Installing Terraform docs**](#installing-terraform-docs)
- [**Clone (Create) a copy on your computer**](#clone-create-a-copy-on-your-computer)
- [**Create a new branch where you will work on your issue**](#create-a-new-branch-where-you-will-work-on-your-issue)
- [**Creating Local tfvars file**](#creating-local-tfvars-file)
- [**Terraform Setup and Execution Instructions**](#terraform-setup-and-execution-instructions)
- [**Submitting changes via git and opening a PR**](#submitting-changes-via-git-and-opening-a-pr)

Expand Down Expand Up @@ -192,23 +192,6 @@ aws dynamodb create-table \
<sub>[Back to Table of Contents](#table-of-contents)</sub>
***

### **Creating Local tfvars file**

After creating a backend state, create a `backend.tfvars` file in the `terraform` directory. It should have content of this format:

```terraform
bucket = "USERNAME-hfla-ops-terraform-state"
key = "devops-security/terraform.tfstate"
region = "us-east-2"
dynamodb_table = "hfla_ops_terraform_table"
encrypt = true
```

Remember to match these values to the ones in your backend state (and replace USERNAME with your username)

<sub>[Back to Table of Contents](#table-of-contents)</sub>
***

### **Installing Terraform**

Use the [Official HashiCorp install instructions](https://developer.hashicorp.com/terraform/install) for installing terraform.
Expand Down Expand Up @@ -276,6 +259,23 @@ When you've finished working on your issue, follow the steps below to prepare yo
<sub>[Back to Table of Contents](#table-of-contents)</sub>
***
### **Creating Local tfvars file**
After creating a backend state, create a `backend.tfvars` file in the `terraform` directory. It should have content of this format:
```terraform
bucket = "USERNAME-hfla-ops-terraform-state"
key = "devops-security/terraform.tfstate"
region = "us-east-2"
dynamodb_table = "hfla_ops_terraform_table"
encrypt = true
```
Remember to match these values to the ones in your backend state (and replace USERNAME with your username)
<sub>[Back to Table of Contents](#table-of-contents)</sub>
***
### **Terraform Setup and Execution Instructions**
Make the required changes and execute them to see the changes in your own AWS account
Expand Down

0 comments on commit 3abf4ab

Please sign in to comment.