Skip to content

Commit 9d59bd2

Browse files
docs: Clarify some details in README
- Distinguish between the frontend container and the "backend services" - Be a bit more specific about what's meant by segregating environments
1 parent f80fb42 commit 9d59bd2

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Platform engineers at Form3 build highly available distributed systems using inf
44

55

66
## 🧪 Sample application
7-
The sample application consists of four services:
7+
The sample application consists of four backend service containers and a frontend container:
88

99
```
1010
┌─────────────┐ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐
@@ -22,7 +22,7 @@ The sample application consists of four services:
2222
└──────────────┘
2323
```
2424

25-
Three of those services connect to [vault](https://www.vaultproject.io/) to retrieve database credentials. The frontend container serves a static file.
25+
The backend services connect to [vault](https://www.vaultproject.io/) to retrieve database credentials. The frontend container serves a static file.
2626

2727
The project structure is as follows:
2828

@@ -90,12 +90,12 @@ a7c0b089b10c vault:1.8.3 "docker-entrypoint.s…" 2
9090
```
9191

9292
## ⚙️ Task
93-
Imagine the following scenario, your company is growing quickly 🚀 and increasing the number services being deployed and configured.
93+
Imagine the following scenario, your company is growing quickly 🚀 and increasing the number of backend services being deployed and configured.
9494
It's been noticed that the code in `tf/main.tf` is not very easy to maintain 😢.
9595

9696
We would like you to complete the following tasks:
9797

98-
- [ ] Improve the Terraform code to make it easier to add/update/remove services
98+
- [ ] Improve the Terraform code to make it easier to add/update/remove backend services
9999
- [ ] Add a new environment called `staging` that runs each microservice
100100
- [ ] Add a README detailing:
101101
- [ ] Your design decisions, if you are new to Terraform let us know
@@ -116,9 +116,9 @@ We would like you to complete the following tasks:
116116
- Use only plain Terraform in your solution, i.e. anything supported by the Terraform CLI installed by the `run.sh` script, but not external tooling or libraries that wrap or extend Terraform, such as Terragrunt or tfenv
117117
- Only modify files in the `tf/` directory, `run.sh`, and `docker-compose.yml`
118118
- Keep the current versions of the services running in `development` and `production` environments
119-
- Structure your code in a way that will segregate environments
119+
- Structure your code in a way that will segregate environments, so a `terraform apply` for one environment can't affect another
120120
- 🚨 All environments (including staging) should be created when you run `vagrant up` and the apps should print `service started` and the secret data in their logs 🚨
121121
- Structure your code in a way that allows engineers to run different versions of services in different environments
122122

123123
### Should Nots
124-
- Do not use external tools that extend Terraform, such as Terragrunt.
124+
- Do not use external tools that extend Terraform, such as Terragrunt.

0 commit comments

Comments
 (0)