Skip to content

Commit eaa24d6

Browse files
Merge pull request #607 from hashicorp/repo-sync
Repo sync
2 parents 275ce0b + 7d6a8d3 commit eaa24d6

File tree

1,932 files changed

+2255
-542
lines changed

Some content is hidden

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

1,932 files changed

+2255
-542
lines changed

.github/workflows/label-content-prs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55

66
name: 🏷️ Label content PRs
77

8-
on: [pull_request_target]
8+
on:
9+
pull_request_target:
10+
types: [opened, synchronize, reopened]
911

1012
jobs:
1113

CODEOWNERS

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,29 +27,27 @@
2727

2828
/content/terraform-enterprise @hashicorp/team-docs-packer-and-terraform @hashicorp/ptfe-review
2929

30-
3130
# Vault documentation ownership
32-
3331
/content/vault/ @hashicorp/vault-education-approvers
3432

3533
# Sentinel documentation ownership
3634
/content/sentinel/ @hashicorp/team-docs-packer-and-terraform @hashicorp/tf-compliance
3735

3836
# Well-architected framework
39-
4037
/content/well-architected-framework/ @hashicorp/well-architected-education-approvers
4138

42-
4339
# HCP-docs documentation ownership
40+
/content/hcp-docs/* @hashicorp/education
41+
4442
# HCP Consul Docs
4543
/content/hcp-docs/content/docs/consul/* @hashicorp/consul-docs
4644

47-
# HCP Vault & HCP Vault Secrets docs
48-
/content/hcp-docs/content/docs/vault/* @hashicorp/vault-education-approvers
49-
/content/hcp-docs/content/docs/vault-secrets/* @hashicorp/vault-education-approvers
45+
# HCP Vault & HCP Vault Radar docs
46+
/content/hcp-docs/content/docs/vault* @hashicorp/vault-education-approvers
47+
/content/hcp-docs/content/partials/vault* @hashicorp/vault-education-approvers
5048

5149
# HCP Boundary docs
52-
/content/hcp-docs/content/docs/boundary/* @hashicorp/boundary-education-approvers
50+
/content/hcp-docs/content/docs/boundary/* @hashicorp/boundary-education-approvers
5351

5452
#HCP IAM
5553
/content/hcp-docs/content/partials/hcp-administration/* @hashicorp/cloud-access-control @hashicorp/cloud-identity
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
page_title: Correlate findings with AWS Secrets Manager
3+
description: >-
4+
Correlate findings from HCP Vault Radar with secrets stored in AWS Secrets Manager.
5+
---
6+
7+
# Correlate findings with AWS Secrets Manager
8+
9+
When HCP Vault Radar connects to AWS Secrets Manager, Vault Radar can correlate
10+
findings with secrets stored in AWS Secrets Manager. This allows you to identify
11+
what secrets you need to rotate.
12+
13+
## Connect AWS Secrets Manager
14+
15+
Before you can correlate findings with AWS Secrets Manager, you need to [deploy
16+
the Radar agent](/hcp/docs/vault-radar/agent/deploy). Once you deploy the agent,
17+
you can configure and connect AWS Secrets Manager to the agent.
18+
19+
## Prerequisites
20+
21+
You need one of the following AWS authentication methods:
22+
23+
- IAM role authentication with an EC2 instance or configured IAM role
24+
- Environment variables authentication with AWS Access Key ID and Secret Access Key
25+
26+
Both authentication methods support an optional assume role ARN for
27+
cross-account access or elevated permissions. For more information about
28+
assuming roles, refer to the [AWS STS AssumeRole
29+
documentation](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
30+
31+
### Required permissions
32+
33+
The IAM user, role, or assumed role must have the following permissions:
34+
35+
| Service | Permission | Documentation |
36+
|---------|------------|---------------|
37+
| Secrets Manager | `secretsmanager:ListSecrets` | [ListSecrets API](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_ListSecrets.html) |
38+
| Secrets Manager | `secretsmanager:DescribeSecret` | [DescribeSecret API](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DescribeSecret.html) |
39+
| Secrets Manager | `secretsmanager:GetSecretValue` | [GetSecretValue API](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html) |
40+
| Secrets Manager | `secretsmanager:ListSecretVersionIds` | [ListSecretVersionIds API](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_ListSecretVersionIds.html) |
41+
| EC2 | `ec2:DescribeRegions` | [DescribeRegions API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRegions.html) |
42+
| STS | `sts:GetCallerIdentity` | [GetCallerIdentity API](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity.html) |
43+
44+
**Example AWS IAM policy:**
45+
46+
```json
47+
{
48+
"Version": "2012-10-17",
49+
"Statement": [
50+
{
51+
"Effect": "Allow",
52+
"Action": [
53+
"secretsmanager:ListSecrets",
54+
"secretsmanager:DescribeSecret",
55+
"secretsmanager:GetSecretValue",
56+
"secretsmanager:ListSecretVersionIds"
57+
],
58+
"Resource": "*"
59+
},
60+
{
61+
"Effect": "Allow",
62+
"Action": [
63+
"ec2:DescribeRegions"
64+
],
65+
"Resource": "*"
66+
},
67+
{
68+
"Effect": "Allow",
69+
"Action": [
70+
"sts:GetCallerIdentity"
71+
],
72+
"Resource": "*"
73+
}
74+
]
75+
}
76+
```
77+
78+
## Agent configuration with AWS Secrets Manager
79+
80+
Set up and manage AWS Secrets Manager from the Vault Radar module in the [HCP
81+
Portal](https://portal.cloud.hashicorp.com/).
82+
83+
1. Click **Settings**.
84+
85+
1. Click **Secret Managers**.
86+
87+
1. Click **Connect new secret manager**.
88+
89+
1. Select **AWS Secrets Manager** and click **Next**.
90+
91+
1. Select an AWS authentication method from the **Authentication method** pulldown menu.
92+
93+
1. Enter the details for the selected method and click **Next** to validate the connection.
94+
95+
<Tabs>
96+
<Tab heading="IAM Role">
97+
98+
- Select **IAM Role** if you want to use instance profile or role-based authentication.
99+
100+
![IAM Role](/img/docs/vault-radar/indexing/aws-secrets-manager/iam-role.png)
101+
102+
- (Optional) Enter an assume role ARN in the **Assume Role ARN** text field if you need to assume a different role for access.
103+
104+
</Tab>
105+
<Tab heading="Environment Variables">
106+
107+
- Select **AWS Credentials from environment variables** if you want to use access keys.
108+
109+
![Environment Variables](/img/docs/vault-radar/indexing/aws-secrets-manager/environment-variables.png)
110+
111+
- Enter your AWS Access Key ID location in the **AWS Access Key ID Env variable** text field (default: `env://AWS_ACCESS_ID_LOCATION`).
112+
113+
- Enter your AWS Secret Access Key location in the **AWS Secret Access Key Env variable** text field (default: `env://AWS_SECRET_KEY_LOCATION`).
114+
115+
- (Optional) Enter an assume role ARN in the **Assume Role ARN** text field if you need to assume a different role for access.
116+
117+
</Tab>
118+
</Tabs>
119+
120+
Vault Radar fetches all active regions for the account and automatically starts index scan for each region.

content/hcp-docs/content/docs/vault-radar/agent/correlate-vault.mdx

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,26 @@ Vault Dedicated or Vault Enterprise clusters.
1313

1414
</Highlight>
1515

16-
When the HCP Vault Radar agent connects to a HCP Vault Dedicated or Vault Enterprise cluster,
16+
When the Vault Radar agent connects to a Vault Dedicated or Vault Enterprise cluster,
1717
Vault Radar can correlate findings with secrets stored in Vault. This allows you to identify
1818
what secrets you need to rotate.
1919

2020
## Connect a Vault cluster
2121

2222
Before you can correlate findings with Vault, you need to [deploy the Radar
2323
agent](/hcp/docs/vault-radar/agent/deploy). Once you deploy the agent, you can
24-
configured and connect Vault to the agent.
24+
configure and connect Vault to the agent.
25+
26+
## Prerequisites
27+
28+
You need one of the following Vault authentication methods:
29+
30+
- Kubernetes
31+
- AppRole
32+
- Token
33+
34+
The authentication methods require a policy that allows the Vault Radar agent to
35+
read all KV secrets from Vault.
2536

2637
### Create a Vault policy
2738

content/hcp-docs/data/docs-nav-data.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -762,10 +762,6 @@
762762
"title": "Secrets inventory reporting<sup>Beta</sup>",
763763
"path": "vault/secrets-inventory"
764764
},
765-
{
766-
"title": "HCP Vault API",
767-
"href": "/hcp/api-docs/vault"
768-
},
769765
{
770766
"title": "Additional resources",
771767
"routes": [
@@ -935,6 +931,10 @@
935931
{
936932
"title": "Integrate Vault Enterprise",
937933
"path": "vault-radar/agent/correlate-vault"
934+
},
935+
{
936+
"title": "Integrate AWS Secrets Manager",
937+
"path": "vault-radar/agent/correlate-aws-secrets-manager"
938938
}
939939
]
940940
},
187 KB
Loading
114 KB
Loading

content/terraform-docs-agents/v1.24.x/docs/cloud-docs/agents/agent-pools.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,12 @@ The workspace begins using the agent for Terraform runs. Runs involving an agent
8686

8787
## Configure Stacks to use the agent
8888

89+
<Note>
90+
91+
Your agents must use v1.25.0 or above to execute Stack deployment runs. To learn more about agent versioning, refer to [Updates](/terraform/cloud-docs/agents/agents#updates).
92+
93+
</Note>
94+
8995
Use the following steps to configure a Stack to use an agent pool.
9096

9197
### Step 1: Manage existing runs

content/terraform-docs-agents/v1.25.x/docs/cloud-docs/agents/agent-pools.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,12 @@ The workspace begins using the agent for Terraform runs. Runs involving an agent
8888

8989
## Configure Stacks to use the agent
9090

91+
<Note>
92+
93+
Your agents must use v1.25.0 or above to execute Stack deployment runs. To learn more about agent versioning, refer to [Updates](/terraform/cloud-docs/agents/agents#updates).
94+
95+
</Note>
96+
9197
Use the following steps to configure a Stack to use an agent pool.
9298

9399
### Step 1: Manage existing runs

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Some of the information returned in a state version API object might be **popula
4949
| `billable-rum-count` | Count of billable Resources Under Management (RUM). Only present for organization members on HCP Terraform RUM plans with visibility of billable RUM usage. |
5050
| `hosted-json-state-download-url` | A URL from which you can download the state data in a [stable format](/terraform/internals/json-format) appropriate for external integrations to consume. Only available if the state was created by Terraform 1.3+. |
5151
| `hosted-state-download-url` | A URL from which you can download the raw state data, in the format used internally by Terraform. |
52-
| `sanitized-state-download-url` | A URL to which you can download state data with sensitive values redacted. |
52+
| `sanitized-state-download-url` | A URL to which you can download state data with sensitive values redacted. This URL is only available for workspaces using [hold your own key](/terraform/cloud-docs/hold-your-own-key) encryption. |
5353
| `hosted-json-state-upload-url` | A URL to which you can upload state data in a [stable format](/terraform/internals/json-format) appropriate for external integrations to consume. You can upload JSON state content once per state version. |
5454
| `hosted-state-upload-url` | A URL to which you can upload state data in the format used Terraform uses internally. You can upload state data once per state version. |
5555
| `hyok-encrypted-data-key` | A reference to the HYOK encrypted data key used to secure this state version. Hold your own key is only available in HCP Terraform, [learn more](/terraform/cloud-docs/hold-your-own-key). |

0 commit comments

Comments
 (0)