Commit Graph

110 Commits

Author SHA1 Message Date
Avi Zurel 96645d7ea7 website: Better example for running 0.12upgrade across many directories at once 2020-01-21 18:28:06 -08:00
Pam Selle cd6c93774a Update docs to reflect current behavior 2020-01-08 16:51:42 -05:00
Martin Atkins 2a95d98383 docs: terraform state show is not machine-readable
In earlier versions of Terraform the result of terraform state show was
in the pre-0.12 "flatmap" structure that was unable to reflect nested
data structures. That was fixed in Terraform 0.12, but as a consequence
this statement about the output being machine-parseable (which was
debateable even in older versions) is incorrect.

Fortunately, we now have "terraform show -json" to get output that is
intentionally machine-parseable, so we'll recommend to use that instead
here. The JSON output of that command is a superset of what's produced by
"terraform state show", so should be usable to meet any use-case that
might previously have been met by parsing the "terraform state show"
output.
2020-01-07 09:39:20 -08:00
Martin Atkins c06675c616 command: New -compact-warnings option
When warnings appear in isolation (not accompanied by an error) it's
reasonable to want to defer resolving them for a while because they are
not actually blocking immediate work.

However, our warning messages tend to be long by default in order to
include all of the necessary context to understand the implications of
the warning, and that can make them overwhelming when combined with other
output.

As a compromise, this adds a new CLI option -compact-warnings which is
supported for all the main operation commands and which uses a more
compact format to print out warnings as long as they aren't also
accompanied by errors.

The default remains unchanged except that the threshold for consolidating
warning messages is reduced to one so that we'll now only show one of
each distinct warning summary.

Full warning messages are always shown if there's at least one error
included in the diagnostic set too, because in that case the warning
message could contain additional context to help understand the error.
2019-12-10 11:53:14 -08:00
Martin Atkins 2423f266fb website: example of "terraform taint" with a grandchild module
I've seen folks ask about how to express this in resource address syntax
a number of times now, so adding this example here to illustrate how it
looks when there are multiple levels of module to traverse through.

