terraform/website/docs/backends/types/terraform-enterprise.html.md

69 lines
2.3 KiB
Markdown
Raw Normal View History

2017-02-15 19:47:30 +01:00
---
2017-02-15 21:19:38 +01:00
layout: "backend-types"
2017-03-23 20:28:10 +01:00
page_title: "Backend Type: terraform enterprise"
2017-04-07 06:14:57 +02:00
sidebar_current: "docs-backends-types-standard-terraform-enterprise"
2017-02-15 19:47:30 +01:00
description: |-
Terraform can store its state in Terraform Enterprise
2017-02-15 19:47:30 +01:00
---
2017-03-23 20:28:10 +01:00
# terraform enterprise
2017-02-15 19:47:30 +01:00
!> **The `atlas` backend is deprecated.** Please use the new enhanced
[remote](/docs/backends/types/remote.html) backend for storing state and running
remote operations in Terraform Cloud.
2017-02-15 21:19:38 +01:00
**Kind: Standard (with no locking)**
Reads and writes state from a [Terraform Enterprise](/docs/cloud/index.html)
workspace.
2017-02-15 19:47:30 +01:00
-> **Why is this called "atlas"?** Before it was a standalone offering,
Terraform Enterprise was part of an integrated suite of enterprise products
called Atlas. This backend predates the current version Terraform Enterprise, so
it uses the old name.
2017-02-15 19:47:30 +01:00
We no longer recommend using this backend, as it does not support collaboration
features like [workspace
locking](/docs/cloud/run/index.html). Please use the new enhanced
[remote](/docs/backends/types/remote.html) backend for storing state and running
remote operations in Terraform Cloud.
2017-04-07 17:36:49 +02:00
2017-02-15 21:19:38 +01:00
## Example Configuration
2017-02-15 19:47:30 +01:00
```hcl
2017-02-15 21:19:38 +01:00
terraform {
backend "atlas" {
name = "example_corp/networking-prod"
address = "https://app.terraform.io" # optional
2017-02-15 21:19:38 +01:00
}
}
2017-02-15 19:47:30 +01:00
```
We recommend using a [partial configuration](/docs/backends/config.html) and
omitting the access token, which can be provided as an environment variable.
2017-02-15 21:19:38 +01:00
2017-02-15 19:47:30 +01:00
## Example Referencing
```hcl
2017-02-15 19:47:30 +01:00
data "terraform_remote_state" "foo" {
backend = "atlas"
config = {
name = "example_corp/networking-prod"
}
2017-02-15 19:47:30 +01:00
}
```
## Configuration variables
The following configuration options / environment variables are supported:
* `name` - (Required) Full name of the workspace (`<ORGANIZATION>/<WORKSPACE>`).
* `ATLAS_TOKEN`/ `access_token` - (Optional) A Terraform Enterprise [user API
token](/docs/cloud/users-teams-organizations/users.html#api-tokens). We
recommend using the `ATLAS_TOKEN` environment variable rather than setting
`access_token` in the configuration. If not set, the token will be requested
during a `terraform init` and saved locally.
* `address` - (Optional) The URL of a Terraform Enterprise instance. Defaults to
the SaaS version of Terraform Enterprise, at `"https://app.terraform.io"`; if
you use a private install, provide its URL here.