67 Commits (6dcf00aefc56b48bae54822a6e62eacffd2bc3ea)

Author	SHA1	Message	Date
Dylan Staley	21cbb5b392	migrate docs to mdx	4 years ago
Daniel Murphy	fba26b10ee	Fix example for values-representation in docs for JSON Format internals ... The `root_module.resources[].sensitive_values` key in the example output was incorrectly named and clashed with the regular `root_module.resources[].values` key.	4 years ago
Dylan Staley	0e48f58688	Revert "migrate docs to mdx" ... This reverts commit 3cb12b5a52.	4 years ago
Dylan Staley	3cb12b5a52	migrate docs to mdx	4 years ago
Alisdair McDiarmid	b9f3dab035	json-output: Release format version 1.0	5 years ago
Alisdair McDiarmid	b699391d04	json-output: Add change reasons to explain deletes ... The extra feedback information for why resource instance deletion is planned is now included in the streaming JSON UI output. We also add an explicit case for no-op actions to switch statements in this package to ensure exhaustiveness, for future linting.	5 years ago
Martin Atkins	a1a713cf28	core: Report ActionReasons when we plan to delete "orphans" ... There are a few different reasons why a resource instance tracked in the prior state might be considered an "orphan", but previously we reported them all identically in the planned changes. In order to help users understand the reason for a surprising planned delete, we'll now try to specify an additional reason for the planned deletion, covering all of the main reasons why that could happen. This commit only introduces the new detail to the plans.Changes result, though it also incidentally exposes it as part of the JSON plan result in order to keep that working without returning errors in these new cases. We'll expose this information in the human-oriented UI output in a subsequent commit.	5 years ago
Paddy	4fe75bead3	Remove panic debugging information (#29512) ... It was out of date. Fixes #1113.	5 years ago
Alisdair McDiarmid	b59b057591	json-output: Config-driven move support in JSON UI ... Add previous address information to the `planned_change` and `resource_drift` messages for the streaming JSON UI output of plan and apply operations. Here we also add a "move" action value to the `change` object of these messages, to represent a move-only operation. As part of this work we also simplify this code to use the plan's DriftedResources values instead of recomputing the drift from state.	5 years ago
Alisdair McDiarmid	78c4a8c461	json-output: Previous address for resource changes ... Configuration-driven moves are represented in the plan file by setting the resource's `PrevRunAddr` to a different value than its `Addr`. For JSON plan output, we here add a new field to resource changes, `previous_address`, which is present and non-empty only if the resource is planned to be moved. Like the CLI UI, refresh-only plans will include move-only changes in the resource drift JSON output. In normal plan mode, these are elided to avoid redundancy with planned changes.	5 years ago
Laura Pacilio	4d1baaceab	Add Machine-Readable UI to sidebar and add hyphen :-)	5 years ago
Alisdair McDiarmid	cd29c3e5fd	Revert "json-output: Release format version 1.0"	5 years ago
Alisdair McDiarmid	b60f201eed	json-output: Release format version 1.0	5 years ago
Alisdair McDiarmid	3b33dc1105	json-output: Add output changes to plan logs ... Extend the outputs JSON log message to support an `action` field (and make the `type` and `value` fields optional). This allows us to emit a useful output change summary as part of the plan, bringing the JSON log output into parity with the text output. While we do have access to the before/after values in the output changes, attempting to wedge those into a structured log message is not appropriate. That level of detail can be extracted from the JSON plan output from `terraform show -json`.	5 years ago
Laura Pacilio	4a7221d574	Update metadata description on internals overview page	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
Alisdair McDiarmid	32210db0ab	documentation: Add drift to machine readable UI	5 years ago
Laura Pacilio	4f12b8d917	Merge pull request #28863 from stensonb/patch-1 ... typo	5 years ago
Kristin Laemmert	ac03d35997	jsonplan and jsonstate: include sensitive_values in state representations (#28889) ... * jsonplan and jsonstate: include sensitive_values in state representations A sensitive_values field has been added to the resource in state and planned values which is a map of all sensitive attributes with the values set to true. It wasn't entirely clear to me if the values in state would suffice, or if we also need to consult the schema - I believe that this is sufficient for state files written since v0.15, and if that's incorrect or insufficient, I'll add in the provider schema check as well. I also updated the documentation, and, since we've considered this before, bumped the FormatVersions for both jsonstate and jsonplan.	5 years ago
Bryan Stenson	b487b9f8fb	typo	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
Alisdair McDiarmid	a5b7394f9a	command/jsonplan: Add replace_paths ... The set of paths which caused a resource update to require replacement has been stored in the plan since 0.15.0 (#28201). This commit adds a simple JSON representation of these paths, allowing consumers of this format to determine exactly which paths caused the resource to be replaced. This representation is intentionally more loosely encoded than the JSON state serialization of paths used for sensitive attributes. Instead of a path step being represented by an object with type and value, we use a more-JavaScripty heterogenous array of numbers and strings. Any practical consumer of this format will likely traverse an object tree using the index operator, which should work more easily with this format. It also allows easy prefix comparison for consumers which are tracking paths. While updating the documentation to include this new field, I noticed that some others were missing, so added them too.	5 years ago
Martin Atkins	b802237e03	plans: Track an optional extra "reason" for some planned actions ... Previously we were repeating some logic in the UI layer in order to recover relevant additional context about a change to report to a user. In order to help keep things consistent, and to have a clearer path for adding more such things in the future, here we capture this user-facing idea of an "action reason" within the plan model, and then use that directly in order to decide how to describe the change to the user. For the moment the "tainted" situation is the only one that gets a special message, matching what we had before, but we can expand on this in future in order to give better feedback about the other replace situations too. This also preemptively includes the "replacing by request" reason, which is currently not reachable but will be used in the near future as part of implementing the -replace=... plan command line option to allow forcing a particular object to be replaced. So far we don't have any special reasons for anything other than replacing, which makes sense because replacing is the only one that is in a sense a special case of another action (Update), but this could expand to other kinds of reasons in the future, such as explaining which of the few different reasons a data source read might be deferred until the apply step.	5 years ago
Rachel Sharp	56483d10d2	Update debugging.html.md	5 years ago
Paddy	0b5c4a6a2c	Accept TF_LOG=json to enable TRACE logs in JSON format ... This is not currently a supported interface, but we plan to release tool(s) that consume parts of it that are more dependable later, separately from Terraform CLI itself.	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
Nick Fagerlund	7a8dd326c6	website: Language: Update links to moved pages	5 years ago
Nick Fagerlund	85d477aee9	website: Fix numerous links with redirects or broken anchors ... These links largely still go somewhere useful, but they have some kind of issue revealed by our new link checker: - Some of them point to a stale URL that redirects, and can be updated to the new destination. - Some of them point to anchors that don't exist (anymore?) in the destination. - Some of them end up redirecting unnecessarily due to how the server handles directory URLs without trailing slashes. Sorry, I know that's pointless, just, humor me for the time being so we can get our CI green. 😭 In a couple cases, I've added invisible anchors to destination pages, either to preserve an old habit or because the current anchors kind of suck due to being particularly long or meandering.	5 years ago
Martin Atkins	7ccaee1018	website: Fix inconsistencies in the registry protocol page ... Some hasty, incorrect merge conflict fixing caused this page to have a strange mix of terminology between "system" and "provider". Along with that, there were also several editorial errors caused by text on this page having originally been derived from the provider registry documentation. This documentation will now consistently talk about being a module registry protocol rather than a provider registry protocol, and it will consistently use the term "system" as a generic term for the final part of the module source address, aside from noting that there is an optional convention to name it after the "type" part of an official provider when possible.	5 years ago
Andrew Fitzgerald	8c82b3f6a0	Remove 'system' references from module registry protocol docs.	5 years ago
alevinetx	66393bb62e	website: Update module-registry-protocol.html.md (#26639) ... * Update module-registry-protocol.html.md 1: There is a mismatch in the segment labels for the version query URL (system vs provider) 2: There is a discrepancy between the documentation and the actual generated request for retrieving module source code (URL segments 4 vs 3) - There is no segment for "provider" * Update module-registry-protocol.html.md Changed ```:system``` to ```:provider``` for versions and source API URLs	5 years ago
Martin Atkins	ddf9635af6	website: Don't claim that things are "very easy" ... We typically try to avoid making subjective, boasty claims in our documentation in recent times, but there remained both some older documentation that we've not recently revised and also some newer examples that are, in retrospect, also perhaps more "boasty" than they need to be. We prefer not to use this sort of boasty language because not everyone using Terraform has the same background and experience, and so what is "easy" or "intuitive" to one person may not be so to another person, and that should not suggest that the second person is in any way wrong or inadequate. In reviewing some of our use of the word "easy" here I tried as much as possible to surgically revise the existing content without getting drawn into a big rewrite, but in some cases the content was either pretty unsalvageable (due to talking about obsolete features that were removed long ago) or required some broader changes to make the result hopefully still get the same facts across. In those cases I've both removed some content entirely or adjusted larger paragraphs. This was not an exhaustive review and so I'm sure there's still plenty of room for similar improvements elsewhere. I also resisted the urge to update some pages that contain outdated information about currently-active features.	5 years ago
James Bardin	eb2d4434c8	logging env variable docs	5 years ago
Alisdair McDiarmid	aa8c73cd18	website: Credentials helper response for no creds ... For a credentials helper plugin to be useful with Terraform 0.13+, we need to cope with the case of having no credentials for a host without this being an error. This is to allow the public Terraform Registry to be accessed without supplying a token. The way to implement this is to respond to queries for credentials for a host which has no credentials stored with an empty object and a success exit code. This contradicts the previous documentation, which calls for an error response in this case.	6 years ago
Martin Atkins	2bd2a9a923	internal/getproviders: HTTPMirrorSource implementation ... We previously had this just stubbed out because it was a stretch goal for the v0.13.0 release and it ultimately didn't make it in. Here we fill out the existing stub -- with a minor change to its interface so it can access credentials -- with a client implementation that is compatible with the directory structure produced by the "terraform providers mirror" subcommand, were the result to be published on a static file server.	6 years ago
Nick Fagerlund	2ffb71bcee	website: Fix several broken links (#25808)	6 years ago
Nick Fagerlund	0e5651560b	Website: 0.13 docs edits, mostly around provider requirements (#25686) ... * Make sidebar nav in language docs more intuitive * Minor display fixes for registry docs * Explain providers in the registry in the providers index * Revise a bunch of language docs around provider reqs This is mostly an effort to smooth out some of the explanations, make sure things are presented in a helpful order, make sure terminology lines up, draw connections between related concepts, make default behavior more apparent, and the like. It shouldn't include very much new information, but there might be one or two things that came out of a conversation somewhere. Co-authored-by: Judith Malnick <judith@hashicorp.com>	6 years ago
Pam Selle	9cf5a18532	Merge pull request #25238 from HadrienPatte/fix-json-output-format-docs ... Fix JSON output format documentation	6 years ago
Nick Fagerlund	b1eb9dcfcf	website: Configuration Language navigation refactoring ... The "Configuration Language" section was becoming rather unweildy, both by having a lot of pages and by some of the pages being quite large in themselves. This is a first step towards breaking things up a little more, starting with two changes: - The "Configuration Language" navigation is now split into two sub-headings "Configuration Blocks" and "Syntax". - Some of the information about sub-blocks of the "terraform" block are now given their own pages, because their content is quite complex in itself. - "Version Constraints" is now a page in its own right, rather than this content being duplicated in slightly different forms across multiple contexts that make use of user-specified version constraints.	6 years ago
Hadrien Patte	4dea1bb5a0	Fix JSON output format documentation	6 years ago
Martin Atkins	80a4bfbf27	website: New navigation items for the module and provider registry specs	6 years ago
Martin Atkins	63639defe9	website: Separate docs for the module registry protocol ... We previously had the module registry protocol documented only as an undefined subset of the full API of the official registry implementation. However, the vast majority of endpoints documented in the official API docs are not needed for a headless third-party module registry that only intends to make modules available to Terraform CLI. To make this clearer to potential third-party implementors, and also for consistency with how the provider registry protocol is now documented, here we create a new page to describe the subset required for all registries, and then explain in the docs for the offical API that potential third-party implementors should refer to the new page instead. The longer page describing the full API of the official implementations remains for those who wish to write clients for that API, because it is part of the API surface area for Terraform Cloud and Terraform Enterprise. I also took this opportunity to address the fact that module addresses don't really contain "provider names" at all, but rather than the fourth field in the address is _conventionally_ an official provider name but can really be any string that serves to differentiate multiple implementations of the same abstraction. The new docs therefore refer to this field as "system" rather than "provider".	6 years ago
Martin Atkins	deb8257fa5	website: Specification for the provider registry protocol	6 years ago
Pam Selle	146644a848	update addressing section	6 years ago
Pam Selle	65c4ba9c85	First docs for count/for_each on modules	6 years ago
Paddy	e6592dc710	Add support for provider metadata to modules. (#22583) ... Implement a new provider_meta block in the terraform block of modules, allowing provider-keyed metadata to be communicated from HCL to provider binaries. Bundled in this change for minimal protocol version bumping is the addition of markdown support for attribute descriptions and the ability to indicate when an attribute is deprecated, so this information can be shown in the schema dump. Co-authored-by: Paul Tyng <paul@paultyng.net>	6 years ago
Martin Atkins	778f1ab138	website: Documentation for the "terraform login" command (#22727) ... Co-authored-by: Alisdair McDiarmid <alisdair@users.noreply.github.com>	6 years ago
Brian Flad	cea149340c	docs/internal/resource-addressing: Omit for_each full splat example for now	7 years ago
Brian Flad	720b062d55	Apply suggestions from code review ... Co-Authored-By: Nick Fagerlund <nick@hashicorp.com>	7 years ago