Commit Graph

1667 Commits

Author SHA1 Message Date
Axel Neergaard 7756023564
Docs: Change misspelling of variable in documentation
The variable example for `.tfvars` include a spelling error making the `terraform` and `hcl` examples mismatch.
2021-12-03 18:02:31 +01:00
Laura Pacilio 01dbfd2d30
Merge pull request #30028 from multani/patch-1
Improve `.terraformignore` doc formatting
2021-12-03 11:06:32 -05:00
Ted Behling 6a454f11a7 Add newer Debian & Ubuntu versions to repo list
The HashiCorp APT server supports several distro releases that were not in this list,
leading to a false impression that they aren't supported.

Note, Ubuntu has a new release twice a year, so periodic maintenance
is needed here.
2021-11-29 17:03:58 -05:00
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.
2021-11-26 16:57:48 +00:00
Jonathan Ballet ecc8bcfe5b
Improve `.terraformignore` doc formatting
This helps to distinguish what is a `/` (as a directory separator)
from a "/" (as in "his/her").
2021-11-25 16:35:03 +01:00
Dylan Staley 0e48f58688 Revert "migrate docs to mdx"
This reverts commit 3cb12b5a52.
2021-11-22 15:57:25 -08:00
Dylan Staley 3cb12b5a52 migrate docs to mdx 2021-11-22 15:47:36 -08:00
Tom Harvey 890cabe442
Update website/docs/language/settings/backends/azurerm.html.md
Co-authored-by: Tom Bamford <tbamford@hashicorp.com>
2021-11-17 20:27:39 +01:00
Tom Harvey b3645068ef
Update website/docs/language/settings/backends/azurerm.html.md
Co-authored-by: Tom Bamford <tbamford@hashicorp.com>
2021-11-17 20:27:35 +01:00
Tom Harvey d81e93cc7d
Update website/docs/language/settings/backends/azurerm.html.md
Co-authored-by: Tom Bamford <tbamford@hashicorp.com>
2021-11-17 20:27:05 +01:00
Tom Harvey d5404b6f33
Update website/docs/language/settings/backends/azurerm.html.md
Co-authored-by: Tom Bamford <tbamford@hashicorp.com>
2021-11-17 20:26:58 +01:00
tombuildsstuff 1d9f7f19fc website: updating the docs for the Azure backend to highlight the `use_microsoft_graph` field 2021-11-17 18:54:02 +01:00
Laura Pacilio 7e41803418
Merge pull request #29891 from hashicorp/update-for-each-example
Add cidr block output example to setproduct function page
2021-11-15 11:17:27 -05:00
Laura Pacilio bd64d07e6b Apply suggestions from code review 2021-11-15 10:49:37 -05:00
Krista LaFentres a62cff939e Update documentation for state mv command to clarify use of backup and backup-out options 2021-11-09 13:09:36 -06:00
Laura Pacilio b838a93023 Add cidr block output example to setproduct function page 2021-11-05 10:51:59 -04:00
xiaozhu36 e0a2716601 backend/oss: Removes the ConflictWith tag which on the attributes assume_role* to fix the incompatible error 2021-11-03 11:17:35 +08:00
James Bardin 834f61cd54
Merge pull request #29841 from xiaozhu36/xiaozhu
backend/oss: Supports the new attribute sts_endpoint
2021-11-01 15:31:51 -04:00
James Bardin 8b53637230
Update website/docs/language/values/variables.html.md
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-11-01 15:17:51 -04:00
James Bardin 4f88445d05
Update website/docs/language/values/variables.html.md
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-11-01 15:17:43 -04:00
James Bardin 2195d7a45f
Update website/docs/language/values/variables.html.md
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-11-01 15:17:32 -04:00
James Bardin 46bbe66cd0
Update website/docs/language/values/variables.html.md
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-11-01 15:17:21 -04:00
James Bardin 03ed766454 nullable doc update 2021-11-01 14:30:25 -04:00
James Bardin 6a1afd2dc3 nullable variable docs
Add `nullable` to the variable documentation.
Remove "module" from the "null means omission" part of the null type
documentation.
2021-11-01 13:25:25 -04:00
Martin Atkins 14a8668486 website: "Refactoring" documentation firmer advice about removing moved blocks
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-11-01 08:47:17 -07:00
Martin Atkins 86e5aacacd website: Documentation about "moved" blocks
This is documentation for the first set of refactoring-related features,
all based on the new "moved" blocks in the Terraform language.

