Commit Graph

35 Commits

Author SHA1 Message Date
Laura Pacilio 1b7e7b967d Fix broken links to external docs 2022-01-10 17:49:49 -05:00
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
Dylan Staley 21cbb5b392 migrate docs to mdx 2021-12-14 18:41:17 -08: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
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 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 31af9adc00 Make all sentences start with caps + additional tweak wording edits 2021-07-30 14:44:17 -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 a780f625e9 Fix metadata description format on all pages 2021-07-19 12:11:10 -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
Laura Pacilio bc9065334e Update description metadata per PR feedback 2021-07-14 16:54:26 -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 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
Kyle A. Matheny 3afa08b1bc
Remove duplicate word (#28716) 2021-05-18 11:04:54 -04:00
Chad Bailey a303a03f2f
Added clarity: remote-exec connection requirement
This is a secondary change to PR #28578 

Details:
According to the [Provisioner Connection](https://www.terraform.io/docs/language/resources/provisioners/connection.html) page, provisioners require the connection block.

This change of behavior is shown prominently within a note on the [Provisioner Connection](https://www.terraform.io/docs/language/resources/provisioners/connection.html) page:

> Note: In Terraform 0.11 and earlier, providers could set default values for some connection settings, so that connection blocks could sometimes be omitted. This feature was removed in 0.12 in order to make Terraform's behavior more predictable.

However, this behavioral change is omitted from the [remote-exec provisioner](https://www.terraform.io/docs/language/resources/provisioners/remote-exec.html) page which is where a user will be if they are attempting to follow the prior behavior when this was permissible in versions prior to 0.12. This change prompts the user of that change and directs to the connection page.
2021-05-02 17:14:10 -05:00
Yves Peter c6de87354a document that destroy provisioners don't run with create_before_destroy 2021-04-13 10:26:32 +02:00
Oliver Ford 2f7c368d91
Document `inline` & `on_failure` behaviour
cf. #27554
2021-02-19 17:56:48 +00:00
Nick Fagerlund 8cfcd82be3 website: Language: Remove several ghost pages, update links
During the language/CLI docs reorg, we noticed several pages that were no longer
viable; some were redundant, some useless, and some just very obsolete.

Since we were trying to avoid breaking links at the time, we opted to remove
them from the navs and leave them as "ghost pages" — still accessible, but not
findable.

This commit finally cleans these ghosts up and updates any remaining links to
relevant modern pages. Bustin' makes me feel good. 👻🚫
2021-01-22 12:22:21 -08:00
Nick Fagerlund 7a8dd326c6 website: Language: Update links to moved pages 2021-01-22 12:22:21 -08:00
Nick Fagerlund 78dcc8dc1b website: Language: Move files to match new URL structure 2021-01-22 12:22:21 -08:00