Skip to content

Commit 6e93f28

Browse files
committed
fix: Adding a bit of cleanup
1 parent 82d1ba3 commit 6e93f28

File tree

1 file changed

+7
-6
lines changed
  • docs/2.0/docs/pipelines/concepts/cloud-auth

1 file changed

+7
-6
lines changed

docs/2.0/docs/pipelines/concepts/cloud-auth/custom.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ Pipelines supports custom authentication mechanisms through the `custom` authent
66

77
This is a more advanced feature, and is not recommended for most users if they have a viable alternative listed in [Authenticating to the Cloud](/2.0/docs/pipelines/concepts/cloud-auth/index.md).
88

9-
Using custom authentication exposes more flexibility in how authentication is handled, but it also requires more responsibility from the user to ensure that the authentication script is secure and does not expose sensitive information.
9+
Using custom authentication provides more flexibility in how authentication is handled, but it also requires more responsibility from users to ensure that the authentication being used is secure and does not expose sensitive information.
1010

1111
If you are not sure if custom authentication is right for you, please contact Gruntwork support.
1212

1313
:::
1414

1515
## How custom authentication works
1616

17-
Pipelines supports custom authentication via Terragrunt's [auth provider command](https://terragrunt.gruntwork.io/docs/features/authentication/#auth-provider-command) feature. When you configure a `custom` authentication block, Pipelines sets the `TG_AUTH_PROVIDER_CMD` environment variable, which Terragrunt uses to execute your custom authentication script or command.
17+
Pipelines supports custom authentication via Terragrunt's [auth provider command](https://terragrunt.gruntwork.io/docs/features/authentication/#auth-provider-command) feature. When you configure a `custom` authentication block, Pipelines will execute the command specified in the `auth_provider_cmd` attribute, and pass the output of that command to Terragrunt (with the output expected to match the schema documented in Terragrunt's documentation for the auth provider command feature).
1818

1919
Your authentication provider command should output a JSON response to stdout that follows the schema expected by Terragrunt:
2020

@@ -41,7 +41,7 @@ All top-level objects are optional, and you can provide multiple. The `envs` obj
4141

4242
## Configuring custom authentication
4343

44-
Custom authentication is defined using environments specified in HCL configuration files in the `.gruntwork` directory.
44+
Custom authentication is defined using environments specified in HCL configuration files in the `.gruntwork` directory at the root of your repository.
4545

4646
### Basic configuration
4747

@@ -89,11 +89,11 @@ custom {
8989

9090
#### 3. Commands in PATH
9191

92-
You can reference commands available in your system's PATH:
92+
You can also reference commands available in your system's PATH:
9393

9494
```hcl
9595
custom {
96-
auth_provider_cmd = "custom-auth-provider --method=gcp --project=my-project"
96+
auth_provider_cmd = "my-custom-auth-provider --method=gcp --project=my-project"
9797
}
9898
```
9999

@@ -142,7 +142,8 @@ set -e
142142

143143
# Acquire a Cloudflare API token
144144
# This is just an example of how to acquire a Cloudflare API token from a secrets manager.
145-
# You can use any method you like to set environment variables like this, but you are encouraged never to hardcode secrets in your repository.
145+
# You can use any method you like to set environment variables like this,
146+
# but you are encouraged never to hardcode secrets in your repository.
146147
CLOUDFLARE_API_TOKEN=$(aws secretsmanager get-secret-value --secret-id cloudflare-api-token --query SecretString --output text)
147148

148149
# Output credentials in the format expected by Terragrunt

0 commit comments

Comments
 (0)