updated ent docs runs index page

This commit is contained in:
Chris Riley 2017-03-16 16:06:46 -07:00 committed by Seth Vargo
parent f01e5513bb
commit 8a2cfad427
No known key found for this signature in database
GPG Key ID: C921994F9C27E0FF
2 changed files with 19 additions and 15 deletions

View File

@ -8,7 +8,7 @@ description: |-
# Terraform Enterprise Features # Terraform Enterprise Features
[Terraform](https://terraform.io) is a tool for safely and [Terraform](https://www.hashicorp.com/products/terraform/) is a tool for safely and
efficiently changing infrastructure across providers. efficiently changing infrastructure across providers.
This is a list of features specific to Terraform Enterprise. This is a list of features specific to Terraform Enterprise.

View File

@ -1,54 +1,58 @@
--- ---
title: "About Terraform Runs in Atlas" layout: "docs"
page_title: "About Terraform Enterprise Runs"
sidebar_current: "docs-enterprise-runs"
description: |-
A "run" in Atlas represents the logical grouping of two Terraform steps - a "plan" and an "apply".
--- ---
# About Terraform Runs in Atlas # About Terraform Enterprise Runs
A "run" in Atlas represents the logical grouping of two Terraform steps - a A "run" represents the logical grouping of two Terraform steps - a
"plan" and an "apply". The distinction between these two phases of a Terraform "plan" and an "apply". The distinction between these two phases of a Terraform
run are documented below. run are documented below.
When a [new run is created](/help/terraform/runs/starting), Atlas automatically When a [new run is created](/docs/enterprise/runs/starting.html), Terraform Enterprise automatically
queues a Terraform plan. Because a plan does not change the state of queues a Terraform plan. Because a plan does not change the state of
infrastructure, it is safe to execute a plan multiple times without infrastructure, it is safe to execute a plan multiple times without
consequence. An apply executes the output of a plan and actively changes consequence. An apply executes the output of a plan and actively changes
infrastructure. To prevent race conditions, Atlas will only execute one infrastructure. To prevent race conditions, the platform will only execute one
plan/apply at a time (plans for validating GitHub Pull Requests are allowed to plan/apply at a time (plans for validating GitHub Pull Requests are allowed to
happen concurrently, as they do not modify state). You can read more about happen concurrently, as they do not modify state). You can read more about
Terraform plans and applies below. Terraform plans and applies below.
## Plan ## Plan
During the plan phase of a run, Atlas executes the command `terraform plan`. During the plan phase of a run, the command `terraform plan` is executed.
Terraform performs a refresh and then determines what actions are necessary to Terraform performs a refresh and then determines what actions are necessary to
reach the desired state specified in the Terraform configuration files. A reach the desired state specified in the Terraform configuration files. A
successful plan outputs an executable file that is securely stored in Atlas successful plan outputs an executable file that is securely stored in Atlas
and may be used in the subsequent apply. and may be used in the subsequent apply.
Terraform plans in Atlas do not change the state of infrastructure, so it is Terraform plans do not change the state of infrastructure, so it is
safe to execute a plan multiple times. In fact, there are a number of components safe to execute a plan multiple times. In fact, there are a number of components
in Atlas that can trigger a Terraform plan. You can read more about this in the that can trigger a Terraform plan. You can read more about this in the
[starting runs](/help/terraform/runs/starting) section. [starting runs](/help/terraform/runs/starting) section.
## Apply ## Apply
During the apply phase of a run, Atlas executes the command `terraform apply` During the apply phase of a run, the command `terraform apply` is executed
with the executable result of the prior Terraform plan. This phase **can change with the executable result of the prior Terraform plan. This phase **can change
infrastructure** by applying the changes required to reach the desired state infrastructure** by applying the changes required to reach the desired state
specified in the Terraform configuration file. specified in the Terraform configuration file.
While Terraform plans are safe to run multiple times, Terraform applies often While Terraform plans are safe to run multiple times, Terraform applies often
change active infrastructure. Because of this, the default behavior for Atlas change active infrastructure. Because of this, the default behavior
is to require user confirmation as part of the is to require user confirmation as part of the
[Terraform run execution](/help/terraform/runs/how-runs-execute). Upon [Terraform run execution](/docs/enterprise/runs/how-runs-execute.html). Upon
user confirmation, Atlas will queue and execute the Terraform apply. It is also user confirmation, Atlas will queue and execute the Terraform apply. It is also
possible to configure Atlas to possible to configure Atlas to
[automatically apply](/help/terraform/runs/automatic-applies), but this option is [automatically apply](/docs/enterprise/runs/automatic-applies.html), but this option is
disabled by default. disabled by default.
## Environment Locking ## Environment Locking
During run execution, Atlas will lock the environment to prevent other plans During run execution, the environment will lock to prevent other plans
and applies from executing simultaneously. When the run completes, the next and applies from executing simultaneously. When the run completes, the next
pending run, if any, will be started. pending run, if any, will be started.
@ -62,5 +66,5 @@ by visiting that environment's settings page.
To receive alerts when user confirmation is needed or for any other phase of the To receive alerts when user confirmation is needed or for any other phase of the
run process, you can run process, you can
[enable run notifications](/help/terraform/runs/notifications) for your [enable run notifications](/docs/enterprise/runs/notifications.html) for your
organization or environment. organization or environment.