Skip to content

Commit 05fc5e0

Browse files
committed
Add Terraform Enterprise Documentation
1 parent 9ffd62b commit 05fc5e0

File tree

1 file changed

+100
-1
lines changed

1 file changed

+100
-1
lines changed

managing_providers/_topics/automation_management_providers.md

Lines changed: 100 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ In {{ site.data.product.title_short }}, an automation management provider is a m
1212

1313
**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.
1414

15+
**Terraform Enterprise** is an application that helps teams use Terraform together. It manages Terraform runs in a consistent and reliable environment.
16+
1517
{% include_relative _topics/embedded_workflows.md %}
1618

1719
## Ansible
@@ -573,4 +575,101 @@ Use the following steps to set a retirement day and time for a service instance:
573575
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.
574576

575577
5. Select a **Retirement Warning** if needed.
576-
6. Click **Save**.
578+
6. Click **Save**.
579+
580+
## Terraform Enterprise
581+
582+
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.
583+
584+
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.
585+
586+
### Adding a Terraform Enterprise Provider
587+
588+
In order to integrate with Terraform Enterprise you must first add it as a provider.
589+
590+
1. Browse to menu: **Automation > Providers** and under **Configuration**, click ![Add a new Provider](../images/1862.png) **Add a new Provider**.
591+
592+
2. Select **Terraform Enterprise** as the **Type**
593+
594+
3. Enter a **Name** for the new provider.
595+
596+
4. Add a **Zone** for the provider.
597+
598+
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`
599+
600+
6. Select the appropriate **SSL Verification** option
601+
602+
7. Add the API Token that you would like to use in the **API Token** section.
603+
604+
8. Click **Validate** to verify credentials.
605+
606+
9. Click **Add**.
607+
608+
### Viewing Terraform Enterprise Workspaces
609+
610+
Workspaces represent infrastructure managed by Terraform. They are collected in inventory as Automation Templates (Configuration Scripts) in {{ site.data.product.title_short }}
611+
612+
1. Browse to menu: **Automation > Templates** to display a list of Terraform Enterprise Workspaces.
613+
614+
2. Select a specific Terraform Enterprise Workspace to view additional details.
615+
616+
### Viewing Terraform Enterprise Runs
617+
618+
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 }}:
619+
620+
1. Browse to menu: **Automation > Jobs** to display a list of Terraform Enterprise runs.
621+
622+
2. Select a specific Terraform Enterprise Run to view additional details.
623+
624+
625+
### Execute a Terraform Enterprise Workspace from a Service Catalog
626+
627+
You can plan and apply a Terraform Enterprise Workspace from {{ site.data.product.title_short }} by creating a service catalog item.
628+
629+
First, create a catalog:
630+
631+
1. Browse to menu: **Services > Catalogs** and click **Catalog Items**.
632+
633+
2. Click **Configuration**, then ![Add a New Catalog](../images/1862.png) (**Add a New Catalog**)
634+
635+
3. Enter a **Name** and **Description** for the catalog.
636+
637+
4. Click **Add**.
638+
639+
Next create a Terraform Enterprise Service Catalog Item:
640+
641+
1. Browse to menu: **Services > Catalogs** and click **Catalog Items**.
642+
643+
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:
644+
645+
- For **Catalog Item type**, select **Terraform Enterprise**.
646+
647+
- Enter a **Name** for the service catalog item.
648+
649+
- Select **Display in Catalog**.
650+
651+
- In **Catalog**, select the catalog you created previously.
652+
653+
- 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.
654+
655+
- 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.
656+
657+
- Add configuration information for **Reconfigure Entry Point** and **Retirement Entry Point** as applicable.
658+
659+
- Select your desired **Terraform Template** from the list.
660+
661+
3. Click **Add**. The catalog item you created will appear in the **All Service Catalog Items** list.
662+
663+
To execute the Terraform Enterprise job:
664+
665+
1. Browse to menu: **Service > Catalogs** and click on **Service Catalogs** then click **Terraform Enterprise catalog**.
666+
667+
![order at catalog item](../images/order_at_catalog_item.png)
668+
669+
2. Click **Order** for the catalog item.
670+
671+
3. Enter any variables requested and click **Submit**.
672+
673+
{{ site.data.product.title_short }} takes you to the **Requests** queue page and show the status of the job.
674+
675+
The service item’s details can be viewed in menu: **Services > My Services** in {{ site.data.product.title_short }}.

0 commit comments

Comments
 (0)