This is redundant with other information further up the page, but having
it as an entirely separate example gives an opportunity to include more
introductory text to explain what the example is showing.
2019-11-11 10:12:11 -08:00
Pam Selle 5070ab7989
Merge pull request #23185 from scott1138/patch-1
Update taint docs - for_each
2019-10-31 13:16:53 -04:00
Pam Selle 22ae5cf52d Quote differently so render works 2019-10-28 13:04:38 -04:00
scott1138 c6baf28508
Update taint docs - for_each
Provide an explanation of how to taint a resource created with for_each
2019-10-24 14:53:45 -05:00
Pam Selle 91b5343d2f
Merge pull request #22626 from mixmatch/patch-1
Update output
2019-10-18 10:21:57 -04:00
Nick Fagerlund 02d793f0ff website / help: reconcile 'validate' command docs 2019-10-03 15:31:33 -07:00
ialidzhikov 57ecc304e1 Remove -check-variables flag from the docs
Signed-off-by: ialidzhikov <i.alidjikov@gmail.com>
2019-09-30 17:21:08 +03:00
Ryan Uber 0d3da9ce3f website: update link to api token documentation for terraform cloud 2019-09-24 12:21:03 -07:00
Kristin Laemmert 54661ec1df
command/import: fix error during import when implied provider was not used (#22855)
* command/import: properly use `-provider` supplied on the command line

The import command now attaches the provider configuration in the resource
instance, if set. That config is attached to the NodeAbstractResource
during the import graph building. This prevents errors when the implied
provider is not actually in the configuration at all, which may happen
when a configuration is using the `-beta` version of a provider (and
only that `-beta` version).

* command/import: fix variable reassignment and update docs

Fixes #22564
2019-09-20 10:02:42 -04:00
Pam Selle 0e1f12e570 Add some context for the addition 2019-09-19 16:46:12 -04:00
Pam Selle 740c9865f3 Add an example with string keys to taint to demonstrate escaping quotes 2019-09-19 13:40:29 -04:00
Vicken Simonian 853a0e0677 docs: Minor spelling and typo fixes 2019-09-05 10:08:34 -07:00
Kristin Laemmert 212d5b0b1c
Mildwonkey/docs updates (#22623)
* website/formatdate: update example

The given example was showing HOUR:MONTH instead of HOUR:MINUTE

Fixes #22598

* website/import: remove reference to no-longer-working option

Users can no longer supply `-config=""` to tell Terraform not to load
configuration for import.

Fixes #22294

* website/provisioners: `host` is required in connection blocks

Fixes #21877

* website/variables: clarify variable definition precedence

It was not entirely obvious that a variable could not be assigned
multiples times in a single source.

Fixes #21682

* website/backend/local: add `workspace_dir` attribute

Fixes #21391

* website/output: `sensitive` outputs are redacted in output

Fixes #21502

* website/backends: sidebar order tweak

It makes sense for backend 'configuration' to appear before 'init'.

Fixes #13796

* Revert "website/formatdate: update example"

This reverts commit ccd93c86ddd15a21625c0767702ee1cc62e77254.
2019-08-28 15:34:22 -04:00
Daniel Petty 4fc3ea6e09
Update output 2019-08-28 11:47:14 -06:00
Ben Drucker e8996e065e website: fix <ul> formatting in "taint" doc 2019-08-19 16:30:16 -07:00
Nick Fagerlund 3aa909ac6e website: Update URLs and name references for Terraform Cloud rebrand
The Terraform Enterprise brand has now been split into two parts:

- Terraform Cloud is the application that helps teams use Terraform together,
  with remote state storage, a shared run environment, etc.
- Terraform Enterprise is the on-premise distribution that lets enterprises run
  a private instance of the Terraform Cloud application.

The former TFE docs have been split accordingly.
2019-08-16 15:55:29 -07:00
Nick Fagerlund d316ea08c5 website: Delete terraform push docs; replace with note about the remote backend
Now that the last private installs of legacy TFE have been upgraded, the push
era is over.
2019-08-16 15:55:29 -07:00
Nick Fagerlund 011e84f32f website: Update example command list for 0.12 2019-08-16 15:55:29 -07:00
Brian Flad 0d19465ada
Merge pull request #22318 from hashicorp/d-cli-quote-resource-addresses
docs: Additional for_each commands and resource addressing documentation
2019-08-15 10:03:44 -04:00
Kristin Laemmert 1442ff047d
website/docs: document providers schema output format (#22361)
* website/docs: document providers schema output format

* Update website/docs/commands/providers/schema.html.md

Co-Authored-By: Nick Fagerlund <nick@hashicorp.com>
2019-08-15 09:57:51 -04:00
The Terraform Team fcb603616d
Merge pull request #20898 from sebbrandt87/patch-1
Removed -index from README
2019-08-06 22:17:20 +01:00
Sebastian Brandt 5d4826894c
Update website/docs/commands/untaint.html.markdown
Co-Authored-By: The Terraform Team <52939924+teamterraform@users.noreply.github.com>
2019-08-06 21:18:20 +02:00
Brian Flad 3a1a39bed3
docs/commands: Switch using count/for_each to configured with count/for_each
Reference: https://github.com/hashicorp/terraform/pull/22318#discussion_r310587243
2019-08-05 21:50:17 -04:00
Brian Flad 48624255ce
docs/commands: Show count and for_each resource address examples for commands
Verified on Mac OS 10.14.6 and Windows 10.
2019-08-02 19:36:24 -04:00
Radek Simko cc9797443b
Merge pull request #18820 from Sagar2366/patch-6
change from work to working directory
2019-07-18 15:26:05 +01:00
Radek Simko 30f3b5ee25
Merge pull request #21831 from NickMetz/update-cli-output-documentation
Update in terraform output documentation
2019-07-18 15:24:12 +01:00
Stefan Schmidt f4abb96b08 website/docs: add the fmt -recursive flag. (#21963) 2019-07-05 13:32:57 -04:00
Nick Fagerlund f76c491468
website: CLI config: Team tokens work with CLI actions (#21883)
Team tokens never worked with the `atlas` backend, but the `remote` backend
uses them as intended; they can perform plans and applies on workspaces where
the associated team has at least plan or write permissions, respectively.
2019-06-26 10:56:30 -07:00
Nick Metz 8eb6086cb2 \#21799 Since Terraform version 0.12 "-module=" is not a valid option for Terraform output aynmore. Also added missing option -no-color to documentation. 2019-06-21 09:31:31 +02:00
john-auld bfd9b552cc website: Correct fmt -check (#21631)
* Correct fmt -check

With `-check=false` the exit status is always zero.
With `-check=true` the exit status is zero when all files are properly formatted and non-zero otherwise.

* update fmt documentation to use short form for -diff and -check
2019-06-18 14:36:45 -07:00
Alisdair McDiarmid 812ba80dae Remove links to legacy Terraform Enterprise docs
These docs are due to be removed, so these links will shortly break.
Removal is in hashicorp/terraform-website#812
2019-06-07 13:47:12 -04:00
David Liao 97ad35f90c website: Update taint command docs to reflect new 0.12 usage 2019-06-03 15:36:38 -07:00
Michael Conlon 44c9e81d4c website: fix typo on the "terraform console" command page 2019-04-10 12:17:28 -07:00
Matthew Sanabria be04e70a0f
Adding documentation for TF_CLI_CONFIG_FILE environment variable (#20834)
Fixes #15849
2019-04-05 14:21:40 -04:00
Sebastian Brandt 1bd0f3512c
Removed -index from README
There is no `-index` option, instead you need to set the index as additional describer to the resource.
2019-04-02 16:11:51 +02:00
Nick Fagerlund 53cff99f84
website: Add `workspace show` command to sidebar nav (#20800) 2019-03-22 15:06:53 -07:00
Guillaume Dupin 4b8d11e2de Create commands/workspace/show.html.md (#18355)
Add documentation for `terraform workspace show` command
2019-03-22 14:04:59 -07:00
Nick Fagerlund cb4f3004da website: Fix several spelling errors 2019-03-21 18:12:11 -07:00
Nick Fagerlund 740aff3899 website: Update options for graph command
'legacy' doesn't seem to be a thing anymore, and we were missing some
of the other values for -type. Also -no-color doesn't seem to be
relevant to this command.
2019-03-21 18:11:50 -07:00
Justin Downing 1e32ae243c grammatical updates to comments and docs (#20195) 2019-03-21 14:05:41 -07:00
Daniel Schroeder b29102dbc6 website: Add TF_IN_AUTOMATION to environment variables page (#19721)
* Adds TF_IN_AUTOMATION description

Blatantly copied from https://learn.hashicorp.com/terraform/development/running-terraform-in-automation since it is missing on the [env var page](https://www.terraform.io/docs/configuration/environment-variables.html).

* Update website/docs/commands/environment-variables.html.md

Co-Authored-By: udondan <udondan@users.noreply.github.com>
2019-03-21 12:08:56 -07:00
HashedDan a2c91ca582 Docs: reference resource by index, fixes #18184 2019-03-19 09:42:05 -07:00
Martin Atkins 04f3766fd9 website: Indicate v0.12-only content
We have released the v0.12-oriented content to the website early in order
to support the beta process, but in some places we neglected to explicitly
mark features or content as being v0.12-only.

Here we add explicit markers to the main cases we've seen where readers
have reported confusion, along with some other tweaks in similar vein.
2019-03-18 12:42:21 -07:00
Nick Fagerlund 34e90ff3c1 website: Fix broken links to modules/usage and modules/create
As part of this, I'm copying the entire text of the 0.12
docs/configuration/modules.html page into docs/configuration-0-11/modules.html —
some of the 0.11 pages needed to be able to link to the moved content, I
didn't want to jump versions jarringly, and a close reading didn't reveal
anything in there that's inaccurate for 0.11.
2019-03-14 10:38:52 +00:00
Brian Flad 20a814028d
command: Consistency implement and document parallelism default of 10
References:
* f4da82a023/command/command.go (L41)
* b9d8e96e0c/terraform/context.go (L149-L155)
2019-03-06 09:25:36 -05:00
Kristin Laemmert 21f6e3dffd
Mildwonkey/012 docs updated (#20542)
* docs: update plan command documentation. Fixes #19235

* docs: added a missing reserved variable name. Fixes #19159.

* website: add note that resource names cannot start with a number

* website: add some notes to the 0.12 upgrade guide
2019-03-01 12:30:51 -08:00