Skip to content

Commit bfbb879

Browse files
Merge pull request #616 from hashicorp/repo-sync
Repo sync
2 parents eaa24d6 + ccfdf51 commit bfbb879

File tree

22 files changed

+95
-1132
lines changed

22 files changed

+95
-1132
lines changed

content/hcp-docs/content/docs/hcp/europe.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ HCP Europe provides the following benefits to managing your cloud deployments:
5252

5353
HCP Europe provides the same reliability and uninterrupted access to data as the global HCP platform. To provide 24-hour support, data from HCP Europe may be accessed from members of our support team in other regions.
5454

55-
To learn more about our data governance policies, visit the [HashiCorp EU Trust Center](https://www.hashicorp.com/en/trust/eu).
55+
To learn more about our data governance policies, visit the [HashiCorp EU Trust Center](https://www.hashicorp.com/en/trust/privacy/hcp-data-privacy).
5656

5757
## Accounts
5858

content/terraform-docs-common/docs/cloud-docs/api-docs/team-tokens.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -161,13 +161,13 @@ curl \
161161

162162
## List team tokens
163163

164-
Lists the team tokens for the team.
164+
Lists the team tokens for the organization with the option to filter by team name.
165165

166-
`GET /organizations/:organization_id/team-tokens`
166+
`GET /organizations/:organization_name/team-tokens`
167167

168168
| Parameter | Description |
169169
|----------------------|----------------------------------------------------------|
170-
| `:organization_id` | The ID of the organization whose team tokens you want to list. |
170+
| `:organization_name` | The name of the organization whose team tokens you want to list. |
171171

172172
This endpoint returns object metadata and does not include secret authentication details of tokens. You can only view a token when you create it and cannot recover it later.
173173

@@ -257,7 +257,7 @@ Use this endpoint to display a particular [team token](/terraform/cloud-docs/use
257257
| ----------- | ------------------------- |
258258
| `:token_id` | The ID of the Team Token. |
259259

260-
The object returned by this endpoint only contains metadata, and does not include the secret text of the authentication token. A token's secret test is only shown upon creation, and cannot be recovered later.
260+
The object returned by this endpoint only contains metadata, and does not include the secret text of the authentication token. A token's secret text is only shown upon creation and cannot be recovered later.
261261

262262
| Status | Response | Reason |
263263
| ------- | ------------------------------------------------------- | ------------------------------------------------------------ |
@@ -416,7 +416,7 @@ curl \
416416

417417
Lists the [team tokens](/terraform/cloud-docs/users-teams-organizations/teams#api-tokens) in an organization.
418418

419-
`GET organizations/:organization_name/team-tokens`
419+
`GET /organizations/:organization_name/team-tokens`
420420

421421
| Parameter | Description |
422422
|----------------------|----------------------------------------------------------|

content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/concepts.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
---
2-
page_title: Hold your own key concepts
2+
page_title: Hold your own key concepts for HCP Terraform
33
description: >-
44
Learn how HCP Terraform's hold your own key feature encrypts and decrypts state and plan data, which data HCP Terraform encrypts, and the effects of hold your own key encryption on state and plan files.
55
tfc_only: true
66
---
77

88
# Hold your own key concepts
99

10-
Hold your own key lets you authenticate a key management system with HCP Terraform to encrypt HCP Terraform state and plan data with a key that you provide and control.
10+
The hold your own key (HYOK) feature lets you authenticate a key management system with HCP Terraform to encrypt HCP Terraform state and plan data with a key that you provide and control.
1111

1212
@include 'tfc-package-callouts/hyok.mdx'
1313

1414
Terraform artifacts can contain sensitive information, such as resource IDs, IP addresses, credentials, and other configuration details that Terraform uses to manage infrastructure. To secure sensitive data, HCP Terraform uses a HashiCorp-managed key to encrypt sensitive data such as state and plan files before storage.
1515

16-
Hold your own key (HYOK) gives you control over your sensitive data by letting you provide your own encryption key to safeguard that data. Hold your own key lets you configure HCP Terraform artifact encryption using a key from a key management system (KMS) that you control.
16+
The hold your own key (HYOK) feature gives you control over your sensitive data by letting you provide your own encryption key to safeguard that data. HYOK lets you configure HCP Terraform artifact encryption using a key from a key management system (KMS) that you control.
1717

18-
When you enable hold your own key, the HCP Terraform agent encrypts specific Terraform artifacts using a data encryption key (DEK) before uploading those files to HCP Terraform storage. To ensure you retain control of the DEK, the HCP Terraform agent authenticates with your key management service (KMS) and uses a key encryption key (KEK) to encrypt the DEK.
18+
When you enable hold your own key encryption, the HCP Terraform agent encrypts specific Terraform artifacts using a data encryption key (DEK) before uploading those files to HCP Terraform storage. To ensure you retain control of the DEK, the HCP Terraform agent authenticates with your key management service (KMS) and uses a key encryption key (KEK) to encrypt the DEK.
1919

2020
You can run the HCP Terraform agent on your own infrastructure, meaning that neither your KEK nor unencrypted secrets are uploaded to HCP Terraform, and no out-of-network traffic needs to connect to your KMS.
2121

2222
## What is encrypted
2323

24-
The artifacts that HCP Terraform agents encrypt with hold your own key are:
24+
The artifacts that HCP Terraform agents encrypt with HYOK are:
2525

2626
- [State files](/terraform/language/state) and [JSON state files](/terraform/internals/json-format).
2727
- [Plan files](/terraform/cli/commands/plan#out-filename) and [JSON plan files](/terraform/internals/json-format#plan-representation).
@@ -39,7 +39,7 @@ Learn more about [Sensitive data in state](/terraform/language/state/sensitive-d
3939

4040
## Sanitized state and plan files
4141

42-
Hold your own key also produces sanitized versions of artifacts that redact secrets from the artifacts it encrypts. Sanitized state and plan files let HCP Terraform continue running policy checks, run tasks, cost estimation, and assessments without using sensitive data.
42+
The hold your own key (HYOK) feature also produces sanitized versions of artifacts that redact secrets from the artifacts it encrypts. Sanitized state and plan files let HCP Terraform continue running policy checks, run tasks, cost estimation, and assessments without using sensitive data.
4343

4444
The sanitized state and sanitized plan artifacts are JSON files with the same content and format as the `json-state` and `json-plan` outputs, with sensitive data redacted.
4545

content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/configure.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
page_title: Configure and manage keys
2+
page_title: Configure and manage keys for HCP Terraform
33
description: >-
4-
Learn how to set up hold your own key encryption for HCP Terraform, letting you secure your sensitive data in state and plan files using a key from an external key management system.
4+
Learn how to set up hold your own key (HYOK) encryption for HCP Terraform, letting you secure your sensitive data in state and plan files using a key from an external key management system.
55
tfc_only: true
66
---
77

content/terraform-docs-common/docs/cloud-docs/hold-your-own-key/index.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
page_title: Encrypt your state and plan files
2+
page_title: Encrypt your state and plan files for HCP Terraform
33
description: >-
4-
Hold your own key lets you authenticate a key management system with HCP Terraform to encrypt HCP Terraform state and plan data with a key that you control.
4+
The hold your own key (HYOK) feature lets you authenticate a key management system with HCP Terraform to encrypt HCP Terraform state and plan data with a key that you control.
55
tfc_only: true
66
---
77

88
# Encrypt your state and plan files
99

10-
Hold your own key lets you authenticate a key management system with HCP Terraform to encrypt HCP Terraform state and plan data with a key that you provide and control.
10+
The hold your own key (HYOK) feature lets you authenticate a key management system with HCP Terraform to encrypt HCP Terraform state and plan data with a key that you provide and control.
1111

1212
## Introduction
1313

@@ -17,35 +17,35 @@ Terraform artifacts can contain sensitive information, such as resource IDs, IP
1717

1818
For most users, the default level of security that HCP Terraform provides is sufficient. However, the side effect of default encryption is that HCP Terraform maintains access to your Terraform artifacts. You cannot monitor or revoke HCP Terraform's access to your artifacts, which might be insufficient for your compliance requirements.
1919

20-
Hold your own key (HYOK) gives you control over your sensitive data by letting you provide your own encryption key to safeguard that data. Hold your own key lets you configure HCP Terraform artifact encryption using a key from a key management system (KMS) that you control. Use hold your own key to retain control of the keys HCP Terraform uses to encrypt data in state and plan files, enhance your security, and meet your compliance requirements.
20+
The hold your own key (HYOK) feature gives you control over your sensitive data by letting you provide your own encryption key to safeguard that data. HYOK lets you configure HCP Terraform artifact encryption using a key from a key management system (KMS) that you control. Use HYOK to retain control of the keys HCP Terraform uses to encrypt data in state and plan files, enhance your security, and meet your compliance requirements.
2121

22-
When you enable hold your own key, the [HCP Terraform agent](/terraform/cloud-docs/agents) secures certain Terraform artifacts using your key before uploading those artifacts to HCP Terraform storage. To accomplish this, the HCP Terraform agent authenticates with your key management service, then encrypts the necessary artifacts. You can run the HCP Terraform agent on your own infrastructure, meaning that neither your key nor unencrypted secrets are ever uploaded to HCP Terraform, and no out-of-network traffic needs to connect to your key management service.
22+
When you enable HYOK, the [HCP Terraform agent](/terraform/cloud-docs/agents) secures certain Terraform artifacts using your key before uploading those artifacts to HCP Terraform storage. To accomplish this, the HCP Terraform agent authenticates with your key management service, then encrypts the necessary artifacts. You can run the HCP Terraform agent on your own infrastructure, meaning that neither your key nor unencrypted secrets are ever uploaded to HCP Terraform, and no out-of-network traffic needs to connect to your key management service.
2323

24-
The artifacts that HCP Terraform agents encrypt with hold your own key are:
24+
The artifacts that HCP Terraform agents encrypt with HYOK are:
2525

2626
- [State files](/terraform/language/state) and [JSON state files](/terraform/internals/json-format)
2727
- [Plan files](/terraform/cli/commands/plan#out-filename) and [JSON plan files](/terraform/internals/json-format#plan-representation)
2828

29-
Hold your own key supports the following key management services:
29+
The hold your own key feature supports the following key management services:
3030

3131
- AWS Key Management Service
3232
- Azure Key Vault
3333
- Google Cloud Key Management
3434
- Vault transit secrets engine
3535

36-
To learn how to configure hold your own key for your organization, refer to [Configure and manage keys](/terraform/cloud-docs/hold-your-own-key/configure).
36+
To learn how to configure HYOK for your organization, refer to [Configure and manage keys](/terraform/cloud-docs/hold-your-own-key/configure).
3737

38-
Hold your own key also produces sanitized versions of artifacts which redact secrets from the artifacts it encrypts. Sanitized state and plan files let HCP Terraform continue running policy checks, run tasks, cost estimation, and assessments without accessing sensitive data.
38+
The hold your own key feature also produces sanitized versions of artifacts which redact secrets from the artifacts it encrypts. Sanitized state and plan files let HCP Terraform continue running policy checks, run tasks, cost estimation, and assessments without accessing sensitive data.
3939

4040
Refer to [How hold your own key concepts](/terraform/cloud-docs/hold-your-own-key/concepts) to learn more about the details of how HYOK encryption and decryption works.
4141

4242
## Workflow
4343

44-
To create a key configuration for hold your own key, you must perform the following steps:
44+
To create a key configuration for HYOK, you must perform the following steps:
4545

4646
1. Configure your key management system to accept OIDC requests from HCP Terraform, and create a key that your KMS will use to encrypt and decrypt the keys HYOK uses to secure your data.
4747
1. Configure your key in HCP Terraform.
48-
1. Enable hold your own key on one or more workspaces.
48+
1. Enable HYOK on one or more workspaces.
4949

5050
### Configure your KMS and create a key
5151

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<Note>
22

3-
Hold your own key is available on the HCP Terraform **Premium** edition. Refer to [HCP Terraform pricing](https://www.hashicorp.com/products/terraform/pricing) for details.
3+
The hold your own key feature is available on the HCP Terraform **Premium** edition. Refer to [HCP Terraform pricing](https://www.hashicorp.com/products/terraform/pricing) for details.
44

55
</Note>

0 commit comments

Comments
 (0)