Commit Graph

1703 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
Alisdair McDiarmid
0634c9437a Merge pull request #30401 from hashicorp/f-preconditions-postconditions-rebased
Preconditions and Postconditions
2022-02-02 15:31:03 -05:00
Laura Pacilio
a794c80e0d final nits 2022-01-31 14:17:36 -05:00
Laura Pacilio
d14e04bf36 Fix notes according to PR feedback 2022-01-31 14:03:03 -05:00
Martin Atkins
f1b7f12f1c website: Initial draft docs for Preconditions and Postconditions 2022-01-31 14:02:53 -05:00
Laura Pacilio
a2f83ef7b6 Try to fix wording so it's clearer and more cohesive 2022-01-28 15:28:35 -05:00
Laura Pacilio
6e80276cc9 Remove invisible space 2022-01-28 14:44:56 -05:00
Laura Pacilio
f56c7c1c85 Make language in callouts more user friendly 2022-01-27 17:05:45 -05:00
Laura Pacilio
dca94a9eaf fix verb tense 2022-01-27 16:58:17 -05:00
Laura Pacilio
aa3a046af3 final nits 2022-01-27 16:56:50 -05:00
Laura Pacilio
1a66861aaf A couple other tweaks 2022-01-27 16:53:25 -05:00
Laura Pacilio
238396567d Making replace flag clearer and making plan options clearer 2022-01-27 16:00:08 -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
Laura Pacilio
e9d79f5284 Update website/docs/cli/import/index.mdx
Co-authored-by: Nick Fagerlund <nick.fagerlund@gmail.com>
2022-01-26 11:41:57 -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
5f61140655 Merge pull request #30332 from hashicorp/fix-broken-links-1-10
Fix broken links to external docs
2022-01-11 10:40:12 -05:00
Martin Atkins
beb9432155 website: CLI state manipulation section de-emphasize old features
Previously the "terraform state ..." subcommands were the only way to
perform various manipulations of the state, but in recent Terraform
versions we have replaced these with better options.

Since these pages seem to already have pretty good search engine
optimization for the use-cases they are describing, we'll prioritize
mentioning the new approaches and only mention the now-deprecated or
de-emphasized features as a secondary approach.

Specifically:
 - Describe the -replace=... planning option in preference to
   "terraform taint", and present taint as primarily a mechanism for
   Terraform to use itself, as opposed to something end-users should
   typically use directly.
 - Introduce the config-based refactoring features before describing
   "terraform state mv".

The older features here are still applicable in some situations and are
required for those still using older versions of Terraform, so we will
retain the information about them for now while aiming to be clearer in
each case about which is our preferred, modern approach.
2022-01-11 07:36:20 -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
Laura Pacilio
5792973dd6 Update language on import command page 2022-01-04 15:22:12 -05:00
Laura Pacilio
cab5305191 Fix formatting 2022-01-04 14:58:31 -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
138ca02b90 More mentions of remote backend 2021-12-21 17:51:06 -05:00
Laura Pacilio
caf0bdbe8d fix push 2021-12-21 17:39:30 -05:00
Laura Pacilio
9022b23d57 Fixing references again 2021-12-21 17:37:35 -05:00
Laura Pacilio
3adcc0158c Add cli integration to command pages 2021-12-21 17:19:05 -05:00
Laura Pacilio
f55af42086 Update module sources page 2021-12-21 17:10:29 -05:00
Laura Pacilio
04fb42cb05 Update push CLI command page 2021-12-21 17:05:09 -05:00