From d7d8ea95436925686387be0b7318ac39dc87f0ad Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 28 Apr 2017 15:32:23 -0700 Subject: [PATCH] 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. --- .../source/docs/commands/index.html.markdown | 1 + .../docs/commands/providers.html.markdown | 36 +++++++++++++++++++ website/source/layouts/docs.erb | 4 +++ 3 files changed, 41 insertions(+) create mode 100644 website/source/docs/commands/providers.html.markdown diff --git a/website/source/docs/commands/index.html.markdown b/website/source/docs/commands/index.html.markdown index faff71bff..d48fcb1e6 100644 --- a/website/source/docs/commands/index.html.markdown +++ b/website/source/docs/commands/index.html.markdown @@ -41,6 +41,7 @@ Common commands: init Initialize a new or existing Terraform configuration output Read an output from a state file plan Generate and show an execution plan + providers Prints a tree of the providers used in the configuration push Upload this Terraform module to Terraform Enterprise to run refresh Update local state file against real resources show Inspect Terraform state or plan diff --git a/website/source/docs/commands/providers.html.markdown b/website/source/docs/commands/providers.html.markdown new file mode 100644 index 000000000..edf71721d --- /dev/null +++ b/website/source/docs/commands/providers.html.markdown @@ -0,0 +1,36 @@ +--- +layout: "docs" +page_title: "Command: providers" +sidebar_current: "docs-commands-providers" +description: |- + The "providers" sub-command prints information about the providers used + in the current configuration. +--- + +# Command: show + +The `terraform providers` command prints information about the providers +used in the current configuration. + +Provider dependencies are created in several different ways: + +* Explicit use of a `provider` block in configuration, optionally including + a version constraint. + +* Use of any resource belonging to a particular provider in a `resource` or + `data` block in configuration. + +* Existance of any resource instance belonging to a particular provider in + the current _state_. For example, if a particular resource is removed + from configuration, it continues to create a dependency on its provider + until its instances have been destroyed. + +This command gives an overview of all of the current dependencies, as an aid +to understanding why a particular provider is needed. + +## Usage + +Usage: `terraform show [config-path]` + +Pass an explicit configuration path to override the default of using the +current working directory. diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index c06eef29a..9da9816f9 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -109,6 +109,10 @@ plan + > + providers + + > push