terraform/website/source/docs/providers/terraform-enterprise/index.html.markdown

51 lines
1.7 KiB
Markdown
Raw Normal View History

2017-03-23 20:28:10 +01:00
---
2017-04-07 06:14:57 +02:00
layout: "terraform-enterprise"
2017-03-23 20:28:10 +01:00
page_title: "Provider: Terraform Enterprise"
2017-04-07 06:14:57 +02:00
sidebar_current: "docs-terraform-enterprise-index"
2017-03-23 20:28:10 +01:00
description: |-
The Terraform Enterprise provider is used to interact with configuration,
artifacts, and metadata managed by the Terraform Enterprise service.
---
# Terraform Enterprise Provider
2017-04-07 17:36:49 +02:00
The Terraform Enterprise provider is used to interact with resources,
configuration, artifacts, and metadata managed by
[Terraform Enterprise](https://www.terraform.io/docs/providers/index.html).
The provider needs to be configured with the proper credentials before it can
be used.
2017-03-23 20:28:10 +01:00
Use the navigation to the left to read about the available resources.
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-03-23 20:28:10 +01:00
## Example Usage
2017-04-07 17:36:49 +02:00
```hcl
# Configure the Terraform Enterprise provider
2017-03-23 20:28:10 +01:00
provider "atlas" {
token = "${var.atlas_token}"
}
# Fetch an artifact configuration
data "atlas_artifact" "web" {
# ...
}
```
## Argument Reference
The following arguments are supported:
2017-04-07 17:36:49 +02:00
* `address` - (Optional) Terraform Enterprise server endpoint. Defaults to
public Terraform Enterprise. This is only required when using an on-premise
deployment of Terraform Enterprise. This can also be specified with the
`ATLAS_ADDRESS` shell environment variable.
2017-03-23 20:28:10 +01:00
* `token` - (Required) API token. This can also be specified with the
`ATLAS_TOKEN` shell environment variable.