Commit Graph

314 Commits

Author SHA1 Message Date
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
Krista LaFentres 1f08f7dba8 Clarify the way the trim() function works and add some more examples 2021-10-25 14:13:15 -05: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
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
Laura Pacilio 8f09e27597
Merge pull request #29567 from drasko95/patch-1
Fix a documentation typo
2021-09-20 17:24:31 -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
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
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 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 d2f80f35b1
Merge pull request #29316 from alkis-hexa/patch-1
Update for.html.md
2021-08-23 12:31:43 -04: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
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
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 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
Laura Pacilio 809f50fbf2
Update website/docs/language/meta-arguments/module-providers.html.md
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-07-30 14:07:03 -04:00
Laura Pacilio 87348f97f8
Update website/docs/language/expressions/dynamic-blocks.html.md
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-07-30 14:06:20 -04:00
Laura Pacilio 3ae552fbc9 Remove back ticks from syntax index page 2021-07-30 10:57:44 -04:00
Laura Pacilio 2970efff00 Remove back ticks from settings index page 2021-07-30 10:56:11 -04:00
Laura Pacilio e6903e860a Remove back ticks from null_resource_page 2021-07-30 10:55:13 -04:00
Laura Pacilio 22588ca105 Remove back ticks from connection block page 2021-07-30 10:54:39 -04:00
Laura Pacilio 058fa43d5d Remove back ticks from resource index page 2021-07-30 10:53:58 -04:00
Laura Pacilio 8a919d98d4 Remove back ticks from resource behavior page 2021-07-30 10:53:17 -04:00
Laura Pacilio 6e0349645e Remove back ticks from configuration page 2021-07-30 10:52:25 -04:00
Laura Pacilio 277fe647b9 Remove back ticks from source module page 2021-07-30 10:51:46 -04:00
Laura Pacilio 2e34e7a727 Remove back ticks from module providers meta argument page 2021-07-30 10:50:39 -04:00
Laura Pacilio 512bb1a3c5 Remove back ticks from provider meta argument page 2021-07-30 10:49:28 -04:00
Laura Pacilio 051ce2ae6c Remove back ticks from lifecycle page 2021-07-30 10:47:31 -04:00
Laura Pacilio a7c1ae72a4 Remove back ticks from for_each page 2021-07-30 10:45:39 -04:00
Laura Pacilio 01f993b6f7 Remove back ticks from depends_on page 2021-07-30 10:45:13 -04:00
Laura Pacilio a448eaa41f Remove back ticks from count page 2021-07-30 10:44:44 -04:00
Laura Pacilio 20bdc25ffd Remove back ticks from for expressions page 2021-07-30 10:43:30 -04:00
Laura Pacilio ad9fb34c0b Remove backticks from dynamic blocks page 2021-07-30 10:42:57 -04:00
Laura Pacilio f75acc7129 Remove backticks from Dependency lock page 2021-07-30 10:42:15 -04:00
mellab c690247837
Update type-constraints.html.md
Fixed one typo found on the type constraints page:

