You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/2.0/docs/pipelines/concepts/cloud-auth/custom.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,15 @@ Pipelines supports custom authentication mechanisms through the `custom` authent
6
6
7
7
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).
8
8
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.
10
10
11
11
If you are not sure if custom authentication is right for you, please contact Gruntwork support.
12
12
13
13
:::
14
14
15
15
## How custom authentication works
16
16
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).
18
18
19
19
Your authentication provider command should output a JSON response to stdout that follows the schema expected by Terragrunt:
20
20
@@ -41,7 +41,7 @@ All top-level objects are optional, and you can provide multiple. The `envs` obj
41
41
42
42
## Configuring custom authentication
43
43
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.
45
45
46
46
### Basic configuration
47
47
@@ -89,11 +89,11 @@ custom {
89
89
90
90
#### 3. Commands in PATH
91
91
92
-
You can reference commands available in your system's PATH:
92
+
You can also reference commands available in your system's PATH:
0 commit comments