Skip to content

Commit 55bf491

Browse files
committed
{wip} update run task timeout
1 parent e48ca50 commit 55bf491

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,12 @@ The POST request submits the following properties as the request headers.
135135

136136
## Run Task Callback
137137

138-
While a run task runs, it may send progressive updates to HCP Terraform with a `running` status. Once an integrator determines that Terraform supports detailed run task outcomes, they can send these outcomes by appending to the run task's callback payload.
138+
While a run task runs, it should send progressive updates to HCP Terraform with a `running` status.
139+
Once an integrator determines that Terraform supports detailed run task outcomes, they can send these outcomes by appending to the run task's callback payload.
139140

140-
Once the external integration fulfills the request, that integration must call back into HCP Terraform with the overall result of either `passed` or `failed`. Terraform expects this callback within 10 minutes, or the request is considered errored.
141+
-> **Note:** HCP Terraform will consider the request as errored if it has not received a progress update in the last 10 minutes, or the request has been running for over 60 minutes.
141142

143+
Once the external integration fulfills the request, that integration must call back into HCP Terraform with the overall result of either `passed` or `failed`.
142144
You can send outcomes with a status of `running`, `passed`, or `failed`, but it is a good practice only to send outcomes when a run task is `running`.
143145

144146
`PATCH :callback_url`

content/terraform-docs-common/docs/cloud-docs/integrations/run-tasks/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ Once your server receives this payload, HCP Terraform expects you to callback to
7777
}
7878
```
7979

80-
HCP Terraform expects this callback within 10 minutes, or the task will be considered to have `errored`. The supplied message attribute will be displayed in HCP Terraform on the run details page. The status can be `running`, `passed` or `failed`.
80+
HCP Terraform will consider the request as errored if it has not received a progress callback in the last 10 minutes, or the task has been running for over 60 minutes.
81+
The supplied message attribute will be displayed in HCP Terraform on the run details page. The status can be `running`, `passed` or `failed`.
8182

8283
Here's what the data flow looks like:
8384

0 commit comments

Comments
 (0)