Skip to content

Commit 4a9ea43

Browse files
committed
Finally get to the changes from last TFE release
1 parent 0b01caf commit 4a9ea43

File tree

10 files changed

+27
-45
lines changed

10 files changed

+27
-45
lines changed

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ Keep track of changes to the API for HCP Terraform and Terraform Enterprise.
1111

1212
## 2025-05-1
1313
* Add `agent-pool` relationship to the [run task API](/terraform/cloud-docs/api-docs/run-tasks/run-tasks), which you can use to assign a run task to an agent pool.
14+
<!-- BEGIN: TFC:only name:premium -->
1415
* Add `private-run-tasks` to [feature entitlements](/terraform/cloud-docs/api-docs#feature-entitlements).
15-
<!-- BEGIN: TFC:only name:revoke -->
16+
<!-- END: TFC:only name:premium -->
1617
* You can now revoke, and revert the revocation of, module versions. Learn more about [Managing module versions](/terraform/cloud-docs/api-docs/private-registry/manage-module-versions).
17-
<!-- END: TFC:only name:revoke -->
18+
1819
## 2025-4-17
1920
* Document inherited-from link associated with effective tag bindings.
2021

@@ -25,8 +26,10 @@ Keep track of changes to the API for HCP Terraform and Terraform Enterprise.
2526
## 2025-3-10
2627
* Document unique pagination metadata given in the response of [Organization Runs Index API](/terraform/cloud-docs/api-docs/run##list-runs-in-an-organization).
2728

29+
<!-- BEGIN: TFC:only name:explorer -->
2830
## 2025-03-10
2931
* Add new field `current_rum_count` to the [explorer API](/terraform/cloud-docs/api-docs/explorer) in the `workspaces` view type that lists a workspace's current resources under management.
32+
<!-- END: TFC:only name:explorer -->
3033

3134
## 2024-11-19
3235

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,10 @@ The following entitlements are available:
9494
- `policy-enforcement` — Allows an organization to use [Sentinel][]. Affects the [policies][], [policy sets][], and [policy checks][] endpoints.
9595
- `private-module-registry` — Allows an organization to publish and use modules with the [private module registry][]. Affects the [registry modules][] endpoints.
9696
- `private-policy-agents` - Allows an organization to ensure that HTTP enabled [Sentinel][] and OPA [policies][] can communicate with isolated, private, or on-premises infrastructure.
97+
<!-- BEGIN: TFC:only name:premium -->
9798
- `private-run-tasks` - Allows an organization to ensure that [run tasks](/terraform/cloud-docs/workspaces/settings/run-tasks) can communicate with isolated, private, or on-premises infrastructure.
9899
- `private-vcs` - Allows a self-hosted HCP Terraform agent to [connect to a private VCS provider](/terraform/cloud-docs/vcs/private) without having to expose that provider to the public internet.
100+
<!-- END: TFC:only name:premium -->
99101
- `run-tasks` — Allows an organization to use [run tasks](/terraform/cloud-docs/workspaces/settings/run-tasks). Affects the [run tasks][] endpoints.
100102
- `self-serve-billing` — Allows an organization to pay via credit card using the in-app billing UI.
101103
- `sentinel` - **DEPRECATED** Use `policy-enforcement` instead.
@@ -337,7 +339,7 @@ $ curl \
337339

338340
## Rate Limiting
339341

340-
You can make up to 30 requests per second to most API endpoints as an authenticated or unauthenticated request. If you reach the rate limit then your access will be throttled and an error response will be returned.
342+
You can make up to 30 requests per second to most API endpoints as an authenticated or unauthenticated request. If you reach the rate limit then your access will be throttled and an error response will be returned.
341343

342344
Requests are per user, not per token. As a result, you cannot use multiple tokens to make more than 30 requests per second.
343345

content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/manage-module-versions.mdx

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,26 +40,18 @@ description: |-
4040

4141
Use the module version management API endpoints to deprecate, revoke, and revert of status of module versions in your organization’s private registry.
4242

43-
<>{/* TODO: remove revoke references here */}</>
44-
4543
<!-- BEGIN: TFC:only name:pnp-callout -->
4644
@include "tfc-package-callouts/manage-module-versions.mdx"
4745
<!-- END: TFC:only name:pnp-callout -->
4846

4947
## Overview
5048

51-
<>{/* TODO: remove revoke references here */}</>
52-
5349
As part of the module lifecycle, you can deprecate or revoke older module versions as you stop supporting them, signaling to module consumers that they need to upgrade to newer versions.
5450

5551
When you deprecate a module version, HCP Terraform adds warnings to the module's registry page and to run outputs when anyone uses the deprecated version. After deprecating a module version, you can revert that deprecated status to remove the warnings from that version in the registry and outputs.
5652

57-
<!-- BEGIN: TFC:only name:revoke -->
58-
5953
Revoking a module version adds warnings to the module's registry page, warnings in the run outputs of existing users, and blocks new users from using that version. Reverting a module version’s revocation sets the module version back to a deprecated state.
6054

61-
<!-- END: TFC:only name:revoke -->
62-
6355
For more details on deprecating or revoking module versions, refer to [Manage module versions](/terraform/cloud-docs/registry/manage-module-versions).
6456

6557
## Deprecate a module version
@@ -281,8 +273,6 @@ The response includes multiple versions, and each version has a `deprecation` ke
281273
}
282274
```
283275

284-
<!-- BEGIN: TFC:only name:revoke -->
285-
286276
## Revoke a module version
287277

288278
Use this endpoint to revoke a module version. You must [deprecate a module version](#deprecate-a-module-version) before you can revoke it.
@@ -525,5 +515,3 @@ The response includes the revoked versions of this module in the `revoked-versio
525515
},
526516
}
527517
```
528-
529-
<!-- END: TFC:only name:revoke -->

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,12 @@ Refer to [run tasks](/terraform/cloud-docs/api-docs/run-tasks/run-tasks) for the
2727

2828
When a run reaches the appropriate phase and a run task is triggered, HCP Terraform will send a request to the run task's URL.
2929

30+
<!-- BEGIN: TFC:only name:premium -->
31+
3032
Either HCP Terraform itself, or a self-hosted HCP Terraform agent using [request forwarding](/terraform/cloud-docs/agents/request-forwarding) can make the request to a run task's URL. Your organization [must be entitled to `private-run-tasks`](/terraform/cloud-docs/api-docs#feature-entitlements) to use request forwarding.
33+
34+
<!-- END: TFC:only name:premium -->
35+
3136
The service receiving the run task request should respond with `200 OK`, or HCP Terraform will retry to trigger the run task.
3237

3338
`POST :url`

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
@@ -88,7 +88,7 @@ Properties without a default value are required unless otherwise specified.
8888
| `data.attributes.global-configuration.enabled` | bool | false | (Optional) Whether the task will be associated on all workspaces. |
8989
| `data.attributes.global-configuration.stages` | array | | (Optional) An array of strings representing the stages of the run lifecycle when the run task should begin. Must be one or more of `"pre_plan"`, `"post_plan"`, `"pre_apply"`, or `"post_apply"`. |
9090
| `data.attributes.global-configuration.enforcement-level` | string | | (Optional) The enforcement level of the workspace task. Must be `"advisory"` or `"mandatory"`. |
91-
| `data.relationships.agent-pool.data.id` | string | | (Optional) The agent pool that HCP Terraform uses to make requests for the run task. Requires the [`private_run_tasks` feature entitlement](/terraform/cloud-docs/api-docs#feature-entitlements) and a self-hosted HCP Terraform agent with [request forwarding](/terraform/cloud-docs/agents/request-forwarding). |
91+
| `data.relationships.agent-pool.data.id` | string | | (Optional) The agent pool that HCP Terraform uses to make requests for the run task. Requires HCP Terraform **Premium** plan, the [`private_run_tasks` feature entitlement](/terraform/cloud-docs/api-docs#feature-entitlements), and a self-hosted HCP Terraform agent with [request forwarding](/terraform/cloud-docs/agents/request-forwarding). |
9292

9393
### Sample Payload
9494

content/terraform-docs-common/docs/cloud-docs/integrations/kubernetes/setup.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ description: >-
66

77
# Set up the HCP Terraform Operator for Kubernetes
88

9-
The HCP Terraform Operator for Kubernetes' CustomResourceDefinitions (CRD) allow you to dynamically create HCP Terraform workspaces with Terraform modules, populate workspace variables, and provision infrastructure with Terraform runs.
9+
The HCP Terraform Operator for Kubernetes' CustomResourceDefinitions (CRD) allow you to dynamically create HCP Terraform workspaces with Terraform modules, populate workspace variables, and provision infrastructure with Terraform runs.
1010

1111
You can install the operator with the official [HashiCorp Helm chart](https://github.com/hashicorp/hcp-terraform-operator).
1212

1313
## Prerequisites
1414

15-
All HCP Terraform users can use the HCP Terraform Operator for Kubernetes. You can use the operator to manage the supported features that your organization's pricing tier enables.
15+
All HCP Terraform users can use the HCP Terraform Operator for Kubernetes. You can use the operator to manage the supported features that your organization's pricing tier enables.
1616

1717

1818
## Networking requirements
@@ -72,7 +72,7 @@ The HCP Terraform Operator for Kubernetes supports the following versions:
7272

7373
```shell-session
7474
$ helm install --namespace ${RELEASE_NAMESPACE} hashicorp/hcp-terraform-operator tfc-operator
75-
```
75+
```
7676
When deploying in self-managed Terraform Enterprise, you must set the `operator.tfeAddress` to the specific hostname of the Terraform Enterprise instance:
7777

