From 8a2cfad42785c2179a1af1a8662cf10ac1704813 Mon Sep 17 00:00:00 2001 From: Chris Riley Date: Thu, 16 Mar 2017 16:06:46 -0700 Subject: [PATCH] updated ent docs runs index page --- website/source/docs/enterprise/index.html.md | 2 +- .../source/docs/enterprise/runs/index.html.md | 32 +++++++++++-------- 2 files changed, 19 insertions(+), 15 deletions(-) diff --git a/website/source/docs/enterprise/index.html.md b/website/source/docs/enterprise/index.html.md index 0b58a196f..3b52907a4 100755 --- a/website/source/docs/enterprise/index.html.md +++ b/website/source/docs/enterprise/index.html.md @@ -8,7 +8,7 @@ description: |- # 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. This is a list of features specific to Terraform Enterprise. diff --git a/website/source/docs/enterprise/runs/index.html.md b/website/source/docs/enterprise/runs/index.html.md index 4882ebae9..d9cf178d0 100755 --- a/website/source/docs/enterprise/runs/index.html.md +++ b/website/source/docs/enterprise/runs/index.html.md @@ -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 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 infrastructure, it is safe to execute a plan multiple times without 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 happen concurrently, as they do not modify state). You can read more about Terraform plans and applies below. ## 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 reach the desired state specified in the Terraform configuration files. A successful plan outputs an executable file that is securely stored in Atlas 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 -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. ## 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 infrastructure** by applying the changes required to reach the desired state specified in the Terraform configuration file. 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 -[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 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. ## 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 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 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.