Skip to content

Commit 7968f7f

Browse files
authored
Adding HCP and HCP Terraform Links to make the platform easier to find (#856)
1 parent d13b3bf commit 7968f7f

Some content is hidden

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

57 files changed

+245
-127
lines changed

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

+2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ The HCP Terraform Operator for Kubernetes supports the following versions:
3434

3535
## Install and configure
3636

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+
3739
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`.
3840

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

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ 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, log in to [HCP Terraform](https://app.terraform.io), then 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

1818
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

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

+1-1
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

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

+3-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ HCP Terraform is a platform that performs Terraform runs to provision infrastruc
2626
2727
## Free and Paid Plans
2828

29-
HCP Terraform is a commercial SaaS product developed by HashiCorp. Many of its features are free for small teams, including remote state storage, remote runs, and VCS connections. We also offer paid plans for larger teams that include additional collaboration and governance features.
29+
[HCP Terraform](https://app.terraform.io/) is a commercial SaaS product developed by HashiCorp. Many of its features are free for small teams, including remote state storage, remote runs, and VCS connections. We also offer paid plans for larger teams that include additional collaboration and governance features.
3030

3131
HCP Terraform manages plans and billing at the [organization level](/terraform/cloud-docs/users-teams-organizations/organizations). Each HCP Terraform user can belong to multiple organizations, which might subscribe to different billing plans. The set of features available depends on which organization you are currently working in.
3232

@@ -52,7 +52,8 @@ Terraform Enterprise generally includes all of HCP Terraform's paid features, pl
5252

5353
To change an organization's plan:
5454

55-
1. Click **Settings** in the navigation bar.
55+
1. Sign in to [HCP Terraform](https://app.terraform.io/).
56+
1. Choose **Settings** from the sidebar.
5657
1. Click **Plan and billing**. The **Plan and Billing** page appears showing your current plan and any available invoices.
5758
1. Click **Change plan**.
5859
1. Select a plan, enter your billing information, and click **Update plan**.

website/docs/cloud-docs/policy-enforcement/manage-policy-sets/index.mdx

+18-11
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ You can add policies directly to HCP Terraform using the web UI. This process re
7676

7777
To add an individually managed policy:
7878

79-
1. Go to **Policies** in your organization’s settings. A list of managed policies in HCP Terraform appears. Each policy designates its policy framework (Sentinel or OPA) and associated policy sets.
79+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to the organization you want to add policies to.
80+
1. Choose **Settings** from the sidebar, then **Policies**. A list of managed policies in HCP Terraform appears. Each policy designates its policy framework (Sentinel or OPA) and associated policy sets.
8081
1. Click **Create a new policy**.
8182
1. Choose the **Policy framework** you want to use. You can only create a policy set from policies written using the same framework. You cannot change the framework type after you create the policy.
8283
1. Complete the following fields to define the policy:
@@ -93,9 +94,10 @@ The policy is now available in the HCP Terraform UI for you to edit and add to o
9394

9495
To edit a managed policy:
9596

96-
- Go to **Policies** in your organization’s settings.
97-
- Click the policy you want to edit to go to its details page.
98-
- Edit the policy's fields and then click **Update policy**.
97+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to the organization you want to edit policies for.
98+
1. Choose **Settings** from the sidebar, then **Policies**.
99+
1. Click the policy you want to edit to go to its details page.
100+
1. Edit the policy's fields and then click **Update policy**.
99101

100102
#### Delete managed policies
101103

@@ -105,9 +107,10 @@ You can not restore policies after deletion. You must manually re-add them to HC
105107

106108
To delete a managed policy:
107109

108-
- Go to **Policies** in your organization’s settings.
109-
- Click the policy you want to delete to go to its details page.
110-
- Click **Delete policy** and then click **Yes, delete policy** to confirm.
110+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to the organization you want to delete a policy in.
111+
1. Choose **Settings** from the sidebar, then **Policies**.
112+
1. Click the policy you want to delete to go to its details page.
113+
1. Click **Delete policy** and then click **Yes, delete policy** to confirm.
111114

112115
The policy no longer appears in HCP Terraform and in any associated policy sets.
113116

@@ -126,7 +129,8 @@ The way you set up and configure a new policy set depends on your workflow and w
126129
### Create policy sets
127130

128131
To create a policy set:
129-
1. Go to **Policy Sets** in your organization’s settings.
132+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to the organization you want to create a policy set in.
133+
1. Choose **Settings** from the sidebar, then **Policies**.
130134
1. Click **Connect a new policy set**.
131135
1. Choose your workflow.
132136
- For managed policies, click **create a policy set with individually managed policies**. HCP Terraform shows a form to create a policy set and add individually managed policies.
@@ -153,7 +157,8 @@ To create a policy set:
153157

154158
To edit a policy set:
155159

156-
1. Go to the **Policy Sets** section of your organization’s settings.
160+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to the organization you want to edit a policy set in.
161+
1. Choose **Settings** from the sidebar, then **Policies**.
157162
1. Click the policy set you want to edit to go to its settings page.
158163
1. Adjust the settings and click **Update policy set**.
159164

@@ -163,7 +168,8 @@ You can validate that changing a policy runtime version does not introduce any b
163168

164169
To perform a policy evaluation:
165170

166-
1. Go to the **Policy Sets** section of your organization’s settings.
171+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to your organization.
172+
1. Choose **Settings** from the sidebar, then **Policies** in your organization’s settings.
167173
1. Click the policy set you want to upgrade.
168174
1. Click the **Evaluate** tab.
169175
1. Select the **Runtime version** you wish to upgrade to.
@@ -181,7 +187,8 @@ You can not restore policy sets after deletion. You must manually re-add them to
181187

182188
To delete a policy set:
183189

184-
1. Go to **Policy Sets** in your organization’s settings.
190+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to the organization you want to delete a policy set in.
191+
1. Choose **Settings** from the sidebar, then **Policies** in your organization’s settings.
185192
2. Click the policy set you want to delete to go to its details page.
186193
3. Click **Delete policy** and then click **Yes, delete policy set** to confirm.
187194

website/docs/cloud-docs/policy-enforcement/prewritten-sentinel.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,8 @@ This method enables you to connect the policies to workspaces in the Terraform c
107107

108108
Skip this step if you [added the Terraform module](#add-the-terraform-module-to-your-configuration) to your configuration. When you use the module, the `policy_set_workspace_names` argument instructs Terraform to connect the policies to the HCP Terraform workspaces specified in the configuration.
109109

110-
1. Log into your organization and click **Settings** in the sidebar.
110+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to the organization with workspaces you want to connect policies to.
111+
1. Choose **Settings** from the sidebar.
111112
1. Click **Policy Sets** and click **Connect a new policy set**.
112113
1. Click the **Version control provider (VCS)** tile.
113114
1. Enable the **Sentinel** option as the policy framework.

website/docs/cloud-docs/projects/manage.mdx

+8-6
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To create tags for a project, you must be member of a team with the **Write** pe
2525

2626
To view your organization's projects:
2727

28-
1. Click **Projects**.
28+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and select **Projects** from the sidebar.
2929
1. Search for a project that you want to view. You can use the following methods:
3030
- Sort by column header.
3131
- Use the search bar to search on the name of a project or a tag.
@@ -34,7 +34,7 @@ To view your organization's projects:
3434

3535
## Create a project
3636

37-
1. Click **Projects**.
37+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and select **Projects** from the sidebar.
3838
1. Click **+ New project**.
3939
1. Specify a name for the project. The name must be unique within the organization and can only include letters, numbers, inner spaces, hyphens, and underscores.
4040
1. Add a description for the project. This field is optional.
@@ -51,9 +51,9 @@ information.
5151

5252
## Edit a project
5353

54-
1. Click **Projects**.
54+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and select **Projects** from the sidebar.
5555
1. Click on a project name of the project you want to edit.
56-
1. Click **Settings**.
56+
1. Choose **Settings** from the sidebar.
5757

5858
On this **General settings** page, you can update the project name, project
5959
description, and delete the project. On the **Team access** page, you can modify
@@ -78,7 +78,8 @@ time by the length of your designated timeframe.
7878

7979
To schedule an auto-destroy run after a period of workspace inactivity:
8080

81-
1. Navigate to the project's **Settings** > **Auto-destroy Workspaces** page.
81+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise and navigate to the project with workspaces you want to destroy.
82+
1. Choose **Settings** from the sidebar, then **Auto-destroy Workspaces**.
8283
1. Click **Set up default**.
8384
1. Select or customize a desired timeframe of inactivity.
8485
1. Click **Confirm default**.
@@ -92,10 +93,11 @@ You can only delete projects that do not contain <!-- BEGIN: TFC:only -->stacks
9293

9394
To delete an empty project:
9495

96+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise.
9597
1. Click **Projects**.
9698
1. Search for a project that you want to review by scrolling down the table or
9799
searching for a project name in the search bar above the project table.
98-
1. Click **Settings**. The settings view for the selected project appears.
100+
1. Choose **Settings** from the sidebar.
99101
1. Click the **Delete** button. A **Delete project** modal appears.
100102
1. Click the **Delete** button to confirm the deletion.
101103

0 commit comments

Comments
 (0)