Skip to content

Commit eb20e48

Browse files
committed
Small updates for exclusions
1 parent 31c52d6 commit eb20e48

File tree

8 files changed

+7
-10
lines changed

8 files changed

+7
-10
lines changed

content/terraform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-task-stages-and-results.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ description: >-
1818

1919
# Run task stages and results API reference
2020

21-
HCP Terraform uses run task stages and run task results to track [run task](/terraform/cloud-docs/workspaces/settings/run-tasks) execution.
21+
HCP Terraform uses run task stages and run task results to track workspace [run task](/terraform/cloud-docs/workspaces/settings/run-tasks) execution.
2222

2323
<!-- BEGIN: TFC:only name:pnp-callout -->
2424
@include 'tfc-package-callouts/run-tasks.mdx'

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ description: >-
1414

1515
# Run tasks integration API
1616

17-
[Run tasks](/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle.
17+
[Run tasks](/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the workspace run lifecycle.
1818
This page lists the API endpoints used to trigger a run task and the expected response from the integration.
1919

2020
<!-- BEGIN: TFC:only name:pnp-callout -->

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ description: >-
4040

4141
# Run tasks API reference
4242

43-
[Run tasks](/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can associate to any workspace in an organization. This page lists the API endpoints for run tasks in an organization and explains how to associate run tasks to workspaces.
43+
[Run tasks](/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform workspaces interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can associate to any workspace in an organization. This page lists the API endpoints for run tasks in an organization and explains how to associate run tasks to workspaces.
4444

4545
<!-- BEGIN: TFC:only name:pnp-callout -->
4646
@include 'tfc-package-callouts/run-tasks.mdx'

content/terraform-docs-common/docs/cloud-docs/api-docs/state-version-outputs.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ description: >-
1717
State version outputs are the [output values](/terraform/language/values/outputs) from a Terraform state file for a workspace. They include
1818
the name and value of the output, as well as a sensitive boolean if the value should be hidden by default in UIs.
1919

20-
<!-- BEGIN: TFC:only name:stacks-tfe --> If you are using a Stack and want to interact with the state of a deployment, refer to [deployment state API](#TODO). <!-- END: TFC:only name:stacks-tfe -->
21-
2220
~> **Important:** The state version outputs for a state version (as well as some other information about it) might be **populated asynchronously** by HCP Terraform. These values might not be immediately available after the state version is uploaded. The `resources-processed` property on the associated [state version object](/terraform/cloud-docs/api-docs/state-versions) indicates whether or not HCP Terraform has finished any necessary asynchronous processing. If you need to use these values, be sure to wait for `resources-processed` to become `true` before assuming that the values are in fact empty.
2321

2422
## List State Version Outputs

content/terraform-docs-common/docs/cloud-docs/api-docs/state-versions.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ description: >-
4141
## Attributes
4242

4343
State version API objects represent an instance of Terraform state data for a workspace, but do not directly contain the stored state. Instead, they contain information about the state, its properties, and its contents, and include one or more URLs from which the state can be downloaded.
44-
<!-- BEGIN: TFC:only name:stacks-tfe --> If you are using a Stack and want to interact with the state of a deployment, refer to [deployment state API](#TODO). <!-- END: TFC:only name:stacks-tfe -->
4544

4645
Some of the information returned in a state version API object might be **populated asynchronously** by HCP Terraform. This includes resources, modules, providers, and the [state version outputs](/terraform/cloud-docs/api-docs/state-version-outputs) associated with the state version. These values might not be immediately available after the state version is uploaded. The `resources-processed` property on the state version object indicates whether or not HCP Terraform has finished any necessary asynchronous processing. If you need to use these values, be sure to wait for `resources-processed` to become `true` before assuming that the values are in fact empty.
4746

content/terraform-docs-common/docs/cloud-docs/api-docs/variable-sets.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: >-
66

77
# Variable sets API reference
88

9-
A [variable set](/terraform/cloud-docs/variables#scope) is a resource that allows you to reuse the same variables across multiple workspaces<!-- BEGIN: TFC:only name:stacks-tfe -->, Stacks, <!-- END: TFC:only name:stacks-tfe --> and projects. For example, you could define a variable set of provider credentials and automatically apply it to a selection of workspaces, all workspaces in a project,<!-- BEGIN: TFC:only name:stacks-tfe --> all Stacks in a project,<!-- END: TFC:only name:stacks-tfe --> or all workspaces in an organization.
9+
A [variable set](/terraform/cloud-docs/variables#scope) is a resource that allows you to reuse the same variables across multiple workspaces<!-- BEGIN: TFC:only name:stacks-tfe -->, Stacks,<!-- END: TFC:only name:stacks-tfe --> and projects. For example, you could define a variable set of provider credentials and automatically apply it to a selection of workspaces, all workspaces in a project,<!-- BEGIN: TFC:only name:stacks-tfe --> all Stacks in a project,<!-- END: TFC:only name:stacks-tfe -->or all workspaces in an organization.
1010

1111
Projects and organizations can both own variable sets. The owner of a variable set can determine the precedence of that set. Refer to [**Manage variable sets**](/terraform/cloud-docs/variables/managing-variables#permissions) for more details on variable set permissions.
1212

content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ By supplying the necessary attributes under a `vcs-repository` object, you can c
116116
| `data.attributes.name` | string | none | The name of the workspace. Workspace names can only include letters, numbers, `-`, and `_`. The name a unique identifier n the organization. |
117117
| `data.attributes.agent-pool-id` | string | none | Required when `execution-mode` is set to `agent`. The ID of the agent pool belonging to the workspace's organization. This value must not be specified if `execution-mode` is set to `remote` or `local` or if `operations` is set to `true`. |
118118
| `data.attributes.allow-destroy-plan` | boolean | `true` | Whether destroy plans can be queued on the workspace. |
119-
| `data.attributes.assessments-enabled` | boolean | `false` | (previously `drift-detection`) Whether or not HCP Terraform performs health assessments for the workspace. May be overridden by the organization setting `assessments-enforced`. Only available for Plus tier organizations, in workspaces running Terraform version 0.15.4+ and operating in [Remote execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode). |
119+
| `data.attributes.assessments-enabled` | boolean | `false` | (previously `drift-detection`) Whether or not HCP Terraform performs health assessments for the workspace. May be overridden by the organization setting `assessments-enforced`. Only available for Standard tier organizations, in workspaces running Terraform version 0.15.4+ and operating in [Remote execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode). |
120120
| `data.attributes.auto-apply` | boolean | `false` | Whether to automatically apply changes when a Terraform plan is successful in runs initiated by VCS, UI or CLI, [with some exceptions](/terraform/cloud-docs/workspaces/settings#auto-apply-and-manual-apply). |
121121
| `data.attributes.auto-apply-run-trigger` | boolean | `false` | Whether to automatically apply changes when a Terraform plan is successful in runs initiated by run triggers. |
122122
| `data.attributes.auto-destroy-at` | string | (nothing) | Timestamp when the next scheduled destroy run will occur, refer to [Scheduled Destroy](/terraform/cloud-docs/workspaces/settings/deletion#automatically-destroy). |
@@ -538,7 +538,7 @@ Properties without a default value are required.
538538
| `data.attributes.name` | string | (previous value) | A new name for the workspace, which can only include letters, numbers, `-`, and `_`. This will be used as an identifier and must be unique in the organization. **Warning:** Changing a workspace's name changes its URL in the API and UI. |
539539
| `data.attributes.agent-pool-id` | string | (previous value) | Required when `execution-mode` is set to `agent`. The ID of the agent pool belonging to the workspace's organization. This value must not be specified if `execution-mode` is set to `remote` or `local` or if `operations` is set to `true`. |
540540
| `data.attributes.allow-destroy-plan` | boolean | (previous value) | Whether destroy plans can be queued on the workspace. |
541-
| `data.attributes.assessments-enabled` | boolean | `false` | (previously `drift-detection`) Whether or not HCP Terraform performs health assessments for the workspace. May be overridden by the organization setting `assessments-enforced`. Only available for Plus tier organizations, in workspaces running Terraform version 0.15.4+ and operating in [Remote execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode). |
541+
| `data.attributes.assessments-enabled` | boolean | `false` | (previously `drift-detection`) Whether or not HCP Terraform performs health assessments for the workspace. May be overridden by the organization setting `assessments-enforced`. Only available for Standard tier organizations, in workspaces running Terraform version 0.15.4+ and operating in [Remote execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode). |
542542
| `data.attributes.auto-apply` | boolean | (previous value) | Whether to automatically apply changes when a Terraform plan is successful in runs initiated by VCS, UI or CLI, [with some exceptions](/terraform/cloud-docs/workspaces/settings#auto-apply-and-manual-apply). |
543543
| `data.attributes.auto-apply-run-trigger` | boolean | (previous value) | Whether to automatically apply changes when a Terraform plan is successful in runs initiated by run triggers. |
544544
| `data.attributes.auto-destroy-at` | string | (previous value) | Timestamp when the next scheduled destroy run will occur, refer to [Scheduled Destroy](/terraform/cloud-docs/workspaces/settings/deletion#automatically-destroy). |

content/terraform-docs-common/docs/cloud-docs/architectural-details/ip-ranges.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tfc_only: true
99

1010
HCP Terraform uses static IP ranges for certain features, such as notifications and VCS connections, and you can retrieve these IP ranges through the [IP ranges API](/terraform/cloud-docs/api-docs/ip-ranges).
1111

12-
The IP ranges API does not publish the ranges for workspaces <!-- BEGIN: TFC:only name:stacks-tfe -->or Stacks <!-- END: TFC:only name:stacks-tfe -->doing Terraform operations in [remote execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode). If you want to limit access to specific CIDRs when connecting to your infrastructure, configure your HCP Terraform workspace<!-- BEGIN: TFC:only name:stacks-tfe --> or Stack<!-- END: TFC:only name:stacks-tfe --> to use the [**agent** execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode) to run Terraform operations on an [HCP Terraform agent](/terraform/cloud-docs/agents).
12+
The IP ranges API does not publish the ranges for workspaces or Stacks doing Terraform operations in [remote execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode). If you want to limit access to specific CIDRs when connecting to your infrastructure, configure your HCP Terraform [workspace](/terraform/cloud-docs/workspaces/settings#execution-mode) or [Stack](/terraform/cloud-docs/stacks/configure) to run Terraform operations on **Agent** execution mode using an [HCP Terraform agent](/terraform/cloud-docs/agents).
1313

1414
-> **Note:** The IP ranges for each feature returned by the IP Ranges API may overlap. Additionally, these published ranges do not currently allow for execution of Terraform runs against local resources, such as for CLI-driven runs.
1515

0 commit comments

Comments
 (0)