Commit Graph

284 Commits

Author SHA1 Message Date
Ben Partridge
fa8a87fab5 Adds documentation to substr function to cover when length longer than input string
The `substr` function allows the `length` parameter to be longer than the remaining characters in the input after the offset. This is useful for when you want to truncate a string to a maximum number of characters. However, the documentation isn't clear on this so I had to do a test deployment to confirm the behaviour after finding the behaviour in an old issue https://github.com/hashicorp/terraform/issues/15751
2022-02-07 15:12:22 +11:00
Martin Atkins
f1b7f12f1c website: Initial draft docs for Preconditions and Postconditions 2022-01-31 14:02:53 -05:00
Craig Wright
ca02b55fba Merge pull request #30409 from tyron/fix-module-outputs-reference
Fix reference to child module in outputs docs
2022-01-26 15:47:42 -08:00
Laura Pacilio
9e28fc44cd Merge branch 'main' into fix-remote-backend-references 2022-01-26 11:47:19 -05:00
Laura Pacilio
53aa84576f Update website/docs/language/state/remote-state-data.mdx
Co-authored-by: Nick Fagerlund <nick.fagerlund@gmail.com>
2022-01-26 11:43:16 -05:00
Laura Pacilio
1b1b5225a2 Update website/docs/language/state/remote-state-data.mdx
Co-authored-by: Nick Fagerlund <nick.fagerlund@gmail.com>
2022-01-26 11:42:22 -05:00
Tyron
322622a0f4 fix reference to module
References to child modules should use the resource name, not their path
2022-01-25 20:54:20 -05:00
Laura Pacilio
9953260083 Merge pull request #30296 from hashicorp/fix-provisioners-content
Fix provisioners content
2022-01-24 13:49:28 -05:00
Laura Pacilio
20e740ef88 Final formatting and langauge nits 2022-01-21 11:01:37 -05:00
Laura Pacilio
9f4c4ff093 Update note to be more direct :) 2022-01-21 10:48:27 -05:00
Laura Pacilio
1d53273b7a Language nits 2022-01-20 11:28:52 -05:00
Laura Pacilio
29a4591cf2 Fix warning notes 2022-01-20 10:57:38 -05:00
GiannakopoulosJ
13907690a2 Typo in zipmap documentation
zipmap does not produce a map with comma in terraform cli
tested with Terraform v1.1.3
2022-01-19 16:02:24 +02:00
Laura Pacilio
ec17cbaeee update additional references to overview page 2022-01-18 14:25:28 -08:00
Laura Pacilio
20e9f30c3d formatting nits 2022-01-18 14:25:28 -08:00
Laura Pacilio
63106da0b9 Language updates 2022-01-18 14:25:28 -08:00
Laura Pacilio
fc4ceedc6d Remove overview page and update notes on provisioner pages 2022-01-18 14:07:40 -08:00
Laura Pacilio
1b7e7b967d Fix broken links to external docs 2022-01-10 17:49:49 -05:00
Laura Pacilio
f4eb0ed24d Merge pull request #30280 from Mukesh05/patch-2
Update local values definition
2022-01-07 10:22:57 -05:00
Mukesh Kumar
3ac334f267 Update website/docs/language/values/locals.mdx
Thank you. Your suggestion to use "instead of" makes the sentence even more easy to understand.

Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2022-01-07 05:52:12 +05:30
Martin Atkins
087c2f06ee website: Documentation of how provisioners upload files
We recently made a change to how provisioners upload files in order to
address an unintended remote code execution vector when using SSH, which
revealed that we had not previously documented well enough the expected
contract for how provisioners upload files to remote systems, and so some
users were depending on unintended consequences of the the bug now fixed.

We are retaining the fix on security-related grounds, but this is a good
prompt to be clearer in the docs about what exactly Terraform is doing
when asked to upload files over SSH and WinRM, so users can understand
what is supported and write their configurations accordingly.

This also includes an additional section to the v1.1 upgrade guide, since
we apparently neglected to document this intentional breaking change in
the first draft of that page.

Of course, provisioners as a whole remain a last resort, and so we're
documenting this as hopefully a helpful aid to those who have no other
option, and not meaning in any way to recommend their use for any new
use-cases.
2022-01-06 13:04:55 -08:00
Laura Pacilio
870116c509 more langauge edits 2022-01-06 11:48:13 -05:00
Laura Pacilio
fbf02d6342 Language edits 2022-01-06 11:46:08 -05:00
Laura Pacilio
6ef9cf652e Merge pull request #30270 from addison-grant/patch-1
Update variables.mdx to fix typo
2022-01-06 11:14:46 -05:00
Laura Pacilio
8b69d24147 Update remote state data source page 2022-01-04 16:31:52 -05:00
Martin Atkins
74761b2f8b getmodules: Use go-getter v1.5.10 and return to upstream GitGetter
There was an unintended regression in go-getter v1.5.9's GitGetter which
caused us to temporarily fork that particular getter into Terraform to
expedite a fix. However, upstream v1.5.10 now includes a
functionally-equivalent fix and so we can heal that fork by upgrading.

We'd also neglected to update the Module Sources docs when upgrading to
go-getter v1.5.9 originally and so we were missing documentation about the
new "depth" argument to enable shadow cloning, which I've added
retroactively here along with documenting its restriction of only
supporting named refs.

