Skip to content

Commit

Permalink
update docs to include suggestions for directory/environment management
Browse files Browse the repository at this point in the history
  • Loading branch information
alismx committed Nov 4, 2024
1 parent a7cf09c commit 6f6b3ed
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/deployment_apply.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ jobs:
defaults:
run:
shell: bash
# this may need to be updated if you change the directory you are working with
# ./terraform/implementation/dev || ./terraform/implementation/prod for example
# this practice is recommended to keep the terraform code organized while reducing the risk of conflicts
working-directory: ./terraform/implementation/ecs
steps:
- name: Check Out Changes
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/deployment_plan.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ jobs:
defaults:
run:
shell: bash
# this may need to be updated if you change the directory you are working with
# ./terraform/implementation/dev || ./terraform/implementation/prod for example
# this practice is recommended to keep the terraform code organized while reducing the risk of conflicts
working-directory: ./terraform/implementation/ecs
steps:
- name: Check Out Changes
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,9 +193,10 @@ The setup.sh script will create the following files:

## 4.6 Run Terraform Code In Your Designated Environment
<em><strong>4.6.1. Run ECS Module Locally</em></strong>
* To run your ECS Module Changes in your local terminal, navigate to _terraform/implementation/ecs/_ and run the following command: `cd /terraform/implementation`.
* It is highly recommended to create a new directory per environment that is launched, to do so run `cp terraform/implementation/ecs terraform/implementation/{insertEnvironmentName}`.
* To run your ECS Module Changes in your local terminal, navigate to your working directory, ` cd terraform/implementation/ecs/` or `cd terraform/implementation/{insertEnvironmentName}`
* In your terminal run the deploy script for your designated environment `./deploy.sh -e {insertEnvironmentName}`.\
&nbsp;&nbsp;&nbsp;&nbsp;<u><em><strong>Note</em></strong></u>: The _-e_ tag stands for environment and you can specify `dev`, `stage`, `prod`
&nbsp;&nbsp;&nbsp;&nbsp;<u><em><strong>Note</em></strong></u>: The _-e_ tag stands for environment and you can specify `dev`, `stage`, `prod`, this can match your environment naming convention.
&nbsp;&nbsp;&nbsp;&nbsp;or whatever environment your team desires.

[Return to Table of Contents](#table-of-contents).
Expand Down Expand Up @@ -226,7 +227,7 @@ The setup.sh script will create the following files:

## 4.10 Update Variables
<em><strong>4.10.1. Update Other Default Variables</em></strong>
* Navigate to the _defaults.tfvars_ file `cd terraform/implementation/ecs/default.tfvars`.
* Navigate to the _defaults.tfvars_ file ` cd terraform/implementation/ecs/` or `cd terraform/implementation/{insertEnvironmentName}`.
* In this _defaults.tfvars_ file, you can update and override any other default values.

<em><strong>4.10.2. Test and Validate Your Changes</em></strong>
Expand Down

0 comments on commit 6f6b3ed

Please sign in to comment.