7878
```shell-session
@@ -99,6 +99,6 @@ The HCP Terraform Operator for Kubernetes supports the following versions:
9999

100100
When a new version of the HCP Terraform Operator for Kubernetes Helm Chart is available from the HashiCorp Helm repository, you can upgrade with the following command.
101101

102-
```
102+
```shell-session
103103
helm upgrade --namespace ${RELEASE_NAMESPACE} hashicorp/hcp-terraform-operator tfc-operator
104104
```

content/terraform-docs-common/docs/cloud-docs/registry/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ HCP Terraform's private registry works similarly to the [public Terraform Regist
1313

1414
[Public modules and providers](/terraform/cloud-docs/registry/add) are hosted on the public Terraform Registry and HCP Terraform can automatically synchronize them to an organization's private registry. This lets you clearly designate which public providers and modules are recommended for the organization and makes their supporting documentation and examples centrally accessible.
1515

16+
<!-- BEGIN: TFC:only name:namespaces -->
1617
For more information about publishing artifacts to the public registry with an HCP Terraform organization, refer to [Namespaces](/terraform/cloud-docs/public-namespace).
18+
<!-- END: TFC:only name:namespaces -->
1719

1820
-> **Note:** Your Terraform Enterprise instance must allow access to `registry.terraform.io`, `https://yy0ffni7mf-dsn.algolia.net/` and `github.com`.
1921

