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

55 lines
1.7 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: |-
2017-03-23 20:28:10 +01:00
Terraform can store the 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
2017-02-15 21:19:38 +01:00
**Kind: Standard (with no locking)**
2017-03-23 20:28:10 +01:00
Stores the state in [Terraform Enterprise](https://www.terraform.io/docs/providers/index.html).
2017-02-15 19:47:30 +01:00
You can create a new workspace in the
Workspaces section and generate new token in the Tokens page under Settings.
2017-02-15 19:47:30 +01:00
2017-04-07 17:36:49 +02:00
~> **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.
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 = "bigbang/example"
}
}
2017-02-15 19:47:30 +01:00
```
2017-02-15 21:19:38 +01:00
Note that for the access token we recommend using a
[partial configuration](/docs/backends/config.html).
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 = "bigbang/example"
}
2017-02-15 19:47:30 +01:00
}
```
## Configuration variables
The following configuration options / environment variables are supported:
* `name` - (Required) Full name of the environment (`<username>/<name>`)
* `ATLAS_TOKEN`/ `access_token` - (Required) Terraform Enterprise API token. It is recommended that `ATLAS_TOKEN` is set as an environment variable rather than using `access_token` in the configuration.
2017-03-23 20:28:10 +01:00
* `address` - (Optional) Address to alternative Terraform Enterprise location (Terraform Enterprise endpoint)