63 Commits (fc63c1949de7248eeff646b3331e0846f93fc094)

Author	SHA1	Message	Date
Neeraj Kumar	6b0be752bf	Updated line width	5 years ago
Neeraj Kumar	21136cf2fe	Conciseness and fixed some typos in apt.html.md ... As discussed with Laura, submitting this PR.	5 years ago
Neeraj Kumar	2b3d6f9929	Minor typo in apt.html.md ... As part of this PR, just wanted to have this typo fixed to have a better sense of the sentence. `apt-add-repository` usually automatically runs `apt update` as part of its work in order to fetch the new package indices, but if it does not, then you will need to do so manually before the packages will be available. Also, I wanted to rephrase the sentence as below(less wording and more clarity- let me know if this is okay and I can raise a new pull request): `apt-add-repository` usually automatically runs `apt update` as part of its work to fetch the new package indices, but if it does not, you will need to manually do so before the packages will be available.	5 years ago
James Bardin	15f99bc445	Merge pull request #29081 from amccaskill/patch-1 ... error_count	5 years ago
Kristin Laemmert	563f1436eb	various docs updates (#29018) ... * website/docs: add sensitivity warning to output documentation fixes #28005 * website/docs: add note about ** to fileset documentation closes #24220 * website/docs: add note that `dynamic` expressions aren't included in json config output closes #28346 * website: the provider installer isn't necessarily concurrency safe closes #28367	5 years ago
Russell Rollins	3174dfd63f	Adds anchor for TF_CLI_ARGS.	5 years ago
Nick Fagerlund	0e004f2377	website: remove legacy provider docs index (#29134) ... * website: Update or remove references to legacy provider docs We've finally evicted the last of the legacy provider docs from terraform.io! Let's celebrate by purging all memory of them. The 0.11 docs are now so thoroughly legacy that I don't believe they need a new destination for their provider links, so I just removed those. * website: remove old provider docs index This will require a redirect in the terraform-website repo. * Apply suggestions from code review Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>	5 years ago
ritsok	595646916f	Link refresh tutorial from plan and refresh docs pages	5 years ago
Adrian	54a09b059f	error_count ... # shouldn't it be true if the error count is zero error_count (number): A zero or positive whole number giving the count of errors Terraform detected. If valid is 'true' then error_count will always be zero, because it is the presence of errors that indicates that a configuration is invalid.	5 years ago
Laura Pacilio	a7e24c384b	Merge pull request #28842 from iaoiui/patch-1 ... remove extra "be"	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
Radek Simko	bb868606ea	docs: Document naming conventions for templates & backend configs (#28924) ... * docs: Document naming conventions for templates & backend configs * Update website/docs/cli/config/config-file.html.md Co-authored-by: Alisdair McDiarmid <alisdair@users.noreply.github.com> * Update website/docs/language/functions/templatefile.html.md Co-authored-by: Alisdair McDiarmid <alisdair@users.noreply.github.com> Co-authored-by: Alisdair McDiarmid <alisdair@users.noreply.github.com>	5 years ago
Kristin Laemmert	583859e510	commands: `terraform add` (#28874) ... * command: new command, terraform add, generates resource templates terraform add ADDRESS generates a resource configuration template with all required (and optionally optional) attributes set to null. This can optionally also pre-populate nonsesitive attributes with values from an existing resource of the same type in state (sensitive vals will be populated with null and a comment indicating sensitivity) * website: terraform add documentation	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
iaoiui	176cfad1dd	remove extra "be"	5 years ago
Martin Atkins	abf7f3416b	website: "taint" command is deprecated from v0.15.2, not from v1.0.0 ... We got the replacement for this in earlier than anticipated, so these docs were originally more pessimistic about when the alternative would be available.	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
Matthew Sanabria	1c3f4fe80f	Add examples to `terraform console` command (#28773) ... These examples showcase come use cases for `terraform console`.	5 years ago
Matthew Sanabria	a63ac81d0c	Example plugin location using XDG Base Directory (#28711) ... The current documention was unclear about the full path of local mirrors when using the XDG Base Directory Specification. Also removed the trailing slashes for the other paths in this section.	5 years ago
Karol Szczepański	f684f91f3f	website/docs(plan): fix minor typos (#28713)	5 years ago
James Bardin	1b48636b42	update init docs for -migrate-state	5 years ago
Nick Fagerlund	65f3ddec52	website: Make apply's usage of plan options harder to miss ... - I'm using distinct subheaders and smaller paragraphs to try and make the info about apply's two modes more skimmable. - I'm also adding a separate "Plan Options" subheader (and keeping the section tiny so it stays snugged up right next to the "Apply Options" one) to make it extra-clear that Hey, There's More Options, They're Over There.	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	ed121321c6	website: Revamp the "terraform state mv" page ... My original motivation here was to add the previously-missing -dry-run option to the list of options However, while in the area I noticed that this command hasn't had a documentation refresh for a while and so I took the opportunity to update it to match with our current writing style and terminology used in other parts of the documentation, and so I've rewritten prose elsewhere on the page to hopefully give the same information in a way that fits in better with concepts discussed elsewhere in the documentation, and also to try to add some additional context to connect this information with what we've described in other places. This rewrite also drops the example of moving from one "state file" to another, because that's a legacy usage pattern that isn't supported when using remote backends, and we recommend most folks to use remote backends so it's strange to show an example that therefore won't work for most people. Rather than adding additional qualifiers to that example I chose to just remove it altogether, because we've generally been working to de-emphasize these legacy local backend command line options elsewhere in the documentation.	5 years ago
Martin Atkins	ea089d06f1	website: Revamp the "terraform state rm" page ... My original motivation here was to add the previously-missing -dry-run option to the list of options However, while in the area I noticed that this command hasn't had a documentation refresh for a while and so I took the opportunity to update it to match with our current writing style and terminology used in other parts of the documentation, and so I've rewritten prose elsewhere on the page to hopefully give the same information in a way that fits in better with concepts discussed elsewhere in the documentation, and also to try to add some additional context to connect this information with what we've described in other places.	5 years ago
Martin Atkins	874f1abb2b	cli+website: -ignore-remote-version docs and other cleanup ... We previously had only very short descriptions of what -ignore-remote-version does due to having the documentation for it inline on many different command pages and -help output. Instead, we'll now centralize the documentation about this argument on the remote backend page, and link to it or refer to it from all other locations. This then allows us to spend more words on discussing what Terraform normally does _without_ this option and warning about the consequences of using it. This continues earlier precedent for some local-backend-specific options which we also don't recommend for typical use. While this does make these options a little more "buried" than before, that feels justified given that they are all "exceptional use only" sort of options where users ought to learn about various caveats before using them. While there I also took this opportunity to fix some earlier omissions with the local-backend-specific options and a few other minor consistency tweaks.	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
Kristin Laemmert	85adad0ec7	docs: small update for provider binary locations (#28413) ... * docs: add note that provider binaries need to be placed in appropriate subdirectories under the default locations	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
Judith Malnick	75fbbe8065	clarify version that pull upgrades local state to (#28204)	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
Alisdair McDiarmid	b6ca782993	documentation: Clarify JSON diagnostic traversal ... The traversal value is normally a valid HCL string, but can be simplified if a traversal step has a complex index value (e.g. an object). This means it is not always parseable HCL, so this commit updates the documentation to clarify this and explicitly record that we do not guarantee its contents are stable. The purpose of these values is purely for building human-readable UI.	5 years ago
Alisdair McDiarmid	46a29b13ed	cli: Add format version to validate -json output ... In line with the other complex JSON output formats for plan and provider schema, here we add an explicit `format_version` field to the JSON output of terraform validate.	5 years ago
Alisdair McDiarmid	2a85f0483f	website: Update validate -json diags documentation ... Updated to include details about the new "snippet" object in JSON diagnostics.	5 years ago
Martin Atkins	dc7f2b7314	website: docs for the terraform validate JSON output	5 years ago
Masayuki Morita	31a5aa1878	command/init: Add a new flag `-lockfile=readonly` (#27630) ... Fixes #27506 Add a new flag `-lockfile=readonly` to `terraform init`. It would be useful to allow us to suppress dependency lockfile changes explicitly. The type of the `-lockfile` flag is string rather than bool, leaving room for future extensions to other behavior variants. The readonly mode suppresses lockfile changes, but should verify checksums against the information already recorded. It should conflict with the `-upgrade` flag. Note: In the original use-case described in #27506, I would like to suppress adding zh hashes, but a test code here suppresses adding h1 hashes because it's easy for testing. Co-authored-by: Alisdair McDiarmid <alisdair@users.noreply.github.com>	5 years ago
Rachel Sharp	3cb4918739	Merge pull request #27862 from hashicorp/add-state-learn-tutorial ... Add State Learn tutorial to State docs	5 years ago
James Bardin	c103242bef	Merge pull request #27885 from hashicorp/jbardin/show-json ... jsonstate: indicate schema version mismatch during encoding	5 years ago
James Bardin	c7995b7d4b	update show -json docs	5 years ago
Martin Atkins	8d37a70987	website: Initial docs for the module integration testing experiment ... Since this is still at an early phase and likely to change significantly in future iterations, rather than attempting to guess on a suitable final location for documenting the testing feature I've instead taken the unusual approach of adding a new page that is explicitly about the experiment. My expectation is that once we conclude the experiment we'll replace this new page with a stub that just explains that there was once an experiment and then links to whatever final feature unfolded from the research. The URL for this page is hard-coded into the warning message in the "terraform test" command, so as we continue to evolve this feature in future releases we'll need to update the callout note on the page about which Terraform CLI version it's currently talking about, so users of older versions can clearly see when they'd need to upgrade in order to participate in a later incarnation of the experiment.	5 years ago
Rachel Sharp	2f287b41de	Add State Learn tutorial to State docs	5 years ago
Alisdair McDiarmid	888f36aebb	cli: Remove positional plan argument from graph ... To make the command arguments easier to understand and extend, we are moving away from positional arguments. This commit changes the graph command to take a `-plan` flag instead of an optional trailing path.	5 years ago
Pam Selle	6da55c0521	Update grammar for flags	5 years ago