Skip to content

Commit

Permalink
chore: more doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
thsig authored and eysi09 committed Feb 10, 2025
1 parent edd7127 commit ac65634
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 7 deletions.
6 changes: 2 additions & 4 deletions docs/terraform-plugin/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,10 @@ garden --env=<env-name> plugins terraform apply-root -- -auto-approve

For example, running `garden deploy --env dev` and `garden deploy --env ci` will pick the appropriate backend for the environment.

If you'd like to apply the stack when starting Garden (e.g. because you're provisioning a Kubernetes cluster and need to pass the outputs to other Garden providers), checkout [the Terraform provider docs for configuring dynamic backends](./configure-provider.md#setting-the-backend-dynamically).
If you'd like to apply the stack when starting Garden (e.g. because you're provisioning a Kubernetes cluster and need to pass the outputs to other Garden providers), check out [the Terraform provider docs for configuring dynamic backends](./configure-provider.md#setting-the-backend-dynamically).

If instead you configure your Terraform stack via actions (e.g. because you have
multiple AWS labmdas that should each have their own stack), checkout [the Terraform
action docs for configuring dynamic
backends](./actions.md#setting-the-backend-dynamically).
multiple AWS labmdas that should each have their own stack), check out [the Terraform action docs for configuring dynamic backends](./actions.md#setting-the-backend-dynamically).

## Next steps

Expand Down
4 changes: 2 additions & 2 deletions docs/terraform-plugin/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ defaultEnvironment: dev
environments:
- name: dev
variables:
tfNamespace: ${kebabCase(local.username)} # <--- Each user has their lambda
tfNamespace: ${kebabCase(local.username)} # <--- Each user has their own set of lambdas
- name: ci
variables:
tfNamespace: ${slice(git.commitHash, 0, 7) || '<detached>'} # <--- Each CI run has their lambda
tfNamespace: ${slice(git.commitHash, 0, 7) || '<detached>'} # <--- Each CI run has its own set of lambdas
---
kind: Deploy
Expand Down
2 changes: 1 addition & 1 deletion docs/terraform-plugin/configure-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ In the example below we can imagine a Terraform stack that provisions a Kubernet

We achieve this via the `backendConfig` field on the `terraform` provider spec which can make use of Garden's powerful templating system.

This means you can run `garden deploy` (for the dev env) and it'll use the corresponding backend. From the same host you could then run `garden deploy --env` without needing to update your config and manually re-intialize Terraform and it'll again pick the correct backend.
This means you can run `garden deploy` (for the dev env) and it will use the corresponding backend. From the same host you could then run `garden deploy --env` without needing to update your config and manually re-intialize Terraform, and it will again pick the correct backend.

```yaml
# In project.garden.yml file
Expand Down

0 comments on commit ac65634

Please sign in to comment.