add headings, reorder
- ID
d2d8650- date
2023-05-01 07:05:31+00:00- author
Alex Chan <alex@alexwlchan.net>- parent
571c1aa- message
add headings, reorder- changed files
1 file, 20 additions, 17 deletions
Changed files
terraform/README.md (2421) → terraform/README.md (2497)
diff --git a/terraform/README.md b/terraform/README.md
index 4c205a1..1aa8334 100644
--- a/terraform/README.md
+++ b/terraform/README.md
@@ -2,22 +2,9 @@
These scripts are all aliases around [Terraform], the infrastructure-as-code tool we use at work.
-In some of our Terraform configurations, we use wrapper scripts `run_terraform.sh` instead of invoking `terraform` directly.
-This wrapper script fetches API keys for the [Elastic Cloud] and [Auth0] providers, so we don't have to hard-code them or store them locally.
-Something like:
-
-```shell
-EC_API_KEY=$(aws secretsmanager get-secret-value \
- --secret-id "elastic_cloud/api_key" \
- --output text \
- --query "SecretString")
-
-EC_API_KEY="$EC_API_KEY" terraform "$@"
-```
-
-My `tf` scripts will choose whether to run a wrapper script or vanilla `terraform`, so I don't have to think about it.
+[Terraform]: https://www.terraform.io/
-My scripts are:
+## The individual scripts
<dl>
<dt>
@@ -68,6 +55,22 @@ My scripts are:
</dd>
</dl>
-[Terraform]: https://www.terraform.io/
+## Choosing between `terraform` and `run_terraform.sh`
+
+In some of the Terraform configurations at work, we use wrapper scripts `run_terraform.sh` instead of invoking `terraform` directly.
+This wrapper script fetches API keys for the [Elastic Cloud] and [Auth0] providers, so we don't have to hard-code them or store them locally.
+Something like:
+
+```shell
+EC_API_KEY=$(aws secretsmanager get-secret-value \
+ --secret-id "elastic_cloud/api_key" \
+ --output text \
+ --query "SecretString")
+
+EC_API_KEY="$EC_API_KEY" terraform "$@"
+```
+
+My `tf` scripts will choose whether to run a wrapper script or vanilla `terraform`, so I don't have to think about it.
+
[Elastic Cloud]: https://registry.terraform.io/providers/elastic/ec/latest/docs#using-your-api-key-on-the-elastic-cloud-terraform-provider
-[Auth0]: https://registry.terraform.io/providers/auth0/auth0/latest/docs#environment-variables
\ No newline at end of file
+[Auth0]: https://registry.terraform.io/providers/auth0/auth0/latest/docs#environment-variables