Merge pull request #1847 from agrare/add_terraform_enterprise_documentation

Add Terraform Enterprise Documentation

Author: Fryguy

managing_providers/_topics/automation_management_providers.md

@@ -12,6 +12,8 @@ In {{ site.data.product.title_short }}, an automation management provider is a m
 
 **Ansible Tower** is a management tool that is integrated with {{ site.data.product.title_short }}, designed to help automate infrastructure operations utlizizing existing Ansible Tower providers in your inventory. {{ site.data.product.title_short }} allows you to execute Ansible Tower jobs by using service catalogs and Automate. Using Ansible Tower, you can schedule Ansible playbook runs and monitor current and historical results, allowing for troubleshooting or identification of issues before they occur.
 
+**Terraform Enterprise** is an application that helps teams use Terraform together. It manages Terraform runs in a consistent and reliable environment.
+
 {% include_relative _topics/embedded_workflows.md %}
 
 ## Ansible
@@ -222,7 +224,7 @@ You can execute an Ansible Tower playbook from {{ site.data.product.title_short
 
 First, create a catalog:
 
-1. Browse to menu: **Services > Catalogs** and click **Catalog Items**.
+1. Browse to menu: **Services > Catalogs** and click **Catalogs**.
 
 2. Click **Configuration**, then ![Add a New Catalog](../images/1862.png) (**Add a New Catalog**)
 
@@ -573,4 +575,101 @@ Use the following steps to set a retirement day and time for a service instance:
       1. From **Time Delay**, specify a retirement time in the form of the number of months, weeks, days, or hours in the using the arrows.
 
 5. Select a **Retirement Warning** if needed.
-6. Click **Save**.
+6. Click **Save**.
+
+## Terraform Enterprise
+
+Terraform Enterprise (also known as HCP Terraform) is an application that helps teams use Terraform together. It manages Terraform runs in a consistent and reliable environment, and includes easy access to shared state and secret data, access controls for approving changes to infrastructure, a private registry for sharing Terraform modules, detailed policy controls for governing the contents of Terraform configurations, and more.
+
+HCP Terraform can be added to {{ site.data.product.title_short }} and Workspaces can be collected and used in the {{ site.data.product.title_short }} Service Catalog.
+
+### Adding a Terraform Enterprise Provider
+
+In order to integrate with Terraform Enterprise you must first add it as a provider.
+
+1. Browse to menu: **Automation > Providers** and under **Configuration**, click ![Add a new Provider](../images/1862.png) **Add a new Provider**.
+
+2. Select **Terraform Enterprise** as the **Type**
+
+3. Enter a **Name** for the new provider.
+
+4. Add a **Zone** for the provider.
+
+5. If you are using Terraform Enterprise enter the URL of your Terraform Enterprise self-hosted instance.  If you are using HCP Terraform then leave the URL as `https://app.terraform.io`
+
+6. Select the appropriate **SSL Verification** option
+
+7. Add the API Token that you would like to use in the **API Token** section.
+
+8. Click **Validate** to verify credentials.
+
+9. Click **Add**.
+
+### Viewing Terraform Enterprise Workspaces
+
+Workspaces represent infrastructure managed by Terraform.  They are collected in inventory as Automation Templates (Configuration Scripts) in {{ site.data.product.title_short }}
+
+1. Browse to menu: **Automation > Templates** to display a list of Terraform Enterprise Workspaces.
+
+2. Select a specific Terraform Enterprise Workspace to view additional details.
+
+### Viewing Terraform Enterprise Runs
+
+A run performs a plan and apply, using a configuration version and the workspace’s current variables.  To view runs in {{ site.data.product.title_short }}:
+
+1. Browse to menu: **Automation > Jobs** to display a list of Terraform Enterprise runs.
+
+2. Select a specific Terraform Enterprise Run to view additional details.
+
+
+### Execute a Terraform Enterprise Workspace from a Service Catalog
+
+You can plan and apply a Terraform Enterprise Workspace from {{ site.data.product.title_short }} by creating a service catalog item.
+
+First, create a catalog:
+
+1. Browse to menu: **Services > Catalogs** and click **Catalogs**.
+
+2. Click **Configuration**, then ![Add a New Catalog](../images/1862.png) (**Add a New Catalog**)
+
+3. Enter a **Name** and **Description** for the catalog.
+
+4. Click **Add**.
+
+Next create a Terraform Enterprise Service Catalog Item:
+
+1. Browse to menu: **Services > Catalogs** and click **Catalog Items**.
+
+2. Click **Configuration**, then ![Add a New Catalog Item](../images/1862.png) (**Add a New Catalog Item**) to create a new catalog item with the following details, at minimum:
+
+   - For **Catalog Item type**, select **Terraform Enterprise**.
+
+   - Enter a **Name** for the service catalog item.
+
+   - Select **Display in Catalog**.
+
+   - In **Catalog**, select the catalog you created previously.
+
+   - In **Dialog**, select a service dialog you created previously.  To ask the user to enter extra information when running the task, **Service Dialog** must be selected. A dialog is required if **Display in Catalog** is chosen.
+
+   - In **Provider**, select your Terraform Enterprise provider. This brings up the **Terraform Template** option where you can select which Terraform Workspace you want to use.
+
+   - Add configuration information for **Reconfigure Entry Point** and **Retirement Entry Point** as applicable.
+
+   - Select your desired **Terraform Template** from the list.
+
+3. Click **Add**. The catalog item you created will appear in the **All Service Catalog Items** list.
+
+To execute the Terraform Enterprise job:
+
+1. Browse to menu: **Service > Catalogs** and click on **Service Catalogs** then click **Terraform Enterprise catalog**.
+
+   ![order at catalog item](../images/order_at_catalog_item.png)
+
+2. Click **Order** for the catalog item.
+
+3. Enter any variables requested and click **Submit**.
+
+{{ site.data.product.title_short }} takes you to the **Requests** queue page and show the status of the job.
+
+The service item’s details can be viewed in menu: **Services > My Services** in {{ site.data.product.title_short }}.

managing_providers/automation_providers/ansible_tower_providers.md

@@ -0,0 +1,4 @@
+---
+---
+
+# Ansible Automation Platform Providers

managing_providers/automation_providers/embedded_ansible_providers.md

@@ -0,0 +1,94 @@
+---
+---
+
+# Embedded Ansible Providers
+
+Ansible integrates with {{ site.data.product.title_short }} to provide automation solutions, using playbooks, for Service, Policy and Alert actions. Ansible playbooks consist of series of *plays* or tasks that define automation across a set of hosts, which is known as the inventory.
+
+Ranging from simple to complex tasks, Ansible playbooks can support cloud management:
+
+- **Services** - allow a playbook to back a {{ site.data.product.title_short }} service catalog item.
+
+- **Control Actions** - {{ site.data.product.title_short }} policies can execute playbooks as actions based on events from providers.
+
+- **Control Alerts** - set a playbook to launch prompted by a {{ site.data.product.title_short }} alert.
+
+Ansible is built into {{ site.data.product.title_short }} so there is nothing to install. The basic workflow when using Ansible in {{ site.data.product.title_short }} is as follows:
+
+1. Enable the **Embedded Ansible** server role.
+
+2. Add a source control repository that contains your playbooks.
+
+3. Establish credentials with your inventory.
+
+4. Back your services, alerts, and policies using available playbooks.
+
+### Enabling the Embedded Ansible Server Role
+
+In {{ site.data.product.title_short }}, the **Embedded Ansible** role is disabled by default. Enable this server role to utilize Ansible Automation Inside.
+
+**Note:** Configure your {{ site.data.product.title_short }} appliance network identity (hostname/IP address) before enabling the Embedded Ansible server role. Restart the `evmserverd` service on the appliance with the enabled Embedded Ansible server role after making any changes to the hostname or IP address.
+
+1. Browse to the settings menu, then **Configuration > Settings**.
+
+2. Select the desired server under **Zones**.
+
+3. Set the **Server Role** for **Embedded Ansible** to **On**.
+
+### Verifying the Embedded Ansible Worker State
+
+Verify that the Embedded Ansible worker has started to utilize its features.
+
+1. Browse to the settings menu, then **Configuration > Diagnostics** and click on the desired server.
+
+2. Click on the **Roles by Servers** tab.
+
+A table of all workers and current status will appear from which you can confirm the state of your embedded Ansible worker.
+
+### Adding a Playbook Repository
+
+Add a repository so that {{ site.data.product.title_short }} can discover and make available your playbooks.
+
+1. Browse to menu: **Automation > Ansible > Repositories**.
+
+2. Click **Configuration**, then ![Add New Repository](../images/1862.png) (**Add New Repository**).
+
+3. Provide a Repository Name in the **Name** field.
+
+4. Add a description for the repository in the **Description** field.
+
+5. Add a **URL** or IP Address for the repository.
+
+6. Select the appropriate **SCM Credentials** from the drop-down menu.
+
+7. Provide a branch name in the **SCM Branch** field.
+
+8. Click **Save**.
+
+Once you have synced a repository, its playbooks will become available to {{ site.data.product.title_short }}.
+
+### Refreshing Repositories
+
+{{ site.data.product.title_short }} allows you to refresh a targeted playbook repository or all repositories in your inventory to ensure your playbooks are current.
+
+Refresh a targeted repository:
+
+1. Browse to menu: **Automation > Ansible > Repositories**.
+
+2. Click on a repository.
+
+3. Click **Configuration**, then ![Refresh this Repository](../images/2003.png) (**Refresh this Repository**).
+
+Alternately, you can refresh some or all repositories from the list view:
+
+1. Browse to menu: **Automation > Ansible > Repositories**.
+
+2. Check those repositories to refresh. Click **Check All** to select all repositories.
+
+3. Click **Configuration**, then ![Refresh Selected Ansible Repositories](../images/2003.png) (**Refresh Selected Ansible Repositories**).
+
+{% include_relative _topics/ansible_credentials.md %}
+
+{% include_relative _topics/tagging_ansible_elements.md %}
+
+{% include_relative _topics/optimizing_playbooks.md %}