Skip to content

docs: Clarify some details in README #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrew-bulford-form3 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Clarify some details in README #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Platform engineers at Form3 build highly available distributed systems using inf


## 🧪 Sample application
The sample application consists of four services:
The sample application consists of three backend service containers and a frontend container:

```
┌─────────────┐ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐
Expand All @@ -22,7 +22,7 @@ The sample application consists of four services:
└──────────────┘
```

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

The project structure is as follows:

Expand Down Expand Up @@ -90,12 +90,12 @@ a7c0b089b10c vault:1.8.3 "docker-entrypoint.s…" 2
```

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

We would like you to complete the following tasks:

- [ ] Improve the Terraform code to make it easier to add/update/remove services
- [ ] Improve the Terraform code to make it easier to add/update/remove backend services
- [ ] Add a new environment called `staging` that runs each microservice
- [ ] Add a README detailing:
- [ ] Your design decisions, if you are new to Terraform let us know
Expand All @@ -116,9 +116,9 @@ We would like you to complete the following tasks:
- 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
- Only modify files in the `tf/` directory, `run.sh`, and `docker-compose.yml`
- Keep the current versions of the services running in `development` and `production` environments
- Structure your code in a way that will segregate environments
- Structure your code in a way that will segregate environments, so a `terraform apply` for one environment can't affect another
- 🚨 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 🚨
- Structure your code in a way that allows engineers to run different versions of services in different environments

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