Commit Graph

101 Commits

Author SHA1 Message Date
Martin Atkins
dc9bec611c website: Reorganize and tidy some lifecycle-related information
Over time the discussion about "lifecycle" blocks in the documentation
became confusing because the docs originally written for managed resource
lifecycle got partially generalized for resources of other modes and for
module calls, even though each of those has a completely different
lifecycle and thus a different set of lifecycle settings.

This is a first pass at trying to reorganize that so that the "lifecycle"
page is really just an index of all of the different kinds of lifecycle
block that exist in the language, while the main documentation for each
use of that block type now belongs with the documentation of the block
it's nested within.

While working on this I also found that there was some duplication inside
the "data sources" page where the same information was described multiple
times, and a few other cases where things had become inconsistent over
time. This also includes a little extra content to try to clarify the
difference between managed, data, and ephemeral resources and to make it
explicit that the "Resources" section is focused only on managed resources
because that is the primary resource mode.

As usual there's lots more that could be done here -- this documentation
has gradually evolved over time and is full of weird quirks due to that
evolution -- but I decided to draw a line here so that the diff wouldn't
get too large.

Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
2025-10-17 15:08:14 -07:00
Diógenes Fernandes
d42dcc3b0a Add docs for the conditional enabled lifecycle attribute (#3380)
Signed-off-by: Diogenes Fernandes <diofeher@gmail.com>
Co-authored-by: Martin Atkins <mart@degeneration.co.uk>
Co-authored-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
2025-10-16 13:10:00 -03:00
Andrei Ciobanu
57057aef27 Add docs for all ephemeral constructs (#3209)
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
Signed-off-by: Christian Mesh <christianmesh1@gmail.com>
Co-authored-by: Christian Mesh <christianmesh1@gmail.com>
Co-authored-by: Diógenes Fernandes <diofeher@opentofu.org>
Signed-off-by: Christian Mesh <christianmesh1@gmail.com>
2025-09-10 07:45:23 -04:00
Andrei Ciobanu
3c51831e5c Enhance removed block with lifecycle and provisioner functionalities (#2628)
Signed-off-by: yottta <andrei.ciobanu@opentofu.org>
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
2025-04-25 06:29:42 -04:00
Ilia Gogotchuri
ec4e0cf0e2 Migration of null resource to terraform data (#2481)
Signed-off-by: Ilia Gogotchuri <ilia.gogotchuri0@gmail.com>
2025-02-06 17:45:00 +04:00
Nathan Baulch
ea558d9d4b Fix typos (#1905)
Signed-off-by: Nathan Baulch <nathan.baulch@gmail.com>
Signed-off-by: Christian Mesh <christianmesh1@gmail.com>
Co-authored-by: Christian Mesh <christianmesh1@gmail.com>
2024-08-29 13:20:33 -04:00
Janos
a15a6c9657 Versioned docs: replacing docs links with relative variants (#1537)
Signed-off-by: Janos <86970079+janosdebugs@users.noreply.github.com>
Signed-off-by: Damian Stasik <920747+damianstasik@users.noreply.github.com>
Signed-off-by: Roman Grinovski <roman.grinovski@gmail.com>
Co-authored-by: Damian Stasik <920747+damianstasik@users.noreply.github.com>
Co-authored-by: Roman Grinovski <roman.grinovski@gmail.com>
2024-04-24 13:24:30 +02:00
Ronny Orot
99b43c98fc Adding removed block docs (#1332)
Signed-off-by: Ronny Orot <ronny.orot@gmail.com>
Co-authored-by: Janos <86970079+janosdebugs@users.noreply.github.com>
2024-03-07 15:47:22 +02:00
Mario Valderrama
e84b2f7f95 Support the XDG Base Directory Specification (#1200)
Signed-off-by: Mario Valderrama <mario.valderrama@ionos.com>
2024-01-31 11:04:09 +01:00
RLRabinowitz
1b9148a3de Remove Terraform mentions in docs in the codebase (#713) 2023-10-12 12:11:01 +01:00
Julien Levasseur
4c0bda5386 Rename website to OpenTofu (#516)
Co-authored-by: Damian Stasik <920747+damianstasik@users.noreply.github.com>
Co-authored-by: Roman Grinovski <roman.grinovski@gmail.com>
2023-09-21 10:57:47 +01:00
Damian Stasik
4cab6e72b4 Replace legacy admonition syntax (#432) 2023-09-18 13:56:28 +02:00
Damian Stasik
072d1dce56 Clean up frontmatter sections in the docs (#421) 2023-09-15 16:03:23 +02:00
Roman Grinovski
a4f9c63288 Change docs links: /opentf-> /docs (#367)
Signed-off-by: Roman Grinovski <roman.grinovski@gmail.com>
2023-09-15 14:10:27 +02:00
James Humphries
acc913a77e Added eslint + remark-lint to our documentation pages (#249)
Signed-off-by: James Humphries <james@james-humphries.co.uk>
2023-09-06 17:16:54 +01:00
Marcin Białoń
f8ee967230 Update website/docs/language/resources (#232)
Signed-off-by: Marcin Białoń <mbialon@spacelift.io>
2023-08-30 13:08:53 +02:00
RLRabinowitz
c31a2812fb Remove terraform from file names in website folder 2023-08-27 14:06:49 +03:00
Kuba Martin
0ec2b6b150 Revert "Add support for ~/.opentf.d (#22)" (#38)
This reverts commit e650bab8d7.
2023-08-21 17:12:19 +02:00
Kuba Martin
e650bab8d7 Add support for ~/.opentf.d (#22)
* Use ~/.opentf.d instead of ~/.terraform.d

Stay backwards-compatible, though.

Signed-off-by: Jakub Martin <kubam@spacelift.io>

* Fix imports.

Signed-off-by: Jakub Martin <kubam@spacelift.io>

* Add tests.

Signed-off-by: Jakub Martin <kubam@spacelift.io>

* Use util function.

Signed-off-by: Jakub Martin <kubam@spacelift.io>

* Fix windows directories.

Signed-off-by: Jakub Martin <kubam@spacelift.io>

* Add a comment to the tests.

Signed-off-by: Jakub Martin <kubam@spacelift.io>

---------

Signed-off-by: Jakub Martin <kubam@spacelift.io>
2023-08-21 12:38:11 +02:00
Craig Wright
8b210951d9 Merge pull request #31995 from sed-i/yamlencode-cloudconfig 2023-07-12 14:46:31 -07:00
Leon
0181c4e2d9 Update website/docs/language/resources/provisioners/syntax.mdx
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2023-07-11 00:52:51 -04:00
Din Mušić
8501d07dff Fix typo in connection.mdx 2023-07-10 20:09:18 +02:00
Rose M Koron
2b3da31c83 Merge pull request #32518 from irth/patch-1
docs: provisioners: fix formatting on a note
2023-05-11 17:18:50 -07:00
Rose M Koron
fbdc07cb7d Update website/docs/language/resources/provisioners/syntax.mdx 2023-05-11 17:09:42 -07:00
Brian Flad
9150a1bb75 website: Minor fixes to Provisioners Without a Resource page
Some details about `null_resource` were not updated with the transition to `terraform_data`.
2023-03-21 09:51:40 -04:00
Ashlee Boyer
32f7b8ebd0 Migrating links to new format 2023-02-23 12:55:56 -05:00
James Bardin
5adea6d58e change provisioner example in terraform_data
The existing example is already covered in the "Provisioners Without a
Resource" section, so make this one slightly different by triggering a
local-exec on multiple resources.
2023-02-14 15:05:41 -05:00
James Bardin
0a25e40aeb updates from review 2023-02-14 14:50:50 -05:00
James Bardin
f35625820a Update website/docs/language/resources/terraform-data.mdx
Co-authored-by: Martin Atkins <mart@degeneration.co.uk>
2023-02-14 14:10:07 -05:00
James Bardin
df65d16022 replace null_resource with terraform_data
Replace references to null_resource with terraform_data, and link the
use of terraform_data from replace_triggered_by.
2023-02-14 09:48:10 -05:00
James Bardin
0328d116c5 initial terraform_data docs 2023-02-13 17:59:31 -05:00
kmoe
e5c1b8f2c9 Update local-exec.mdx 2023-01-25 16:59:01 +00:00
Wojciech Kwolek
12c03eb71a docs: provisioners: fix formatting on a note
The destroy-time provisioner note was formatted as a code block instead of an actual note.
2023-01-16 12:16:38 +01:00
Laura Pacilio
cf47c71291 Revert "Revert "Remove future-facing statements""
This reverts commit cb975a5fff.
2022-10-14 16:14:20 -04:00
Laura Pacilio
cb975a5fff Revert "Remove future-facing statements"
This reverts commit 0a7e221a49.
2022-10-14 15:00:22 -04:00
Laura Pacilio
0a7e221a49 Remove future-facing statements 2022-10-14 14:42:40 -04:00
sed-i
42e689376a Add example for using cloud-config in place of file provisioners 2022-10-12 13:35:58 +03:00
Bryce Kalow
b54017ef83 website: content updates for developer (#31779)
Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
Co-authored-by: Kevin Wang <kwangsan@gmail.com>
Co-authored-by: Judith Malnick <judith@hashicorp.com>
Co-authored-by: Martin Atkins <mart@degeneration.co.uk>
Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com>
2022-09-15 15:54:13 -05:00
Laura Pacilio
ee61929a9c update note on provisioners page 2022-09-14 18:51:43 -04:00
Laura Pacilio
a891119b61 Remove legacy provisioners from docs 2022-09-14 18:43:48 -04:00
Ian Rosenbery
1e26403677 Update website/docs/language/resources/provisioners/remote-exec.mdx
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2022-07-01 14:11:33 -07:00
ianmrose-cm
a52cf190a6 Update language according to review feedback. 2022-06-28 09:41:12 -07:00
ianmrose-cm
35da1618ed Add shell explanation to remote-exec inline argument documentation.
The current implementation does not use the default shell for
the ssh user to execute inline commands, which can be somewhat
confusing to debug. Provide explicit documentation to explain this,
and documentation can be removed if ssh user default shell is supported.
2022-06-23 12:30:34 -07:00
Park Choong Ho
7510dc4d47 Update website/docs/language/resources/syntax.mdx
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2022-06-13 17:21:37 +09:00
Park Choong Ho
3513352300 Update syntax.mdx
fix wrong grammar
2022-06-08 18:37:56 +09:00
miyagawa-michiru
61271ef117 Add a missing word 2022-05-19 08:05:34 +09:00
miyagawa-michiru
2bb83244f9 Update the explanation about 'when' option 2022-05-18 14:57:46 +09:00
miyagawa-michiru
315d168cc0 Add an explanation about the argument 'when' for local-exec 2022-05-15 18:12:26 +09:00
htamakos
4cfb6bc893 communicator/ssh: Add support SSH over HTTP Proxy (#30274)
Terraform's remote-exec provision hangs out when it execs on HTTP Proxy bacause it dosen't support SSH over HTTP Proxy. This commits enables Terraform's remote-exec to support SSH over HTTP Proxy.

* adds `proxy_*` fields to `connection` which add configuration for a proxy host
* if `proxy_host` set, connect to that proxy host via CONNECT method, then make the SSH connection to `host` or `bastion_host`
2022-04-27 16:59:17 -04:00
James Bardin
0501980b46 Update website/docs/language/resources/behavior.mdx
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2022-04-26 18:17:58 -04:00