From a710447eaf43f65eac2932845c30666724b35992 Mon Sep 17 00:00:00 2001 From: Sander van Harmelen Date: Tue, 19 Mar 2019 20:41:42 +0100 Subject: [PATCH] website: clarify behavior and version support for remote backend (#20739) * docs: elaborate on supported remote backend versions This PR adds a few lines to the docs to indicate which commands are supported by what version of the remote backend and it makes a recommendation about which version to use. * Clarify remote state storage w/ TFE [skip ci] Specifically, that this is the backend to use with remote state (all tiers) and Free-Tier vs. Enterprise tiers differ in remote operations * website: Arrange remote backend info differently --- website/docs/backends/types/remote.html.md | 26 ++++++++++++++-------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/website/docs/backends/types/remote.html.md b/website/docs/backends/types/remote.html.md index c8416d63fc..1224e1a19d 100644 --- a/website/docs/backends/types/remote.html.md +++ b/website/docs/backends/types/remote.html.md @@ -10,25 +10,33 @@ description: |- **Kind: Enhanced** -The remote backend stores state and runs operations remotely. When running -`terraform plan` or `terraform apply` with this backend, the actual execution -occurs in Terraform Enterprise, with log output streaming to the local terminal. - -To use this backend you need a Terraform Enterprise account on -[app.terraform.io](https://app.terraform.io) or have a private instance of +-> **Note:** We recommend using Terraform v0.11.13 or newer with this +backend. This backend requires either a Terraform Enterprise account on +[app.terraform.io](https://app.terraform.io) or a private instance of Terraform Enterprise (version v201809-1 or newer). +The remote backend stores state and runs operations in Terraform Enterprise. + +When used with a Pro or Premium tier Terraform Enterprise account, operations +like `terraform plan` or `terraform apply` are executed in Terraform +Enterprise's run environment, with log output streaming to the local terminal. +Remote plans and applies use variable values from the associated Terraform +Enterprise workspace. + +When used with a free Terraform Enterprise account, operations are executed on +the local machine and state is stored in Terraform Enterprise. + ## Command Support Currently the remote backend supports the following Terraform commands: - `apply` -- `console` +- `console` (supported in Terraform >= v0.11.12) - `destroy` (requires manually setting `CONFIRM_DESTROY=1` on the workspace) - `fmt` - `get` -- `graph` -- `import` +- `graph` (supported in Terraform >= v0.11.12) +- `import` (supported in Terraform >= v0.11.12) - `init` - `output` - `plan`