jprdonnelly/opentf
1
0
Fork 0
mirror of https://github.com/opentffoundation/opentf.git synced 2025-12-19 17:59:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

cliconfig: Registry protocol retry count and timeout settings

Browse Source 
These were previously settable only via environment variables. These are
now handled as part of CLI Configuration and so also settable in a new
"registry_protocols" block in a CLI configuration file, with the
environment variables now treated as if they are an additional virtual
configuration file containing the corresponding settings.

This handles our settings in our modern style where package cliconfig is
responsible for deciding the configuration and then package main reacts
to that configuration without being aware of how it is decided.

Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
This commit is contained in:
Martin Atkins
2025-09-09 15:03:06 -07:00
parent e76a772102
commit 2d2b08517e
19 changed files with 658 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
website/docs/cli/config/config-file.mdx
View File

@@ -75,6 +75,11 @@ The following settings can be set in the CLI configuration file:
`tofu init` when installing provider plugins. See
[Provider Installation](#provider-installation) below for more information.
* `registry_protocols` - configures some infrequently-needed settings
controlling how OpenTofu requests metadata from module and provider
registries.
Refer to [Registry Protocol Settings](#registry-protocol-settings) below for more information.
## Credentials
When interacting with OpenTofu-specific network services, OpenTofu expects
@@ -513,3 +518,42 @@ configure it, and how it interacts with the dependency lock file may all evolve
in future OpenTofu releases, including possible breaking changes. We therefore
recommend using development overrides only temporarily during provider
development work.
## Registry Protocol Settings
The CLI configuration block `registry_protocols` controls a small number of
rarely-needed settings for customizing the retry behavior and request timeouts
when OpenTofu makes metadata requests to module and provider registries.
```hcl
registry_protocols {
# retry_count specifies how many times OpenTofu can
# retry a registry metadata request when the response
# is a retry-eligible error.
#
# This can also be set using an environment variable:
# TF_REGISTRY_DISCOVERY_RETRY=1
retry_count = 1
# request_timeout_seconds specifies how long OpenTofu
# should wait for a response to a registry metadata
# request, in seconds.
#
# This can also be set using an environment variable:
# TF_REGISTRY_CLIENT_TIMEOUT=10
request_timeout_seconds = 10
}
```
The values in the example above are the current defaults, although the
defaults are subject to change in future versions of OpenTofu.
These settings are used only when making requests to the _OpenTofu-native_
registry protocols, and when performing service discovery to find service
endpoints for a particular hostname.
These settings do not affect any other requests made by OpenTofu, including
requests to download the actual module or provider packages, or requests to
other kinds of installation sources such as OCI registries.

12
website/docs/cli/config/environment-variables.mdx
View File

@@ -128,17 +128,13 @@ exact output differences can change between minor OpenTofu versions.
## TF_REGISTRY_DISCOVERY_RETRY
Set `TF_REGISTRY_DISCOVERY_RETRY` to configure the max number of request retries
the remote registry client will attempt for client connection errors or
500-range responses that are safe to retry.
Equivalent to the `retry_count` setting in the
[Registry Protocol Settings](../../cli/config/config-file.mdx#registry-protocol-settings).
## TF_REGISTRY_CLIENT_TIMEOUT
The default client timeout for requests to the remote registry is 10s. `TF_REGISTRY_CLIENT_TIMEOUT` can be configured and increased during exceptional circumstances.
```shell
export TF_REGISTRY_CLIENT_TIMEOUT=15
```
Equivalent to the `request_timeout_seconds` setting in the
[Registry Protocol Settings](../../cli/config/config-file.mdx#registry-protocol-settings).
## TF_CLI_CONFIG_FILE