From dff6a8431ce0d0e391dcb1352f16ba7964793cfb Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Tue, 5 Apr 2022 13:23:46 -0600 Subject: [PATCH] Apply doc suggestions from code review Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/cli/config/config-file.mdx | 9 +++------ website/docs/internals/remote-service-discovery.mdx | 3 +-- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/website/docs/cli/config/config-file.mdx b/website/docs/cli/config/config-file.mdx index afadb2fdd3..27b55db462 100644 --- a/website/docs/cli/config/config-file.mdx +++ b/website/docs/cli/config/config-file.mdx @@ -118,10 +118,8 @@ Terraform Cloud responds to API calls at both its current hostname ### Environment Variable Credentials If you would prefer not to store your API tokens directly in the CLI -configuration, you may use a host-specific environment variable. For example, -the value of a variable named `TF_TOKEN_app_terraform_io` will be used as an -Authorization: Bearer token whenever making service requests to the hostname -"app.terraform.io". +configuration, you may use a host-specific environment variable. Environment variable names should be the prefix `TF_TOKEN_` added to the domain name. For example, +the value of a variable named `TF_TOKEN_app_terraform_io` will be used as a bearer authorization token when the CLI makes service requests to the hostname "app.terraform.io". Internationalized domain names should be converted to their [punycode equivalent](https://www.charset.org/punycode) with an ACE prefix when used as a variable name. For example, token credentials @@ -129,8 +127,7 @@ for 例えば.com should be set in a variable called `TF_TOKEN_xn--r8j3dr99h_com ### Credentials Helpers -Finally, you may instruct Terraform to use a different credentials storage mechanism -by configuring a special kind of plugin program called a _credentials helper_. +You can configure a `credentials_helper` to instruct Terraform to use a different credentials storage mechanism. ```hcl credentials_helper "example" { diff --git a/website/docs/internals/remote-service-discovery.mdx b/website/docs/internals/remote-service-discovery.mdx index 31116c301c..1a652106e1 100644 --- a/website/docs/internals/remote-service-discovery.mdx +++ b/website/docs/internals/remote-service-discovery.mdx @@ -90,8 +90,7 @@ At present, the following service identifiers are in use: ## Authentication If credentials for the given hostname are available in -[the CLI config, by a credential helper, or using a host-specific environment variable](/cli/config/config-file#Credentials) -then they will be included in the request for the discovery document. +[the CLI config](/cli/config/config-file#Credentials) through a `credentials_helper` or a host-specific environment variable, then they will be included in the request for the discovery document. The credentials may also be provided to endpoints declared in the discovery document, depending on the requirements of the service in question.