Skip to content

Commit 4adf24b

Browse files
Merge pull request #384 from hashicorp/repo-sync-3-24-2025
Repo sync 3 24 2025
2 parents 0c2cb4a + 4ab5d02 commit 4adf24b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+363
-176
lines changed

website/data/cloud-docs-nav-data.json

+35-35
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,41 @@
2929
"title": "Getting Started",
3030
"href": "https://learn.hashicorp.com/collections/terraform/cloud-get-started?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS"
3131
},
32+
{
33+
"title": "Migrate to HCP Terraform",
34+
"routes": [
35+
{
36+
"title": "Overview",
37+
"path": "migrate"
38+
},
39+
{
40+
"title": "The tf-migrate CLI",
41+
"routes": [
42+
{
43+
"title": "Overview",
44+
"path": "migrate/tf-migrate"
45+
},
46+
{
47+
"title": "CLI Reference",
48+
"routes": [
49+
{
50+
"title": "tf-migrate prepare",
51+
"path": "migrate/tf-migrate/reference/prepare"
52+
},
53+
{
54+
"title": "tf-migrate execute",
55+
"path": "migrate/tf-migrate/reference/execute"
56+
},
57+
{
58+
"title": "Configuration file reference",
59+
"path": "migrate/tf-migrate/reference/configuration"
60+
}
61+
]
62+
}
63+
]
64+
}
65+
]
66+
},
3267
{
3368
"title": "API",
3469
"routes": [
@@ -478,41 +513,6 @@
478513
}
479514
]
480515
},
481-
{
482-
"title": "Migrate to HCP Terraform",
483-
"routes": [
484-
{
485-
"title": "Overview",
486-
"path": "migrate"
487-
},
488-
{
489-
"title": "The tf-migrate CLI",
490-
"routes": [
491-
{
492-
"title": "Overview",
493-
"path": "migrate/tf-migrate"
494-
},
495-
{
496-
"title": "CLI Reference",
497-
"routes": [
498-
{
499-
"title": "tf-migrate prepare",
500-
"path": "migrate/tf-migrate/reference/prepare"
501-
},
502-
{
503-
"title": "tf-migrate execute",
504-
"path": "migrate/tf-migrate/reference/execute"
505-
},
506-
{
507-
"title": "Configuration file reference",
508-
"path": "migrate/tf-migrate/reference/configuration"
509-
}
510-
]
511-
}
512-
]
513-
}
514-
]
515-
},
516516
{
517517
"title": "Policy enforcement",
518518
"routes": [

website/docs/cloud-docs/api-docs/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ description: >-
3838

3939
# HCP Terraform API documentation
4040

41-
HCP Terraform provides an API for a subset of its features. If you have any questions or want to request new API features, please email <support@hashicorp.com>.
41+
HCP Terraform provides an API for a subset of its features. If you need assistance or want to submit a feature request, visit the [HashiCorp support center](https://support.hashicorp.com/hc/en-us) and open a ticket.
4242

4343
-> **Note:** Before planning an API integration, consider whether [the `tfe` Terraform provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs) meets your needs. It can't create or approve runs in response to arbitrary events, but it's a useful tool for managing your organizations, teams, and workspaces as code.
4444

website/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ A run task result may optionally contain one or more detailed outcomes, which im
186186
| ------------------------- | ------ | ----------------------------------------------------------------------------------------------- |
187187
| `outcome-id` | string | A partner supplied identifier for this outcome. |
188188
| `description` | string | A one-line description of the result. |
189-
| `body` | string | (Optional) A detailed message for the result in Markdown format. |
189+
| `body` | string | (Optional) A detailed message for the result in Markdown format. It is recommended to keep it under 1MB, with a maximum allowable limit of 5MB. |
190190
| `url` | string | (Optional) A URL that a user can navigate to for more information about this result. |
191191
| `tags` | object | (Optional) An object containing tag arrays, named by the property key. |
192192
| `tags.key` | string | The two or three word name of the header tag. [Special handling](#severity-and-status-tags) is given to `severity` and `status` keys. |

website/docs/cloud-docs/cost-estimation/index.mdx

+6-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@ HCP Terraform provides cost estimates for many resources found in your Terraform
1212

1313
## Enabling Cost Estimation
1414

15-
HCP Terraform disables cost estimation by default. You can enable or disable the feature in your organization's settings.
15+
HCP Terraform disables cost estimation by default. To enable cost estimation:
16+
17+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise, then navigate to the organization where you want to enable cost estimation.
18+
1. Choose **Settings** from the sidebar, then **Cost Estimation**.
19+
1. Toggle the **Enable cost estimation for all workspaces** setting.
20+
1. Click **Update settings**.
1621

1722
## Viewing a Cost Estimate
1823

website/docs/cloud-docs/integrations/kubernetes/setup.mdx

+38-8
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ The HCP Terraform Operator for Kubernetes makes outbound requests over HTTPS (TC
2323
| ---------------- | -------------- | -------------- | ------------------------------------------------------------------------------------------------------------------ |
2424
| `app.terraform.io` | tcp/443, HTTPS | Outbound | Dynamically managing HCP Terraform workspaces and returning the output to Kubernetes with the HCP Terraform API |
2525

26+
For self-managed Terraform Enterprise instances, ensure that the operator can reach your Terraform Enterprise hostname over HTTPS (TCP port 443).
27+
2628
## Compatibility
2729

2830
The HCP Terraform Operator for Kubernetes supports the following versions:
@@ -32,7 +34,9 @@ The HCP Terraform Operator for Kubernetes supports the following versions:
3234

3335
## Install and configure
3436

35-
1. Generate an [organization token](/terraform/cloud-docs/users-teams-organizations/api-tokens#organization-api-tokens) within HCP Terraform and save it to a file. These instructions assume you are using a file named `credentials`.
37+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to the organization you want to integrate with Kubernetes.
38+
39+
1. Generate an [organization token](/terraform/cloud-docs/users-teams-organizations/api-tokens#organization-api-tokens) within HCP Terraform or Terraform Enterprise and save it to a file. These instructions assume you are using a file named `credentials`.
3640

3741
1. Set the `NAMESPACE` environment variable. This will be the namespace that you will install the Helm chart to.
3842

@@ -58,20 +62,46 @@ The HCP Terraform Operator for Kubernetes supports the following versions:
5862
kubectl -n $NAMESPACE create secret generic workspacesecrets --from-literal=secret_key=abc123
5963
```
6064

61-
1. Install the [HCP Terraform Operator for Kubernetes with Helm](https://github.com/hashicorp/terraform-helm).
65+
1. Add the HashiCorp Helm repository.
6266

63-
```
64-
helm repo add hashicorp https://helm.releases.hashicorp.com
67+
```
68+
helm repo add hashicorp https://helm.releases.hashicorp.com
69+
```
6570

66-
helm install --namespace ${RELEASE_NAMESPACE} hashicorp/terraform --generate-name
67-
```
71+
1. Install the [HCP Terraform Operator for Kubernetes with Helm](https://github.com/hashicorp/hcp-terraform-operator). By default, the operator communicates with `app.terraform.io`. When deploying in a self-managed Terraform Enterprise, it is required to set the `operator.tfeAddress` to the specific hostname of the Terraform Enterprise instance.
72+
73+
- For HCP Terraform Cloud (default)
74+
75+
```
76+
helm install --namespace ${RELEASE_NAMESPACE} hashicorp/hcp-terraform-operator tfc-operator
77+
```
78+
79+
- For self-managed Terraform Enterprise, specify your instance's hostname
80+
81+
```
82+
helm install --namespace ${RELEASE_NAMESPACE} hashicorp/hcp-terraform-operator tfc-operator \
83+
--set operator.tfeAddress="TERRAFORM_ENTERPRISE_HOSTNAME"
84+
```
85+
86+
- Alternatively, you can set this configuration in the [value.yaml](https://github.com/hashicorp/hcp-terraform-operator/blob/main/charts/hcp-terraform-operator/values.yaml) file.
87+
88+
```yaml
89+
operator:
90+
tfeAddress: <TERRAFORM_ENTERPRISE_HOSTNAME>
91+
```
92+
93+
- Then, apply the configuration with.
94+
95+
```
96+
helm install --namespace ${NAMESPACE} hashicorp/hcp-terraform-operator tfc-operator -f value.yaml
97+
```
6898

69-
1. To create a Terraform workspace, you can create a separate Helm chart to deploy the custom resource or refer to these [examples](https://github.com/hashicorp/terraform-helm/tree/master/example).
99+
1. To create a Terraform workspace, agent pool or etc, you can find different [examples](https://github.com/hashicorp/hcp-terraform-operator/tree/main/docs/examples) of the YAML manifests.
70100

71101
### Upgrade
72102

73103
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.
74104

75105
```
76-
helm upgrade --namespace ${RELEASE_NAMESPACE} ${RELEASE_NAME} hashicorp/terraform
106+
helm upgrade --namespace ${RELEASE_NAMESPACE} hashicorp/hcp-terraform-operator tfc-operator
77107
```

website/docs/cloud-docs/integrations/service-now/service-catalog-terraform/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ Before installing the ServiceNow integration, the Terraform Admin will need to
102102
perform the following steps to configure and gather information from HCP
103103
Terraform.
104104

105+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise.
105106
1. Either [create an
106107
organization](/terraform/cloud-docs/users-teams-organizations/organizations#creating-organizations)
107108
or choose an existing organization where ServiceNow will create new

website/docs/cloud-docs/integrations/service-now/service-graph/service-graph-setup.mdx

+5-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,11 @@ Once the integration is installed, you can proceed to the guided setup form wher
4444

4545
In order for ServiceNow to connect to HCP Terraform, you must give it an HCP Terraform API token. The permissions of this token determine what resources the Service Graph Connector will import into the CMDB. While you could use a user API token, it could import resources from multiple organizations. By providing a team API token, you can scope permissions to only import resources from specified workspaces within a single organization.
4646

47-
Visit your organization’s **Settings** > **Teams** page. Scroll down to the **Team API Token** section and click **Create a team token**.
47+
To create a team API token:
48+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to the organization where you want to create a team token.
49+
1. Choose **Settings** from the sidebar, then **Teams**.
50+
1. In **Team API Token** section, click **Create a team token**.
51+
4852
Save this token in a safe place since HCP Terraform only displays it once. You will use it to configure ServiceNow in the next section.
4953

5054
![ServiceNow Service Graph Connector Configure Team API token in HCP Terraform](/img/docs/service-now-service-graph-team-token-gen.png)

website/docs/cloud-docs/migrate/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ You have three options to migrate your state:
2525
## Requirements
2626

2727
- Terraform v1.1 and later is required to configure the `cloud` block. For Terraform v1.0 and older, use the [`remote` backend](/terraform/language/settings/backends/remote) instead.
28+
- Create an account on [HCP Terraform](https://app.terraform.io/) or on a [Terraform Enterprise instance](/terraform/enterprise/users-teams-organizations/users#creating-an-account).
2829
- You must present a token linked to appropriate permissions to use the API. Refer to the following topics for additional information:
2930
- [HCP Terraform API overview](/terraform/cloud-docs/api-docs)
3031
- [Terraform Enterprise API overview](/terraform/enterprise/api-docs)

website/docs/cloud-docs/migrate/tf-migrate/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Do you want to proceed?
8989
Enter a value: yes
9090
```
9191

92-
Terraform opens a browser to the HCP Terraform login screen. Enter a token name in the web UI, or leave the default name. Click **Create API token** to generate the authentication token.
92+
Terraform opens a browser to the HCP Terraform sign in screen, where you can then enter a token name in the web UI, or leave the default name. Click **Create API token** to generate the authentication token.
9393

9494
HCP Terraform only displays your token once. Copy this token, then when the Terraform CLI prompts you, paste the user token exactly once into your terminal. Press **Enter** to complete the authentication process.
9595

website/docs/cloud-docs/no-code-provisioning/provisioning.mdx

+5-1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ The no-code provisioning workflow creates a new HCP Terraform workspace to deplo
2727

2828
To launch the no-code workflow:
2929

30+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to the organization with the module you want to provision.
31+
3032
1. Click **Registry** in the main HCP Terraform navigation to access your organization's private registry.
3133

3234
1. Click **Modules** to view the list of available modules in the private registry. You can filter for no-code ready modules in your registry. No-code enabled modules have a **No-code Ready** badge next to their names.
@@ -67,7 +69,9 @@ When you [update the module version](/terraform/cloud-docs/no-code-provisioning/
6769

6870
To change the version of the module that users can deploy:
6971

70-
1. Navigate to the module in your organization's registry.
72+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to your organization.
73+
74+
1. Choose **Registry** from the sidebar and navigate to the module in your organization's registry.
7175

7276
1. Click **Configure Settings**.
7377

website/docs/cloud-docs/overview/activate-flex.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ To activate HashiCorp Flex, you must:
1919

2020
## Step 1: Create the required user accounts
2121

22-
There are two ways to activate HashiCorp Flex. If you already use both HCP Terraform and HCP, we recommend that you create a unified HCP user account. Otherwise, you can create separate HCP Terraform and HCP accounts.
22+
There are two ways to activate HashiCorp Flex. If you already use both HCP Terraform and HCP, we recommend that you create a linked HCP user account. Otherwise, you can create separate HCP Terraform and HCP accounts.
2323

24-
### Create a unified HCP user account
24+
### Create a linked HCP user account
2525

2626
1. Go to [HCP Terraform](https://app.terraform.io) and click **Continue with HCP account.**
2727
1. Create a free HCP account or sign in using your HCP email. If you have an existing HCP Terraform account, HCP prompts you to [link it](/terraform/cloud-docs/users-teams-organizations/users#linking-hcp-and-hcp-terraform-accounts). If you do not have an HCP Terraform account, HCP creates one for you and links it to the HCP account.
@@ -51,7 +51,7 @@ Your sales account manager will email your organization's tech contact a code to
5151

5252
To activate your Flex plan:
5353
1. Copy the HCP Flex activation code from your email.
54-
1. Click the link in your activation email to access your HCP organization or log into your HCP portal.
54+
1. Click the link in your activation email to access your HCP organization or log into your [HCP portal](https://portal.cloud.hashicorp.com/).
5555
1. Navigate to **Billing > Payment Methods** and find the **Contract** section.
5656
1. Paste the activation code you copied to the **Contract** section.
5757

@@ -71,7 +71,7 @@ Navigate to your HCP Terraform organization setting's **Plan & Billing** page. I
7171

7272
![Prompt for user to link their HCP Terraform account to an HCP account](/img/docs/tfc-plan-and-billing.png)
7373

74-
~> **Note**: If you have a unified HCP account, you do not need to log in and HCP Terraform will automatically identify HCP organizations that your unified HCP user account is a member of and are a member of the Flex HCP Terraform organization.
74+
~> **Note**: If you have a linked HCP account, you do not need to log in and HCP Terraform will automatically identify HCP organizations that your linked HCP user account is a member of and are a member of the Flex HCP Terraform organization.
7575

7676
Click **Edit Plan** to go to the Plan Activation page.
7777

website/docs/cloud-docs/overview/activate-payg.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Pay-as-you-go offers dynamic billing based on monthly consumption. Larger organi
1313

1414
## Activate pay-as-you-go
1515

16-
To enable pay-as-you-go and change your organization's plan, navigate to **Organization Settings > Plan & Billing**.
16+
To enable pay-as-you-go and change your organization's plan, sign in to [HCP Terraform](https://app.terraform.io/) and select your organization. Then choose **Settings** from the sidebar, then **Plan & Billing**.
1717

18-
In order to upgrade to **Standard Edition** or **Plus Edition** and use pay-as-you-go billing, you must log in to your HashiCorp Cloud Platform account and [link](/terraform/cloud-docs/users-teams-organizations/users#linking-hcp-and-hcp-terraform-accounts) your HCP Terraform account to your [HashiCorp Cloud Platform billing account](/hcp/docs/hcp/admin/billing). Click **Edit plan** to authenticate with HCP and link your accounts.
18+
In order to upgrade to **Standard Edition** or **Plus Edition** and use pay-as-you-go billing, you must sign in to your HashiCorp Cloud Platform account and [link](/terraform/cloud-docs/users-teams-organizations/users#linking-hcp-and-hcp-terraform-accounts) your HCP Terraform account to your [HashiCorp Cloud Platform billing account](/hcp/docs/hcp/admin/billing). Click **Edit plan** to authenticate with HCP and link your accounts.
1919

2020
![Screenshot: Notification reading that the user must link their HashiCorp Cloud Platform account to change their plan. Click the "edit plan" button](/img/docs/tfc-pnb-link-hcp.png)
2121

website/docs/cloud-docs/overview/estimate-hcp-terraform-cost.mdx

+7-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Examples of managed resources include resources provisioned by a Terraform provi
1919

2020
HashiCorp charges for each managed resource on a per-hour basis, from the time a managed resource is provisioned until it is destroyed. Each partial hour is billed as a full hour. The peak number of managed resources in a given hour determines the cost.
2121

22-
Your organization's **Usage** page reports the total number of managed resources, which you can use to determine the number of billable managed resources in use at any given time. You can find the total cost in the [HashiCorp Cloud Platform portal](/hcp/docs/hcp/admin/billing#usage). It is refreshed hourly.
22+
Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and choose **Usage** from the sidebar to navigate to a report of your organization's total number of managed resources. You can use the total number of managed resources to determine your number of billable managed resources in use at any given time. You can find your total cost in the [HashiCorp Cloud Platform portal](/hcp/docs/hcp/admin/billing#usage), which is refreshed hourly.
2323

2424
The Usage report gives an at a glance view of general usage limits in the Organization:
2525
- A summary of projects, workspaces, and applies
@@ -41,7 +41,12 @@ Another example calculation factors in billable managed resource counts, partial
4141

4242
## Manage your plan
4343

44-
To edit your organization's plan, navigate to the **Plan & Billing** page and click **Edit Plan**. If you cannot edit your organization's plan due to an active contract, contact your HashiCorp account team.
44+
To edit your organization's plan, complete the following steps:
45+
46+
1. Sign in to [HCP Terraform](https://app.terraform.io).
47+
1. Select the organization that you want to manage.
48+
1. Navigate to the **Plan & Billing** page.
49+
1. Click **Edit Plan**. If you cannot edit your organization's plan due to an active contract, contact your HashiCorp account team.
4550

4651
Pay-as-you-go and HashiCorp Flex customers can self-activate their HCP Terraform organizations. Refer to [Changing Your HCP Terraform Plan](/terraform/cloud-docs/overview/change-plan) for details.
4752

0 commit comments

Comments
 (0)