terraform/website/source/docs/configuration/atlas.html.md

1.6 KiB

layout page_title sidebar_current description
docs Configuring Atlas docs-config-atlas Atlas is the ideal way to use Terraform in a team environment. Atlas will run Terraform for you, safely handle parallelization across different team members, save run history along with plans, and more.

Atlas Configuration

Terraform can be configured to be able to upload to HashiCorp's Atlas. This configuration doesn't change the behavior of Terraform itself, it only configures your Terraform configuration to support being uploaded to Atlas via the push command.

For more information on the benefits of uploading your Terraform configuration to Atlas, please see the push command documentation.

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

Example

Atlas configuration looks like the following:

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

Description

The atlas block configures the settings when Terraform is pushed to Atlas. 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
}