ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/docs/commands/providers.html.markdown

23 lines
656 B
Markdown
Raw Normal View History

website: Initial docs for the new "providers" subcommand This will be fleshed out later as part of more holistic documentation for the new provider plugin separation, but this is some minimal documentation for just this subcommand.
2017-04-29 00:32:23 +02:00
---
website: Adopt islanded subcommands into unified "docs" (CLI) layout Several `terraform` subcommands include sub-sub-commands; with our old sidebar system, viewing those took you to an isolated "island" nav sidebar, away from the main docs. The new navigation will adopt all these pages, so we don't need to exile the reader to odd places.
2020-10-27 01:58:30 +01:00
layout: "docs"
website: Initial docs for the new "providers" subcommand This will be fleshed out later as part of more holistic documentation for the new provider plugin separation, but this is some minimal documentation for just this subcommand.
2017-04-29 00:32:23 +02:00
page_title: "Command: providers"
sidebar_current: "docs-commands-providers"
description: |-
website: add documentation for terraform providers schema (#20468) * website: add documentation for terraform providers schema
2019-02-27 20:08:31 +01:00
The `terraform providers` command prints information about the providers used
website: Initial docs for the new "providers" subcommand This will be fleshed out later as part of more holistic documentation for the new provider plugin separation, but this is some minimal documentation for just this subcommand.
2017-04-29 00:32:23 +02:00
in the current configuration.
---
website: correction of heading and usage in "providers" command docs
2017-06-03 02:10:32 +02:00
# Command: providers
website: Initial docs for the new "providers" subcommand This will be fleshed out later as part of more holistic documentation for the new provider plugin separation, but this is some minimal documentation for just this subcommand.
2017-04-29 00:32:23 +02:00
main: new global option -chdir This new option is intended to address the previous inconsistencies where some older subcommands supported partially changing the target directory (where Terraform would use the new directory inconsistently) where newer commands did not support that override at all. Instead, now Terraform will accept a -chdir command at the start of the command line (before the subcommand) and will interpret it as a request to direct all actions that would normally be taken in the current working directory into the target directory instead. This is similar to options offered by some other similar tools, such as the -C option in "make". The new option is only accepted at the start of the command line (before the subcommand) as a way to reflect that it is a global command (not specific to a particular subcommand) and that it takes effect _before_ executing the subcommand. This also means it'll be forced to appear before any other command-specific arguments that take file paths, which hopefully communicates that those other arguments are interpreted relative to the overridden path. As a measure of pragmatism for existing uses, the path.cwd object in the Terraform language will continue to return the _original_ working directory (ignoring -chdir), in case that is important in some exceptional workflows. The path.root object gives the root module directory, which will always match the overriden working directory unless the user simultaneously uses one of the legacy directory override arguments, which is not a pattern we intend to support in the long run. As a first step down the deprecation path, this commit adjusts the documentation to de-emphasize the inconsistent old command line arguments, including specific guidance on what to use instead for the main three workflow commands, but all of those options remain supported in the same way as they were before. In a later commit we'll make those arguments produce a visible deprecation warning in Terraform's output, and then in an even later commit we'll remove them entirely so that -chdir is the single supported way to run Terraform from a directory other than the one containing the root module configuration.
2020-09-02 00:45:12 +02:00
The `terraform providers` command shows information about the
[provider requirements](/docs/configuration/provider-requirements.html) of the
configuration in the current working directory, as an aid to understanding
where each requirement was detected from.
website: Initial docs for the new "providers" subcommand This will be fleshed out later as part of more holistic documentation for the new provider plugin separation, but this is some minimal documentation for just this subcommand.
2017-04-29 00:32:23 +02:00
main: new global option -chdir This new option is intended to address the previous inconsistencies where some older subcommands supported partially changing the target directory (where Terraform would use the new directory inconsistently) where newer commands did not support that override at all. Instead, now Terraform will accept a -chdir command at the start of the command line (before the subcommand) and will interpret it as a request to direct all actions that would normally be taken in the current working directory into the target directory instead. This is similar to options offered by some other similar tools, such as the -C option in "make". The new option is only accepted at the start of the command line (before the subcommand) as a way to reflect that it is a global command (not specific to a particular subcommand) and that it takes effect _before_ executing the subcommand. This also means it'll be forced to appear before any other command-specific arguments that take file paths, which hopefully communicates that those other arguments are interpreted relative to the overridden path. As a measure of pragmatism for existing uses, the path.cwd object in the Terraform language will continue to return the _original_ working directory (ignoring -chdir), in case that is important in some exceptional workflows. The path.root object gives the root module directory, which will always match the overriden working directory unless the user simultaneously uses one of the legacy directory override arguments, which is not a pattern we intend to support in the long run. As a first step down the deprecation path, this commit adjusts the documentation to de-emphasize the inconsistent old command line arguments, including specific guidance on what to use instead for the main three workflow commands, but all of those options remain supported in the same way as they were before. In a later commit we'll make those arguments produce a visible deprecation warning in Terraform's output, and then in an even later commit we'll remove them entirely so that -chdir is the single supported way to run Terraform from a directory other than the one containing the root module configuration.
2020-09-02 00:45:12 +02:00
This command also has several subcommands with different purposes, which
are listed in the navigation bar.
website: add documentation for terraform providers schema (#20468) * website: add documentation for terraform providers schema
2019-02-27 20:08:31 +01:00
website: Initial docs for the new "providers" subcommand This will be fleshed out later as part of more holistic documentation for the new provider plugin separation, but this is some minimal documentation for just this subcommand.
2017-04-29 00:32:23 +02:00
## Usage
main: new global option -chdir This new option is intended to address the previous inconsistencies where some older subcommands supported partially changing the target directory (where Terraform would use the new directory inconsistently) where newer commands did not support that override at all. Instead, now Terraform will accept a -chdir command at the start of the command line (before the subcommand) and will interpret it as a request to direct all actions that would normally be taken in the current working directory into the target directory instead. This is similar to options offered by some other similar tools, such as the -C option in "make". The new option is only accepted at the start of the command line (before the subcommand) as a way to reflect that it is a global command (not specific to a particular subcommand) and that it takes effect _before_ executing the subcommand. This also means it'll be forced to appear before any other command-specific arguments that take file paths, which hopefully communicates that those other arguments are interpreted relative to the overridden path. As a measure of pragmatism for existing uses, the path.cwd object in the Terraform language will continue to return the _original_ working directory (ignoring -chdir), in case that is important in some exceptional workflows. The path.root object gives the root module directory, which will always match the overriden working directory unless the user simultaneously uses one of the legacy directory override arguments, which is not a pattern we intend to support in the long run. As a first step down the deprecation path, this commit adjusts the documentation to de-emphasize the inconsistent old command line arguments, including specific guidance on what to use instead for the main three workflow commands, but all of those options remain supported in the same way as they were before. In a later commit we'll make those arguments produce a visible deprecation warning in Terraform's output, and then in an even later commit we'll remove them entirely so that -chdir is the single supported way to run Terraform from a directory other than the one containing the root module configuration.
2020-09-02 00:45:12 +02:00
Usage: `terraform providers`