opentofu/website/docs/configuration/terraform-enterprise.html.md
Nick Fagerlund 66ff8f8bed website: Deprecation notes about "terraform push"
Also:

- In the getting started guide, the TFE content was all tailored to the older
  run-locally workflow. I've replaced it with some brief explanation and a link
  to the dedicated TFE getting started guide.
- Fixed a sidebar link glitch in the configuration section. (Both "Terraform"
  and "Terraform Enterprise" were marked as active if you were on the TFE page.)
- Renamed the "Terraform Enterprise" page "Terraform Push." (Some people have
  gotten confused and landed on this page when trying to set up the `atlas`
  remote backend.)
2018-02-27 14:48:04 -08:00

2.4 KiB

layout page_title sidebar_current description
docs Configuring Terraform Push docs-config-push Terraform's push command was a way to interact with the legacy version of Terraform Enterprise. It is not supported in the current version of Terraform Enterprise.

Terraform Push Configuration

~> Important: The terraform push command is deprecated, and only works with the legacy version of Terraform Enterprise. In the current version of Terraform Enterprise, you can upload configurations using the API. See the docs about API-driven runs for more details.

The terraform push command uploads a configuration to a Terraform Enterprise (legacy) environment. The name of the environment (and the organization it's in) can be specified on the command line, or as part of the Terraform configuration in an atlas block.

The atlas block does not configure remote state; it only configures the push command. For remote state, use a terraform { backend "<NAME>" {...} } block.

This page assumes you're familiar with the configuration syntax already.

Example

Terraform push configuration looks like the following:

atlas {
  name = "mitchellh/production-example"
}

~> Why is this called "atlas"? Atlas was previously a commercial offering from HashiCorp that included a full suite of enterprise products. The products have since been broken apart into their individual products, like Terraform Enterprise. While this transition is in progress, you may see references to "atlas" in the documentation. We apologize for the inconvenience.

Description

The atlas block configures the settings when Terraform is pushed to Terraform Enterprise. Only one atlas block is allowed.

Within the block (the { }) is configuration for Atlas uploading. No keys are required, but the key typically set is name.

No value within the atlas block can use interpolations. Due to the nature of this configuration, interpolations are not possible. If you want to parameterize these settings, use the Atlas block to set defaults, then use the command-line flags of the push command to override.

Syntax

The full syntax is:

atlas {
  name = VALUE
}