Skip to content

Commit 5774dc0

Browse files
committed
update readme + image
1 parent ad23942 commit 5774dc0

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Template useful to create a AWS infrastructures with terraform
55
## Howo to use this template
66

77
1. Create your github repository starting form this template.
8-
2. Configure your aws cli and set the [credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html). Also refer the confluence page to work with [AWS SSO](https://pagopa.atlassian.net/wiki/spaces/DEVOPS/pages/466846955/AWS+-+Users+groups+and+roles#SSO-with-GSuite).
9-
3. The __src/init__ directory contains the terraform code to setup the S3 backend, the Dynamodb lock table, github openid connection and the iam role to use in the github actions
10-
4. The __src/main__ directory cointains the terraform code to setup the core infrastructure.
8+
2. Configure your **aws cli** and set the [credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html). Also refer the confluence page to work with [AWS SSO](https://pagopa.atlassian.net/wiki/spaces/DEVOPS/pages/466846955/AWS+-+Users+groups+and+roles#SSO-with-GSuite).
9+
3. The __./src/init__ directory contains the terraform code to setup the S3 backend, the Dynamodb lock table, github openid connection and the iam role to use in the github actions
10+
4. The __./src/main__ directory cointains the terraform code to setup the core infrastructure.
1111
5. The __.github/workflows__ directory contains two yaml files to run a terraform plan and apply actions. They need a github environment secret to be created: IAM_ROLE (see below.)
1212

1313
## Requirements
@@ -54,9 +54,12 @@ In the repository two github actions are already provided:
5454
* It can also be triggerd manually in all the environment expect main.
5555

5656

57+
![](./docs/gitaction-workflow.png)
58+
59+
5760
### Configurations
5861

59-
* Create [github environment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment) for every environments:dev, uat, prod, and prod_w.
62+
* Create [github environment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment) for every environments:**dev**, **uat**, **prod**, and **prod_w**.
6063
* **prod_w** is like prod but it is meant to be used only in the apply action in production.
6164

6265
![](docs/github-environments.png)

docs/gitaction-workflow.png

122 KB
Loading

0 commit comments

Comments
 (0)