18 Commits (69ebfd6f037f8d51709770cc36d266bb86cf950d)

Author	SHA1	Message	Date
ritsok	595646916f	Link refresh tutorial from plan and refresh docs pages	5 years ago
Laura Pacilio	f9ec36383d	Merge pull request #29011 from vlad-ro/patch-1 ... Add back missing closing quote character	5 years ago
Martin Atkins	a945b379d8	website: Explicit examples of -var escaping in various shells ... The -var command line option comes with the disadvantage that a user must contend both with Terraform's own parser and with the parser in whichever shell they've decided to use, and different shells on different platforms have different rules. Previously we've largely just assumed that folks know the appropriate syntax for the shell they chose, but it seems that command lines involving spaces and other special characters arise rarely enough in other commands that Terraform is often the first time someone needs to learn the appropriate syntax for their shell. We can't possibly capture all of the details of all shells in our docs, because that's far outside of our own scope, but hopefully this new section will go some way to give some real examples that will help folks figure out how to write suitable escape sequences, if they choose to set complex variable values on the command line rather than in .tfvars as we recommend elsewhere on this page.	5 years ago
Vlad Romanenko	d4d56a96b1	Add back missing closing quote character	5 years ago
Judith Malnick	044c439dbc	Gloss of top docs pages (#28891) ... * clarify input variables opening sentence * adjust variables description * claraify providers text and add learn callout * add description to providers page * add desscription and clarify provider configuration * add deprecation note to versions in proivder configs * add hands on callout and clarify next steps in intro * link to language collection from language docs * give more context about configurtion language up front * clarify output top page * reorganize for each intro to present feature before notes * move description before link out and remove passive voice * fix typo * clarify purpose of plan * move explanation before learn link and fully spell boolean * add a syntax heading to separate intro from details * add learn callout to module source docs * clean up intro to provider requirements and add link * Apply suggestions from code review Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>	5 years ago
Martin Atkins	6d80088f51	website: More accurate release versions for new plan options ... While we were working on and documenting these it wasn't clear exactly what Terraform CLI version they would land in, and so we used "Terraform v1.0" in the docs as a safe bound that was definitely going to include all of them. With everything now landed though, we can be more specific about which v0.15.x minor release each of these appeared in.	5 years ago
Alisdair McDiarmid	f9fc47c22e	website: Add documentation for machine readable UI ... Terraform 0.15.3 added support for a `-json` flag to the plan, apply, and refresh commands, which renders the Terraform UI output in a structured machine readable format. This commit adds documentation for this interface.	5 years ago
Karol Szczepański	f684f91f3f	website/docs(plan): fix minor typos (#28713)	5 years ago
Martin Atkins	3c8a4e6e05	command+backend/local: -refresh-only and drift detection ... This is a light revamp of our plan output to make use of Terraform core's new ability to report both the previous run state and the refreshed state, allowing us to explicitly report changes made outside of Terraform. Because whether a plan has "changes" or not is no longer such a straightforward matter, this now merges views.Operation.Plan with views.Operation.PlanNoChanges to produce a single function that knows how to report all of the various permutations. This was also an opportunity to fill some holes in our previous logic which caused it to produce some confusing messages, including a new tailored message for when "terraform destroy" detects that nothing needs to be destroyed. This also allows users to request the refresh-only planning mode using a new -refresh-only command line option. In that case, Terraform _only_ performs drift detection, and so applying a refresh-only plan only involves writing a new state snapshot, without changing any real infrastructure objects.	5 years ago
Martin Atkins	42e0985839	command: use -lock=false consistently in -help output ... Previously the docs for this were rather confusing because they showed an option to turn _on_ state locking, even though it's on by default. Instead, we'll now show -lock=false in all cases and document it as _disabling_ the default locking. While working on this I also noticed that the equivalent docs on the website were differently inconsistent. I've not made them fully consistent here but at least moreso than they were before.	5 years ago
Martin Atkins	1d3e34e35e	command: New -replace=... planning option ... This allows a similar effect to pre-tainting an object but does the action within the context of a normal plan and apply, avoiding the need for an intermediate state where the old object still exists but is marked as tainted. The core functionality for this was already present, so this commit is just the UI-level changes to make that option available for use and to explain how it contributed to the resulting plan in Terraform's output.	5 years ago
Martin Atkins	6bed3008a5	website: Reworking of the "terraform plan" docs, and related pages ... It's been a long time since we gave this page an overhaul, and with our ongoing efforts to make plan and apply incorporate all of the side-effects that might need to be done against a configuration it seems like a good time for some restructuring in that vein. The starting idea here is to formally split the many "terraform plan" options into a few different categories: - Planning modes - Planning options - Other options The planning modes and options are the subset that are also accepted by "terraform apply" when it's running in its default mode of generating a plan and then prompting for interactive approval of it. This then allows us to avoid duplicating all of that information on the "terraform apply" page, and thus allows us to spend more words discussing each of them. This set of docs is intended as a fresh start into which we'll be able to more surgically add in the information about -refresh-only and -replace=... once we have those implemented. Consequently there are some parts of this which may seem a little overwraught for what it's currently describing; that's a result of my having prepared this by just deleting the -refresh-only and -replace=... content from our initial docs draft and submitted the result, in anticipation of re-adding the parts I've deleted here in the very near future in other commits.	5 years ago
Sam Velie	5d04c4ea27	docs: correct spelling of normally (#28508)	5 years ago
Robin Norwood	e3bd661470	Merge pull request #28164 from hashicorp/rln-add-resource-targeting-tutorial-callout ... Add callout to resource targeting tutorial	5 years ago
Martin Atkins	6f35c2847b	command: Reorganize docs of the local backend's legacy CLI options ... We have these funny extra options that date back to before Terraform even had remote state, which we've preserved along the way by most recently incorporating them as special-case overrides for the local backend. The documentation we had for these has grown less accurate over time as the details have shifted, and was in many cases missing the requisite caveats that they are only for the local backend and that backend configuration is the modern, preferred way to deal with the use-cases they were intended for. We always have a bit of a tension with this sort of legacy option because we want to keep them documented just enough to be useful to someone who finds an existing script/etc using them and wants to know what they do, but not to take up so much space that they might distract users from finding the modern alternative they should consider instead. As a compromise in that vein here I've created a new section about these options under the local backend documentation, which then gives us the space to go into some detail about the various behaviors and interactions and also to discuss their history and our recommended alternatives. I then simplified all of the other mentions of these in command documentation to just link to or refer to the local backend documentation. My hope then is that folks who need to know what these do can still find the docs, but that information can be kept out of the direct path of new users so they can focus on learning about remote backends instead. This is certainly not the most ideal thing ever, but it seemed like the best compromise between the competing priorities I described above.	5 years ago
Robin Norwood	31323b911b	Add callout to resource targeting tutorial	5 years ago
Nick Fagerlund	d1e8537b33	website: CLI: Update links to moved docs pages	5 years ago
Nick Fagerlund	a8332703c9	website: CLI: Move docs files to match new URLs	5 years ago