I've named the documentation section "refactoring" because in previous
discussions with users that seems to be the term they use to describe the
underlying need.

"moved" blocks are our first language feature intended to meet that need,
although it probably won't be the last as we consider other requirements
in later releases. My intent here is that once we've published this it
should eventually end up being the first result for a web search for the
topic of Terraform refactoring.
2021-11-01 08:47:17 -07:00
xiaozhu36 5d19a34f88 backend/oss: Supports the new attribute sts_endpoint 2021-11-01 22:52:45 +08:00
James Bardin 2ebdc099ac
Merge pull request #29307 from hayorov/main
Flatten `assume_role` block for OSS backend
2021-11-01 09:18:25 -04:00
Laura Pacilio 0ef4fe0aab
Merge pull request #29691 from ramj9/patch-1
replace an with a
2021-10-26 09:49:46 -04:00
Krista LaFentres 1f08f7dba8 Clarify the way the trim() function works and add some more examples 2021-10-25 14:13:15 -05:00
Martin Atkins 5b266dd5ca command: Remove the experimental "terraform add" command
We introduced this experiment to gather feedback, and the feedback we saw
led to us deciding to do another round of design work before we move
forward with something to meet this use-case.

In addition to being experimental, this has only been included in alpha
releases so far, and so on both counts it is not protected by the
Terraform v1.0 Compatibility Promises.
2021-10-20 06:42:47 -07:00
Alex Khaerov 14f366dbf4
Update documentation 2021-10-18 12:54:40 +08:00
Alex Khaerov de8810cdd9
Merge branch 'hashicorp:main' into main 2021-10-18 11:42:37 +08:00
Alisdair McDiarmid b9f3dab035 json-output: Release format version 1.0 2021-10-06 11:13:06 -04:00
Ram 45dab1b956
replace an with a 2021-10-02 17:15:51 +08:00
Melissa Gurney Greene 0062e7112a
Update publish.html.md (#29671)
Updated language around contributing modules with overlapping features in the Publishing Modules section: "We welcome..." (all contributions)
2021-09-29 13:42:54 -07:00
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.
2021-09-24 13:17:49 -04:00
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.
2021-09-23 14:37:08 -07:00
Paddy 4fe75bead3
Remove panic debugging information (#29512)
It was out of date.

Fixes #1113.
2021-09-21 05:45:04 -07:00
Laura Pacilio 8f09e27597
Merge pull request #29567 from drasko95/patch-1
Fix a documentation typo
2021-09-20 17:24:31 -04:00
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.
2021-09-20 15:25:23 -04:00
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.
2021-09-20 15:25:23 -04:00
Laura Pacilio 4d1baaceab Add Machine-Readable UI to sidebar and add hyphen :-) 2021-09-16 17:06:52 -04:00
Laura Pacilio dcf2d3c1ef
Merge pull request #29494 from magnetikonline/docs-s3-backend-dynamodb-partition-key
S3 backend documentation update - DynamoDB uses Partition keys, not primary keys - redux
2021-09-13 10:39:02 -04:00
Draško Radovanović c8e2be76d2
Fix a documentation typo 2021-09-11 15:33:14 +02:00
Laura Pacilio 43f960b197
Merge pull request #28579 from ChadBailey/patch-2
Added clarity: remote-exec connection requirement
2021-09-09 15:09:31 -04:00
Laura Pacilio 48768a0037
Merge pull request #29451 from kmadof/patch-1
Added required paramter `resource_group_name` for MSI
2021-09-09 14:54:17 -04:00
Alisdair McDiarmid cd29c3e5fd
Revert "json-output: Release format version 1.0" 2021-09-09 11:25:35 -04:00
Laura Pacilio a819d7db3a
Merge pull request #29502 from hashicorp/alisdair/json-format-version
json-output: Release format version 1.0
2021-09-09 11:06:58 -04:00
Omar Ismail cb5b159228
Update terraform_remote_state data source docs: (#29534)
* Add docs for tfe_outputs data source
* Add docs for Terraform Cloud usage
2021-09-08 10:44:46 -04:00
Laura Pacilio 3c518880d3
Merge pull request #29509 from drewmullen/d-module-source-revision-option
documentation: commit sha can be passed to ref
2021-09-03 12:11:34 -04:00
drewmullen e3b6c6403c include sha example and git docs 2021-09-03 10:32:10 -04:00
Laura Pacilio 1e1d47d16d
Merge pull request #28345 from yvespp/destroy_provisioners_doc
document that destroy provisioners don't run with create_before_destroy
2021-09-03 10:19:30 -04:00
Yves Peter fa4c590f51
Apply suggestions from code review
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-09-03 08:23:17 +02:00
Laura Pacilio 73a3bb2702
Merge pull request #28334 from paultyng/patch-1
Add null to type conversion docs
2021-09-02 14:47:38 -04:00
Alisdair McDiarmid b60f201eed json-output: Release format version 1.0 2021-09-01 15:15:18 -04:00
Peter Mescalchin f238e9395a Quality of life: updated all AWS document links to https:// 2021-09-01 14:02:28 +10:00
Peter Mescalchin 110d482033 Update S3 backend documentation - DynamoDB uses Partition keys, not primary keys 2021-09-01 13:59:08 +10:00
Topher Ayrhart b1d56076a4
generated -> generate
In the last paragraph, the word "generated" is in the wrong tense for the sentence. The correct word is "generate" (unless I misunderstand the sentence 🙂).
2021-08-30 08:59:50 -05:00
Laura Pacilio daad109067
Merge pull request #29063 from moskyb/s3-backend-kms-permissioning-note
Add a note to the docs on the S3 backend around permissions needed for encrypted state storage
2021-08-25 10:14:12 -04:00
Krzysztof Madej 49b31d005a
Added required paramter `resource_group_name` for MSI
Without `resource_group_name` I had

> │ Error: Either an Access Key / SAS Token or the Resource Group for the Storage Account must be specified - or Azure AD Authentication must be enabled
2021-08-24 02:05:43 +02:00
Laura Pacilio 0a78072a2b
Merge pull request #28089 from jnerin/patch-1
Update expressions.html link to operators.html
2021-08-23 18:00:42 -04:00
Laura Pacilio 03849d850a
Merge pull request #28486 from joshschmitter/patch-1
setsubtract doc: use "Relative Complement" correctly
2021-08-23 15:49:51 -04:00
joshschmitter cb41b158f1
concise use of "relative complement"
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-08-23 14:40:35 -05:00
Laura Pacilio d427c81a89 Update jsonencode minified note 2021-08-23 15:01:38 -04:00
Laura Pacilio dffb8b4a16
Merge pull request #29088 from brenthc/minify_jsonencode
note that output of jsonencode is minified
2021-08-23 14:24:37 -04:00
Brent Woodruff ed84cb886e
Apply suggested wording update. 2021-08-23 14:10:50 -04:00
Laura Pacilio 5863af448f
Merge pull request #28784 from TAYTS/patch-2
Update range.html.md
2021-08-23 14:07:15 -04:00
Laura Pacilio c1d16c7421
Merge pull request #29311 from NargiT/patch-1
fix syntax
2021-08-23 14:00:43 -04:00
Laura Pacilio 6235453d21
Merge pull request #29358 from moajo/add-s3-delete-object-to-document
Update website/docs/language/settings/backends/s3.html.md
2021-08-23 13:59:48 -04:00
Laura Pacilio d0bc382797
Merge pull request #29359 from 45deg/45deg-patch-1
Fix a result in examples for urlencode.html.md
2021-08-23 13:57:27 -04:00
Laura Pacilio c8dfaa12cc
Merge pull request #29433 from fedorg/patch-1
remove large sections of empty space
2021-08-23 13:35:31 -04:00
Laura Pacilio d2f80f35b1
Merge pull request #29316 from alkis-hexa/patch-1
Update for.html.md
2021-08-23 12:31:43 -04:00
Fedor Golishevskiy 4fd3bd4911
remove large sections of empty space 2021-08-20 17:31:26 +03:00
Martin Atkins 43d753e727 command: "terraform add" is experimental
We're aware of several quirks of this command's current design, which
result from some existing architectural limitations that we can't address
immediately.

However, we do still want to make this command available in its current
capacity as an incremental improvement, so as a compromise we'll document
it as experimental. Our intent here is to exclude it from the
Terraform 1.0 Compatibility Promises so that we can have the space to
continue to improve the design as other parts of the overall Terraform
system gain new capabilities.

We don't currently have any concrete plan for this command to be
stabilized and subject to compatibility promises. That decision will
follow from ongoing discussions with other teams whose systems may need to
change in order to support the final design of "terraform add".
2021-08-19 09:27:30 -07:00
Laura Pacilio e1b702b8d0
Merge pull request #29417 from jonesetc/patch-1
Fix link to index function
2021-08-18 18:24:54 -04:00
Laura Pacilio b574c03dd1
Merge pull request #29271 from kebroad/patch-1
Fixed cidrhost() example 1 and 2 with correct function parameter
2021-08-18 18:22:06 -04:00
Laura Pacilio 9dde62ef5d
Merge pull request #29257 from robe007/patch-1
Remove repeated word 'the' in some lines.
2021-08-18 18:15:09 -04:00
Kyle Jones e4e5f5a1a4
Fix link to index function
The element function page previously linked to the index page for all functions where it meant to link to the index function page.
2021-08-18 15:08:19 -07:00
Martin Atkins c23a7fce4e lang/funcs: Preserve IP address leading zero behavior from Go 1.16
Go 1.17 includes a breaking change to both net.ParseIP and net.ParseCIDR
functions to reject IPv4 address octets written with leading zeros.

Our use of these functions as part of the various CIDR functions in the
Terraform language doesn't have the same security concerns that the Go
team had in evaluating this change to the standard library, and so we
can't justify an exception to our v1.0 compatibility promises on the same
sort of security grounds that the Go team used to justify their
compatibility exception.

For that reason, we'll now use our own fork of the Go library functions
which has the new check disabled in order to preserve the prior behavior.
We're taking this path, rather than pre-normalizing the IP address before
calling into the standard library, because an additional normalization
layer would be entirely new code and additional complexity, whereas this
fork is relatively minor in terms of code size and avoids any significant
changes to our own calls to these functions.

Thanks to the Kubernetes team for their prior work on carving out a subset
of the "net" package for their similar backward-compatibility concern.
Our "ipaddr" package here is a lightly-modified fork of their fork, with
only the comments changed to talk about Terraform instead of Kubernetes.

This fork is not intended for use in any other future feature
implementations, because they wouldn't be subject to the same
compatibility constraints as our existing functions. We will use these
forked implementations for new callers only if consistency with the
behavior of the existing functions is a key requirement.
2021-08-17 15:20:05 -07:00
moajo b3e1a40499 Update website/docs/language/settings/backends/s3.html.md 2021-08-12 15:17:04 +09:00
45deg 494043ed24
Fix a result in examples for urlencode.html.md 2021-08-12 13:47:27 +09:00
Radek Simko 7a95bbf019
docs: Add note about multiple variable validation blocks (#29299) 2021-08-10 15:20:02 +01:00
Top 963771d398
Merge pull request #29304 from hashicorp/tf-swift-backend-swauth
Update swift.html.md
2021-08-10 08:16:26 +10:00
Laura Pacilio 3376752b08
Merge pull request #29273 from mellab/patch-1
Fixed typo on type-constraints.html.md
2021-08-09 11:44:33 -04:00
Alkis Tsitsigkos 1f5069d9dc
Update for.html.md
Boolean doesn't exist as an accepted type of variable
2021-08-06 12:54:26 +03:00
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`.
2021-08-05 15:32:26 -04:00
Tigran Tch 0103f58297
fix syntax 2021-08-05 17:04:40 +02:00
Top 21a5103551
Update swift.html.md
Add note for Swauth v1.0 support
2021-08-05 08:32:40 +10:00
Alex Khaerov 9d5f1752c8
oss backend: flattern assume_role block 2021-08-03 14:26:15 +08:00
Laura Pacilio 5b07bb7040
Merge pull request #29216 from hashicorp/laura-description-metadata-cli
Laura description metadata cli
2021-07-30 14:49:36 -04:00
Laura Pacilio 31af9adc00 Make all sentences start with caps + additional tweak wording edits 2021-07-30 14:44:17 -04:00
Laura Pacilio 845470617d Address PR comments for manipulating state index 2021-07-30 14:25:01 -04:00
Laura Pacilio 2034c17948 Address PR comments on inspect index page 2021-07-30 14:22:16 -04:00
Laura Pacilio 0abd79c9b4 Address PR comments on workspace command index page 2021-07-30 14:19:14 -04:00
Laura Pacilio 18a3143495 Address PR comments for init page 2021-07-30 14:15:46 -04:00
Laura Pacilio e94bf7bc16 Address PR comments for cli index page 2021-07-30 14:13:04 -04:00
Laura Pacilio 342335003d
Update website/docs/cli/commands/import.html.md
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-07-30 14:10:32 -04:00
Laura Pacilio d59777c12f
Update website/docs/language/modules/sources.html.md
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-07-30 14:07:45 -04:00
Laura Pacilio 6874aad76d
Update website/docs/language/meta-arguments/resource-provider.html.md
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-07-30 14:07:19 -04:00