content/terraform-docs-common/docs/cloud-docs/registry/manage-module-versions.mdx

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ description: >-
66

77
# Manage module versions
88

9-
<>{/* TODO: remove revoke references here */}</>
10-
119
You can manage the lifecycle of module versions in your organization’s private registry by deprecating or revoking module versions as you stop maintaining and supporting those versions.
1210

1311
<!-- BEGIN: TFC:only name:pnp-callout -->
@@ -16,27 +14,20 @@ You can manage the lifecycle of module versions in your organization’s private
1614

1715
Deprecating a module version adds warnings to the module's registry page and warnings in the run outputs of any users of that version.
1816

19-
<!-- BEGIN: TFC:only name:revoke -->
2017
Revoking a module version adds warnings to the module's registry page, warnings in the run outputs of existing users, and prevents new users from consuming that version.
21-
<!-- END: TFC:only name:revoke -->
2218

2319
You can also [deprecate or revoke module versions using the HCP Terraform API](/terraform/cloud-docs/api-docs/private-registry/manage-module-versions).
2420

25-
<>{/* TODO: remove revoke references here */}</>
26-
2721
## Overview
2822

2923
Deprecating a private module version enables platform teams and module authors to signal to consumers that a version is still maintained and supported but is not recommended. HCP Terraform urges existing and new users of deprecated versions to upgrade that version in their configuration. The private registry also denotes which module versions are deprecated, alerting new consumers to use a non-deprecated version.
3024

3125
You can revert a module version’s deprecation if you decide to continue supporting that version. Reverting a version’s deprecation removes all warnings from that version in both the module’s registry page and the run outputs of that version’s consumers.
3226

33-
<!-- BEGIN: TFC:only name:revoke -->
34-
3527
You can revoke a private module to mark that you not longer support it. Revoking a module version adds similar warnings to deprecation in a module's registry page and the run outputs of current consumers. Revoking a module version also blocks the runs of any new users attempting to add that version to their configuration.
3628

3729
Reverting a module version’s revocation sets it back to a deprecated state, signaling that the version is still maintained and supported but not recommended.
3830

39-
<!-- END: TFC:only name:revoke -->
4031

4132
## Requirements
4233

@@ -47,14 +38,12 @@ To deprecate a module version or to revert a version’s deprecation:
4738
- you must be a member of an organization on the HCP Terraform **Plus** edition
4839
<!-- END: TFC:only name:pnp-callout -->
4940

