terraform/website/source/docs/backends/types/atlas.html.md

53 lines
1.2 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"
page_title: "Backend Type: atlas"
sidebar_current: "docs-backends-types-standard-atlas"
2017-02-15 19:47:30 +01:00
description: |-
2017-02-15 21:19:38 +01:00
Terraform can store the state in Atlas.
2017-02-15 19:47:30 +01:00
---
# atlas
2017-02-15 21:19:38 +01:00
**Kind: Standard (with no locking)**
2017-02-15 19:47:30 +01:00
Stores the state in [Atlas](https://atlas.hashicorp.com/).
2017-02-15 21:19:38 +01:00
You can create a new environment in the
[Environments section](https://atlas.hashicorp.com/environments)
and generate new token in the
[Tokens page](https://atlas.hashicorp.com/settings/tokens) under Settings.
2017-02-15 19:47:30 +01:00
2017-02-15 21:19:38 +01:00
## Example Configuration
2017-02-15 19:47:30 +01:00
```
2017-02-15 21:19:38 +01:00
terraform {
backend "atlas" {
name = "bigbang/example"
access_token = "foo"
}
}
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
```
data "terraform_remote_state" "foo" {
backend = "atlas"
config {
name = "bigbang/example"
access_token = "X2iTFefU5aWOjg.atlasv1.YaDa"
}
}
```
## Configuration variables
The following configuration options / environment variables are supported:
* `name` - (Required) Full name of the environment (`<username>/<name>`)
* `access_token` / `ATLAS_TOKEN` - (Required) Atlas API token
* `address` - (Optional) Address to alternative Atlas location (Atlas Enterprise endpoint)