website: Update and link the page about remote backend operations (#19203)
This commit is contained in:
parent
b2f7da05c8
commit
ab88f8ca0f
|
@ -1,19 +1,32 @@
|
|||
---
|
||||
layout: "docs"
|
||||
page_title: "Backends: Operations (refresh, plan, apply, etc.)"
|
||||
sidebar_current: "docs-backends-ops"
|
||||
page_title: "Backends: Remote Operations (plan, apply, etc.)"
|
||||
sidebar_current: "docs-backends-operations"
|
||||
description: |-
|
||||
Some backends support the ability to run operations (`refresh`, `plan`, `apply`, etc.) remotely. Terraform will continue to look and behave as if they're running locally while they in fact run on a remote machine.
|
||||
---
|
||||
|
||||
# Operations (plan, apply, etc.)
|
||||
# Remote Operations (plan, apply, etc.)
|
||||
|
||||
Some backends support the ability to run operations (`refresh`, `plan`, `apply`,
|
||||
etc.) remotely. Terraform will continue to look and behave as if they're
|
||||
running locally while they in fact run on a remote machine.
|
||||
Most backends run all operations on the local system — although Terraform stores
|
||||
its state remotely with these backends, it still executes its logic locally and
|
||||
makes API requests directly from the system where it was invoked.
|
||||
|
||||
Backends should not modify the actual infrastructure change behavior of
|
||||
these commands. They will only modify how they're invoked.
|
||||
This is simple to understand and work with, but when many people are
|
||||
collaborating on the same Terraform configurations, it requires everyone's
|
||||
execution environment to be similar. This includes sharing access to
|
||||
infrastructure provider credentials, keeping Terraform versions in sync,
|
||||
keeping Terraform variables in sync, and installing any extra software required
|
||||
by Terraform providers. This becomes more burdensome as teams get larger.
|
||||
|
||||
At the time of writing, no backends support this. This shouldn't be linked
|
||||
in the sidebar yet!
|
||||
Some backends can run operations (`plan`, `apply`, etc.) on a remote machine,
|
||||
while appearing to execute locally. This enables a more consistent execution
|
||||
environment and more powerful access controls, without disrupting workflows
|
||||
for users who are already comfortable with running Terraform.
|
||||
|
||||
Currently, [the `remote` backend](./types/remote.html) is the only backend to
|
||||
support remote operations, and [Terraform Enterprise](/docs/enterprise/index.html)
|
||||
is the only remote execution environment that supports it. For more information, see:
|
||||
|
||||
- [The `remote` backend](./types/remote.html)
|
||||
- [Terraform Enterprise's CLI-driven run workflow](/docs/enterprise/run/cli.html)
|
||||
|
|
|
@ -308,6 +308,10 @@
|
|||
<a href="/docs/backends/state.html">State Storage & Locking</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-backends-operations") %>>
|
||||
<a href="/docs/backends/operations.html">Remote Operations</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-backends-types") %>>
|
||||
<a href="/docs/backends/types/index.html">Backend Types</a>
|
||||
</li>
|
||||
|
|
Loading…
Reference in New Issue