Skip to content

Commit d9a7410

Browse files
authored
docs: updated docs (#121)
Signed-off-by: Ales Verbic <[email protected]>
1 parent fb614b5 commit d9a7410

File tree

5 files changed

+11
-7
lines changed

5 files changed

+11
-7
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ fined-grained instructions. Bootstrap and Stage 0 are optional if you bring your
2727
| Stage 2 | Shared services workload setup | [docs](stage2/README.md) |
2828
| Stage 3 | Extensions setup | [docs](stage3/README.md) |
2929

30-
3130
### Quick Start
3231

3332
The fastest way to configure your cluster is using the `bin/bootstrap-cloud` script.
3433
Out of the box, this will configure a local `k3d` cluster. To configure a default
3534
cluster in AWS in the us-west-2 region, you only need to provide two configuration
36-
items.
35+
items or GCP in us-central1.
3736

3837
config.yaml:
38+
3939
```yaml
4040
cloud_provider: aws
4141
cloudflared_token: eyJhI...
@@ -66,6 +66,7 @@ First, configure the `config.yaml` file as you would for bootstrap, but you must
6666
also include the correct information for the Terraform bucket created by bootstrap.
6767

6868
config.yaml:
69+
6970
```yaml
7071
cloud_provider: aws
7172
cloudflared_token: eyJhI...

config.yaml.example

+3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ terraform_project_id: <project_id>
1515
terraform_state_bucket: pre-configured-bucket
1616
terraform_state_region: eu-central-1
1717

18+
# GCP specific configuration
19+
terraform_state_kmskey: <kms_key_id>
20+
1821
# Overrides for defaults for configuring a cluster using bootstrap and stage0/aws-terraform in AWS. These override the defaults
1922
# in common/defaults.yaml
2023
azs: [eu-central-1b, eu-central-1c]

stage1/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Stage 1 of the bootstrap procedure is responsible for setting up static resource
1212

1313
### Define your Terraform backend
1414

15-
Add a `backend.tf` file in the stage1 directory and include your particular backend configuration. For example:
15+
Add a `backend.tf` file in the stage1 directory and include your particular backend configuration. If you run `bin/bootstrap-cloud` the `backend.tf` should be automatically generated. For example AWS S3 backend configuration:
1616

1717
```tf
1818
terraform {

stage2/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Stage 2 of the bootstrap procedure is responsible for setting up active workload
1212

1313
### Define your Terraform backend
1414

15-
Add a `backend.tf` file in the stage1 directory and include your particular backend configuration. For example:
15+
Add a `backend.tf` file in the stage1 directory and include your particular backend configuration. If you run `bin/bootstrap-cloud` the `backend.tf` should be automatically generated. For example AWS S3 backend configuration:
1616

1717
```tf
1818
terraform {
@@ -62,4 +62,4 @@ The execution of the command might take a while depending on the specific cluste
6262

6363
## Next Steps
6464

65-
You're done with stage 2. You can continue with [Stage 3](../stage3/README.md)
65+
You're done with stage 2. You can continue with [Stage 3](../stage3/README.md)

stage3/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Stage 3 of the bootstrap procedure is responsible for setting up any use-case sp
1212

1313
### Define your Terraform backend
1414

15-
Add a `backend.tf` file in the stage1 directory and include your particular backend configuration. For example:
15+
Add a `backend.tf` file in the stage1 directory and include your particular backend configuration. If you run `bin/bootstrap-cloud` the `backend.tf` should be automatically generated. For example AWS S3 backend configuration:
1616

1717
```tf
1818
terraform {
@@ -63,4 +63,4 @@ The execution of the command might take a while depending on the specific cluste
6363

6464
## Next Steps
6565

66-
You're done with cluster provisioning! You can start using your Demeter instance.
66+
You're done with cluster provisioning! You can start using your Demeter instance.

0 commit comments

Comments
 (0)