GitBook: [#27] docs: clean-up formatting

This commit is contained in:
Scott Jungling
2021-10-18 22:00:07 +00:00
committed by gitbook-bot
parent dcc0edc304
commit dda65d2c3d

View File

@@ -8,7 +8,9 @@ Terraform Run Task enables your organization to integrate third-party tools with
A run task works by sending run-related information to an external third-party system. At that point, the external system evaluates the information and returns a passed or failed response back to Terraform Cloud. The status response, combined with the tasks enforcement setting, determines whether a run should proceed to the next stage of the workflow.
### Partners participating in the beta can add their feedback [here](https://go.hashi.co/terraform-run-tasks-feedback).
{% hint style="info" %}
Partners participating in the beta can add their feedback [here](https://go.hashi.co/terraform-run-tasks-feedback).
{% endhint %}
## Getting started with Run Task
@@ -30,43 +32,43 @@ Think of this like a static analyzer but with auto-remediation!
**Setting up the integration between Moderne and Terraform Cloud**
1. Sign up for the Moderne platform using the request form at [Moderne.io](https://moderne.io). To test the integration without connecting any of your own code to the Moderne platform, you can create a copy of the [terraform-random](https://github.com/moderneinc/terraform-random) project using the "Use this template" button in Github:
1\. Sign up for the Moderne platform using the request form at [Moderne.io](https://moderne.io). To test the integration without connecting any of your own code to the Moderne platform, you can create a copy of the [terraform-random](https://github.com/moderneinc/terraform-random) project using the "Use this template" button in Github:
![](../.gitbook/assets/image%20%287%29.png)
![](<../.gitbook/assets/image (7).png>)
2. Login to Terraform Cloud and go into the organization global settings.
2\. Login to Terraform Cloud and go into the organization global settings.
3. Navigate to Settings&gt;Task Event Hooks
3\. Navigate to Settings>Task Event Hooks
![](../.gitbook/assets/image%20%285%29.png)
![](<../.gitbook/assets/image (5).png>)
3. Create a new Task Event Hook for Moderne, pointing the URL to https://api.moderne.io/terraform-cloud.
3\. Create a new Task Event Hook for Moderne, pointing the URL to https://api.moderne.io/terraform-cloud.
![](../.gitbook/assets/image%20%283%29.png)
![](<../.gitbook/assets/image (3).png>)
The `requestedRecipe` query parameter allows you to control which recipe will run. The recipe id for this query parameter can be copied from the recipe detail of any Terraform recipe on the Moderne platform.
![](../.gitbook/assets/image%20%288%29.png)
![](<../.gitbook/assets/image (8).png>)
4. To connect this Task Event Hook to your workspace in Terraform Cloud, navigate to the
4\. To connect this Task Event Hook to your workspace in Terraform Cloud, navigate to the
workspace of choice.
![](../.gitbook/assets/image%20%282%29.png)
![](<../.gitbook/assets/image (2).png>)
4. Choose Tasks.
4\. Choose Tasks.
![](../.gitbook/assets/image%20%286%29.png)
![](<../.gitbook/assets/image (6).png>)
4. Choose an enforcement level.
4\. Choose an enforcement level.
o **Advisory**: tasks can not block a run from completing. If the task fails, a warning will be displayed on the run but it will proceed.
o **Mandatory**: tasks can block a run from completing. If the task fails \(including a timeout or unexpected remote error condition\), a warning will be displayed on the run and the run will transition to an Errored state.
o **Mandatory**: tasks can block a run from completing. If the task fails (including a timeout or unexpected remote error condition), a warning will be displayed on the run and the run will transition to an Errored state.
![](../.gitbook/assets/image%20%2810%29.png)
![](<../.gitbook/assets/image (10).png>)
Congratulations, your workspace is now set-up with your &lt;Partner&gt; Integration!
Congratulations, your workspace is now set-up with your \<Partner> Integration!\
## Runs
@@ -75,11 +77,9 @@ You should be able to complete the next scenarios as your org admin user or as a
When all tasks pass, a run should be applyable. Whether a task passes or fails, you will be provided with a details link that links to the Moderne platform to display the result of the recipe that the task ran.
![Two Moderne recipes ran as part of the Run Task run](../.gitbook/assets/image%20%289%29.png)
![Two Moderne recipes ran as part of the Run Task run](<../.gitbook/assets/image (9).png>)
When a task fails, you can expect to see a diff in the Moderne platform along with commit and PR links that help you immediately fix the underlying issue.
![](../.gitbook/assets/image%20%284%29.png)
![](<../.gitbook/assets/image (4).png>)