Improve documentation around static evaluation (#1843)

Signed-off-by: Christian Mesh <christianmesh1@gmail.com>
Signed-off-by: ollevche <ollevche@gmail.com>
Co-authored-by: ollevche <ollevche@gmail.com>
This commit is contained in:
Christian Mesh
2024-07-23 09:31:50 -04:00
committed by GitHub
parent 89926cc97a
commit 3b3822d770
31 changed files with 640 additions and 12 deletions

View File

@@ -34,6 +34,30 @@ directory the path structure that is expected for filesystem-based provider
plugin mirrors, populating it with `.zip` files containing the plugins
themselves.
:::note
Use of variables in [module sources](../../../language/modules/sources.mdx#support-for-variable-and-local-evaluation)
requires [assigning values to root module variables](../../../language/values/variables.mdx#assigning-values-to-root-module-variables)
when running `tofu providers mirror`.
:::
This command accepts the following generic options:
* `-var 'NAME=VALUE'` - Sets a value for a single
[input variable](../../../language/values/variables.mdx) declared in the
root module of the configuration. Use this option multiple times to set
more than one variable. Refer to
[Input Variables on the Command Line](../plan.mdx#input-variables-on-the-command-line) for more information.
* `-var-file=FILENAME` - Sets values for potentially many
[input variables](../../../language/values/variables.mdx) declared in the
root module of the configuration, using definitions from a
["tfvars" file](../../../language/values/variables.mdx#variable-definitions-tfvars-files).
Use this option multiple times to include values from more than one file.
There are several other ways to set values for input variables in the root
module, aside from the `-var` and `-var-file` options. Refer to
[Assigning Values to Root Module Variables](../../../language/values/variables.mdx#assigning-values-to-root-module-variables) for more information.
OpenTofu will also generate various `.json` index files which contain suitable
responses to implement
[the network mirror protocol](../../../internals/provider-network-mirror-protocol.mdx),
@@ -41,7 +65,7 @@ if you upload the resulting directory to a static website host. OpenTofu
ignores those index files when using the directory as a filesystem mirror,
because the directory entries themselves are authoritative in that case.
This command supports the following additional option:
This command supports the following additional options:
* `-platform=OS_ARCH` - Choose which target platform to build a mirror for.
By default OpenTofu will obtain plugin packages suitable for the platform