This new go-getter release also introduces a new credentials-passing
method for the Google Cloud Storage getter, and so we must incorporate
that into the Terraform-level documentation about module sources.
2022-01-03 11:44:16 -08:00
Mukesh Kumar
27cc49fe91 Update local values definition
The definition of local values used "it" many times, making the sentence not very clear.
2022-01-01 20:35:47 +05:30
Addison Grant
01be55b5c4 Update variables.mdx
Remove extraneous word "from" in "...use a sensitive value from as part of an..."
2021-12-27 10:25:31 -08:00
Martin Atkins
e35c25da44 website: Try function documentation "provably" vs "probably" typo
This paragraph is trying to say that try only works for dynamic errors and
not for errors that are _not_ based on dynamic decision-making in
expressions.

I'm not sure if this typo was always here or if it was mistakenly "corrected"
at some point, but either way the word "probably" changes the meaning
of this sentence entirely, making it seem like Terraform is hedging
the likelihood of a problem rather than checking exactly for one.
2021-12-22 12:10:07 -08:00
Laura Pacilio
f55af42086 Update module sources page 2021-12-21 17:10:29 -05:00
Martin Atkins
23395a1022 providercache: Discard lock entries for unused providers
Previously we would only ever add new lock entries or update existing
ones. However, it's possible that over time a module may _cease_ using
a particular provider, at which point we ought to remove it from the lock
file so that operations won't fail when seeing that the provider cache
directory is inconsistent with the lock file.

Now the provider installer (EnsureProviderVersions) will remove any lock
file entries that relate to providers not included in the given
requirements, which therefore makes the resulting lock file properly match
the set of packages the installer wrote into the cache.

This does potentially mean that someone could inadvertently defeat the
lock by removing a provider dependency, running "terraform init", then
undoing that removal, and finally running "terraform init" again. However,
that seems relatively unlikely compared to the likelihood of removing
a provider and keeping it removed, and in the event it _did_ happen the
changes to the lock entry for that provider would be visible in the diff
of the provider lock file as usual, and so could be noticed in code
review just as for any other change to dependencies.
2021-12-17 15:30:21 -08:00
Dylan Staley
21cbb5b392 migrate docs to mdx 2021-12-14 18:41:17 -08:00
Patrick Decat
6530055d18 website: Refactoring "Renaming a Module Call" should include a moved block 2021-12-09 14:54:19 -08:00
Laura Pacilio
7ae574ba6a Merge pull request #30082 from c00k133/docs-vars-typo
Docs: Change misspelling of variable in documentation
2021-12-09 16:35:50 -05:00
Marcus Way
b202eefc7b Update docs to use assume_role block
I'm guessing this document is just out of date, but I got an error when configuring `assume_role` as an argument and had to add an `assume_role` block
2021-12-08 19:33:17 -05:00
Laura Pacilio
168c2885e3 Fix link text 2021-12-08 18:03:26 -05:00
Laura Pacilio
22d80df0ba Fix extra space in link 2021-12-08 18:01:48 -05:00
Laura Pacilio
2edd9f4e10 Update broken links 2021-12-08 17:53:18 -05:00
Martin Atkins
533a29edee website: Shorter heading for the nullable = false variable argument
This makes it match some incoming links we have elsewhere, but also it
makes the heading a bit more consice because "module" isn't really adding
anything here anyway: input variables are _always_ in modules.
2021-12-08 14:08:42 -08:00
Martin Atkins
f95dcfe90a website: Fix link from remote backend page to the terraform.workspace docs 2021-12-08 14:08:42 -08:00
Chris Arcand
81136ce5e1 Merge pull request #30102 from hashicorp/tfc-integration-docs-again
Add Terraform Cloud integration docs
2021-12-08 13:20:20 -06:00
Laura Pacilio
0bd3491ef8 Fix typo and update note 2021-12-08 13:55:45 -05:00
Laura Pacilio
d0cb88f091 Updates to TFC page in Language 2021-12-08 13:49:58 -05:00
Judith Malnick
d82211ad7b Keep version note, include introduction and enterprise versioning 2021-12-08 09:49:12 -08:00
Judith Malnick
f514f8eb30 Apply suggestions from code review
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-12-08 09:43:18 -08:00
Chris Arcand
099c7269e4 Add Terraform Cloud integration docs 2021-12-07 16:41:48 -06:00
Chris Arcand
b80e98ab47 Misc doc edits referencing state/settings 2021-12-07 16:29:51 -06:00
Chris Arcand
f521ba6cd7 Remove 'enhanced' backend type distinction
As explained in the changes: The 'enhanced' backend terminology, which
only truly pertains to the 'remote' backend with a single API (Terraform
Cloud/Enterprise's), has been found to be a confusing vestige which need
only be explained in the context of the 'remote' backend.

These changes reorient the explanation(s) of backends to pertain more
directly to their primary purpose, which is storage of state snapshots
(and not implementing operations).

That Terraform operations are still _implemented_ by the literal
`Backend` and `Enhanced` interfaces is inconsequential a user of
Terraform, an internal detail.
2021-12-07 16:29:51 -06:00
Laura Pacilio
529a2c34df Update note and add learn call out 2021-12-07 17:09:13 -05:00
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