recieving -> receiving
2021-07-30 00:08:42 -05:00
Kevin Broadbridge f5cbe59386 Fixed cidrhost example 1 and 2 with correct function parameter 2021-07-29 16:30:18 -05:00
Laura Pacilio a14272d022 Update extending link to "plugin development" 2021-07-26 14:52:44 -04:00
Daniel Schmidt 59dd7f8f51
terraform-workspace should be terraform.workspace
Closes #28881 by @abidmunirmalik
2021-07-26 09:41:51 +02:00
Laura Pacilio b9c0cbb1fd
Merge pull request #29117 from hashicorp/description-metadata-language-docs
Description metadata -  language docs
2021-07-21 16:30:05 -04:00
Laura Pacilio 06a2fdcf9d Merge branch 'main' into description-metadata-language-docs 2021-07-21 16:24:59 -04:00
James Bardin 570b70b02f
Merge pull request #28078 from jasons42/configure-etcdv3-client-max-request-size
Expose etcd client MaxCallSendMsgSize config
2021-07-20 15:49:14 -04:00
James Bardin 431aa0280e
Merge pull request #29157 from remilapeyre/unique-constraint
Add uniqueness constraint on workspaces name for the pg backend
2021-07-20 15:11:35 -04:00
Jason Smith 5ff9b7626b Fix broken link
Fix website-link-check failing as https://coreos.com/etcd/ 301's to https://etcd.io/. Updated link to https://etcd.io/.
2021-07-20 14:04:49 -05:00
Jason Smith 162f853841 Document max_request_bytes config 2021-07-20 14:04:47 -05:00
Laura Pacilio a780f625e9 Fix metadata description format on all pages 2021-07-19 12:11:10 -04:00
Laura Pacilio 603e156bb9 Update input variables page metadata 2021-07-16 17:32:24 -04:00
Laura Pacilio 1f1563b889 Fix formatting error on language home page 2021-07-16 17:28:40 -04:00
Laura Pacilio 725c1c2a86 Update style conventions page metadata 2021-07-16 17:28:13 -04:00
Laura Pacilio f67e7f6a9f Update json configuration syntax page metadata 2021-07-16 17:21:16 -04:00
Laura Pacilio df6135e4c7 Update languge syntax overview page metadata 2021-07-16 17:17:39 -04:00
Laura Pacilio b6b4340214 Add detail to backend overview page metadata 2021-07-16 17:08:24 -04:00
Laura Pacilio f46974dbb2 Add detail to settings intro page metadata 2021-07-16 17:03:13 -04:00
Laura Pacilio 80fee567a2 Add detail to resource block page metadata 2021-07-16 16:55:13 -04:00
Laura Pacilio 77c208d02f Add detail to declare provisioners page metadata 2021-07-16 16:50:55 -04:00
Laura Pacilio 6f056af08e Update null resource page metadata 2021-07-16 16:46:16 -04:00
Laura Pacilio 55ebc7eef4 Add detail to provisioners overview page metadata 2021-07-16 16:43:12 -04:00
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
2021-07-15 12:22:17 -04:00
Laura Pacilio bc9065334e Update description metadata per PR feedback 2021-07-14 16:54:26 -04:00
Rémi Lapeyre 4177bd98b9 Change wording for the skip_... options of the pg backend 2021-07-14 12:01:54 +02:00
Laura Pacilio eebbdd6778 Update dynamic blocks description with more detail and to remove 'ing' 2021-07-13 17:48:28 -04:00
Laura Pacilio 8abbbc7c7f Update conditionals metadata to include more detail and remove 'ing' 2021-07-13 17:40:16 -04:00
Laura Pacilio a740d75882 Update dependency lock file description with more detail and remove 'ing' 2021-07-13 17:34:34 -04:00
Laura Pacilio 12d1706562 Update data sources metadata to remove ing and include more detailXy 2021-07-13 17:23:07 -04:00
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>
2021-07-09 14:44:58 -07:00
Laura Pacilio 6cf2ad27a7 Fix typo in description on expressions overview page 2021-07-09 17:26:30 -04:00
Laura Pacilio 69ebfd6f03 Add/update description metadata on backend and state overview pages 2021-07-09 15:56:12 -04:00
Laura Pacilio a37fd2f5f7 Upate description metadata on terraform settings overview 2021-07-09 15:46:07 -04:00
Laura Pacilio 952cb33103 Add description metadata to functions overview page 2021-07-09 15:42:58 -04:00
Laura Pacilio 7dba0e511f Add description metadata to remaining expressions pages 2021-07-09 15:40:05 -04:00
Laura Pacilio 2718d2addc Add description metadata to module block page 2021-07-09 15:32:25 -04:00
Laura Pacilio df16096141 Add description metadata to dynamic blocks, types, and module providers 2021-07-09 15:28:28 -04:00
Laura Pacilio d9f7ce19fe Add description metadata to conditionals page 2021-07-09 15:17:18 -04:00
Laura Pacilio 3baddbef0e Add description metadata to creating modules pagey 2021-07-09 12:14:58 -04:00
Laura Pacilio e348477c79 Add description metadata to module sources 2021-07-09 12:08:48 -04:00
Laura Pacilio 4044fe30d3 Add description metadata to modules overview page 2021-07-09 11:59:38 -04:00
Laura Pacilio f4f8d7a6c5 Change use to using for consistency with other docs 2021-07-09 11:50:19 -04:00
Laura Pacilio adf4dbdf84 Update description metadata 2021-07-09 11:45:42 -04:00
Laura Pacilio 14d6e0dea9 Add Terraform key work to description metadata 2021-07-09 11:37:01 -04:00
Laura Pacilio 07accd7a38 Add page metadata to variables and outputs overview 2021-07-09 11:34:02 -04:00
Laura Pacilio 9dc008fa10 Add metadata description to dependency lock file page 2021-07-09 11:25:55 -04:00
Laura Pacilio 62b11f02e2 Make metadata description more concise 2021-07-09 11:15:10 -04:00
Laura Pacilio 62b444504d Add description metadata to provider requirements 2021-07-09 11:07:37 -04:00
Laura Pacilio d107b46270 Make description metadata more concise 2021-07-09 11:01:32 -04:00
Laura Pacilio bca3957e17 Update description metadata for input variables 2021-07-09 10:53:37 -04:00
Laura Pacilio 134170c121 Fixing broken link on syntax page 2021-07-09 10:32:17 -04:00
Laura Pacilio f5c463c27e Update broken link oon provisioners connection page 2021-07-09 10:30:35 -04:00
Laura Pacilio 493d4b8dc8 Update description metadata 2021-07-07 17:37:19 -04:00
Laura Pacilio f25d993b47 Update description metadata to include key words 2021-07-07 17:34:03 -04:00
Laura Pacilio 6f8774a8ed Add Terraform to description metadata for SEO 2021-07-07 17:24:58 -04:00
Laura Pacilio 2e25fd04c0 Add description metadata to provisioners index page 2021-07-07 15:10:14 -04:00
Laura Pacilio 6d0569ac45 Add description metadata to lifecycle page 2021-07-07 15:07:00 -04:00
Laura Pacilio 66103f273e Add description metadata to resource provider page 2021-07-07 15:05:02 -04:00
Laura Pacilio 96994d0b01 Add description metadata to for_each page 2021-07-07 15:02:01 -04:00
Laura Pacilio 4a2a6e8b52 Add description metadata to count and update depends_on 2021-07-07 14:59:20 -04:00
Laura Pacilio ddabca8c72 Add description metadata to depends_on page 2021-07-07 14:54:51 -04:00
Laura Pacilio e60e77c68f Add description metadata to behavior page 2021-07-07 14:42:30 -04:00
Laura Pacilio 66dfb56d4f Update description metadata to include key words 2021-07-07 14:42:30 -04:00
Laura Pacilio 810543b997 Add description metadata to resources overview page 2021-07-07 14:42:30 -04:00
Laura Pacilio 08f1d6c9e0 Update description metadata for style page 2021-07-07 14:42:30 -04:00
Laura Pacilio c33970bfa4 Add description metadata to JSON syntax page 2021-07-07 14:42:30 -04:00
Laura Pacilio 5384aacb5e Update description metadata for key words 2021-07-07 14:42:30 -04:00
Laura Pacilio 887b019761 Fix capitalization on Terraform language 2021-07-07 14:42:30 -04:00
Laura Pacilio a62e2825c7 Add description metadata to syntax overview 2021-07-07 14:42:30 -04:00
Laura Pacilio f6b500379d Update description metadata to include Terraform key word 2021-07-07 14:42:30 -04:00
Laura Pacilio ab06843f1d Add description metadata to files and directories 2021-07-07 14:42:30 -04:00
Laura Pacilio 8525befc22 Add description metadata to index page 2021-07-07 14:42:30 -04:00
Brent Woodruff 3a66236c14 note that output of jsonencode is minified 2021-07-02 15:36:47 -04:00
Laura Pacilio 577c3653f2
Merge pull request #28983 from KurtLehnardt/patch-1
fixed typo
2021-06-30 08:54:04 -04:00
Laura Pacilio de97a03528
Merge pull request #28908 from kondr57/patch-1
fix typo
2021-06-30 08:43:26 -04:00
Ben Moskovitz 21228e19df Fix broken links as pointed out by CI
See: https://app.circleci.com/pipelines/github/hashicorp/terraform/6853/workflows/cc37def1-6bf5-4f6c-89b1-10dfcc65ea5e/jobs/44887
2021-06-30 16:55:00 +12:00
Ben Moskovitz d29cdccb5b Add a note to the docs on the S3 backend around permissions needed for encrypted state storage 2021-06-30 16:45:17 +12:00
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.
2021-06-22 14:10:04 -07:00
Robin Norwood 50fe980877
Merge pull request #28998 from hashicorp/rln-add-versions-tutorials-links
Add links to terraform versions tutorials
2021-06-22 11:50:18 -05:00
Robin Norwood 2c71bb3a2e Add links to terraform versions tutorials 2021-06-21 14:26:43 -05:00
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>
2021-06-18 17:20:00 +01:00
Kurt Lehnardt 165b2a2509
fixed typo 2021-06-18 09:59:56 -06:00