50-
<!-- BEGIN: TFC:only name:revoke -->
5141
To revoke or to revert a module version’s status:
5242
- you must have permission to manage [private registry modules](/terraform/cloud-docs/users-teams-organizations/permissions#manage-private-registry)
5343
- the module must be in an organization's [private registry](/terraform/cloud-docs/registry/publish-modules)
44+
<!-- BEGIN: TFC:only name:pnp-callout -->
5445
- you must be a member of an organization on the HCP Terraform **Premium** edition
55-
<!-- END: TFC:only name:revoke -->
56-
57-
<>{/* TODO: don't forget to exclude PNP above when remove tags */}</>
46+
<!-- END: TFC:only name:pnp-callout -->
5847

5948
## Deprecate a module version
6049

@@ -112,15 +101,11 @@ To revert a module version’s deprecation, perform the following steps:
112101

113102
Reverting the deprecation of a module version removes all warnings from that version in both the module’s registry page and in the run outputs of that module version’s consumers.
114103

115-
<>{/* TODO: add TFE to bullet points */}</>
116-
117-
<!-- BEGIN: TFC:only name:revoke -->
118-
119104
## Revoke a module version
120105

121106
To revoke a module version, perform the following steps:
122107

123-
1. Sign in to [HCP Terraform](https://app.terraform.io/) and navigate to your organization.
108+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to your organization.
124109
1. Choose **Registry** in the sidebar, then select the module version you want to revoke.
125110
1. If you have not already, [deprecate the module version](#deprecate-a-module-version) you want to revoke.
126111
1. Open the **Manage module for organization** dropdown.
@@ -164,7 +149,6 @@ Version X.X.X of <module-name-version>
164149

165150
</CodeBlockConfig>
166151

167-
168152
If a new user attempts to add a revoked module version to their configuration, their runs fail. If you provided a reason for a module version’s revocation, HCP Terraform displays that reason to users in run outputs:
169153

170154
<CodeBlockConfig hideClipboard>
@@ -206,5 +190,3 @@ To revert a module version’s revocation, perform the following steps:
206190
1. Open the **Manage module for organization** dropdown.
207191
1. Select **Revert module version revocation X.X.X**.
208192
1. Click **Revert**.
209-
210-
<!-- END: TFC:only name:revoke -->

content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/api-tokens.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ Navigate to the **Organization Settings > API Tokens > Team Tokens** tab to mana
2424

2525
Teams can have multiple valid tokens at a time, so long as the tokens' descriptions are unique within the context of the given team. A token without a description is considered a legacy token, and only one legacy token can exist at a given time.
2626

27-
The [**legacy API**](/terraform/cloud-docs/api-docs/team-tokens#legacy-team-tokens-api-reference) will only operate on the legacy token, and generating a new legacy token invalidates the previous legacy token.
27+
The [legacy API](/terraform/cloud-docs/api-docs/team-tokens#legacy-team-tokens-api-reference) uses a legacy token, generating a new legacy token invalidates the previous token.
2828

29-
The [**non-legacy API**](/terraform/cloud-docs/api-docs/team-tokens#team-tokens-api-reference) will support the existence of multiple, valid team tokens, meaning that when a new, non-legacy token is generated, existing tokens will remain valid.
29+
The [current team token API](/terraform/cloud-docs/api-docs/team-tokens#team-tokens-api-reference) supports multiple team tokens, and adding new tokens does not invalidate older ones.
3030

3131
Owners and users with [manage teams](/terraform/cloud-docs/users-teams-organizations/permissions#manage-teams) permissions have the ability to enable and disable team token management for a team, which limits the actions that team members can take on a team token. Refer to [Allow Member Token Management](/terraform/cloud-docs/users-teams-organizations/permissions#allow-member-token-management) for more information.
3232

content/terraform-docs-common/docs/cloud-docs/vcs/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,13 +117,13 @@ You can use self-hosted HCP Terraform Agents to connect HCP Terraform to your pr
117117

118118
## Configure a VCS host for Terraform Enterprise
119119

120-
You can configure Terraform Enterprise to be accessible over a primary and a secondary hostname so that you can federate workloads associated with your VCS. Refer to [Specify integration setttings](/terraform/enterprise/deploy/configuration/network#specify-integration-settings) for additional information.
120+
You can configure Terraform Enterprise to be accessible over a primary and a secondary hostname so that you can federate workloads associated with your VCS. Refer to [Specify integration setttings](/terraform/enterprise/deploy/configuration/network#specify-integration-settings) for additional information.
121121

122122
You must set up new VCS connections any time you update the VCS host configuration. When the VCS integration uses the secondary hostname, you should continue using it while setting up the new VCS connection. When setup is complete, you can use the primary hostname for all other activities. Refer to [`TFE_VCS_HOSTNAME_CHOICE` ](/terraform/enterprise/deploy/reference/configuration#tfe_vcs_hostname_choice) in the configuration reference for additional information.
123123

124124
## Viewing events
125125

126-
-> **Note**: The VCS Events page is still in beta as support is being added for additional VCS providers. Currently only GitLab.com connections established after December 2020 are supported.
126+
-> **Note**: The VCS events page is in beta, and only supports GitLab.com connections made after December 2020.
127127

128128
VCS events describe changes within your organization for VCS-related actions. The VCS events page only displays events from previously processed commits in the past 30 days. The VCS page indicates previously processed commits with the message, `"Processing skipped for duplicate commit SHA"`.
129129

0 commit comments

Comments
 (0)