Skip to content

Commit 96a3fb5

Browse files
authored
Merge branch 'main' into joshathc/update-copy-secrets
2 parents 2f488ae + e44237d commit 96a3fb5

File tree

191 files changed

+6168
-1416
lines changed

Some content is hidden

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

191 files changed

+6168
-1416
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
### What
2+
<!-- Explain what you changed and provide a list of changed page names. -->
3+
4+
### Why
5+
<!-- Explain why this change is necessary and how it benefits users. -->
6+
7+
### Screenshots
8+
<!-- Optional. Show additions to the sidebar or new formatting. -->
9+
10+
----------
11+
12+
### Merge Checklist
13+
_If items do not apply to your changes, add (N/A) and mark them as complete._
14+
15+
#### Pull Request
16+
- [ ] Description links to related pull requests or issues, if any.
17+
18+
#### Content
19+
- [ ] Redirects have been added to `content/terraform-docs-common/redirects.jsonc` for moved, renamed, or deleted pages.
20+
- [ ] API documentation and the API Changelog have been updated.
21+
- [ ] Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
22+
- [ ] Pages with related content are updated and link to this content when appropriate.
23+
- [ ] Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
24+
- [ ] New pages have metadata (page name and description) at the top.
25+
- [ ] New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
26+
- [ ] New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
27+
- [ ] UI elements (button names, page names, etc.) are bolded.
28+
- [ ] The Vercel website preview successfully deployed.
29+
30+
#### Reviews
31+
- [ ] I or someone else reviewed the content for technical accuracy.
32+
- [ ] I or someone else reviewed the content for typos, punctuation, spelling, and grammar.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
### What
2+
<!-- Explain what you changed and provide a list of changed page names. -->
3+
4+
### Why
5+
<!-- Explain why this change is necessary and how it benefits users. -->
6+
7+
### Screenshots
8+
<!-- Optional. Show additions to the sidebar or new formatting. -->
9+
10+
----------
11+
12+
### Merge Checklist
13+
_If items do not apply to your changes, add (N/A) and mark them as complete._
14+
15+
#### Pull Request
16+
- [ ] Description links to related pull requests or issues, if any.
17+
18+
#### Content
19+
- [ ] You added redirects to `content/terraform-docs-common/redirects.jsonc` for moved, renamed, or deleted pages **across all affected versions**. Refer to [Redirects](https://github.com/hashicorp/web-unified-docs/blob/main/docs/content-guide/redirects.md#example-redirects) for examples and guidance.
20+
- [ ] Links to related content where appropriate (e.g., CLI, language, API endpoints, permissions, etc.).
21+
- [ ] Pages with related content are updated and link to this content when appropriate.
22+
- [ ] Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
23+
- [ ] New pages have metadata (page name and description) at the top.
24+
- [ ] New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
25+
- [ ] New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
26+
- [ ] UI elements (button names, page names, etc.) are bolded.
27+
- [ ] The Vercel website preview successfully deployed.
28+
29+
#### Reviews
30+
- [ ] I or someone else reviewed the content for technical accuracy.
31+
- [ ] I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

.github/advanced-issue-labeler.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ policy:
1414
- name: 'Boundary'
1515
keys: ['Boundary']
1616
- name: 'Consul'
17-
keys: ['Consul', 'Runtime']
17+
keys: ['Consul']
1818
- name: 'HCP'
1919
keys: ['HashiCorp Cloud Platform']
2020
- name: 'Nomad'
21-
keys: ['Nomad', 'Runtime']
21+
keys: ['Nomad']
2222
- name: 'Packer'
2323
keys: ['Packer']
2424
- name: 'Sentinel'
@@ -35,4 +35,6 @@ policy:
3535
keys: ['Waypoint']
3636
- name: 'Triage'
3737
keys: ['No product', 'Other product']
38+
- name: 'Runtime'
39+
keys: ['Nomad', 'Consul']
3840

.github/labeler.yml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,19 @@ HCP:
4444
'content/hcp-docs/**'
4545
]
4646

47+
# Add 'Nomad' label to changes under 'content/nomad'
48+
#
49+
# Label | Rule
50+
# --------------- | ------------------------------------------------------------
51+
# Nomad | Default; applies to all doc updates
52+
53+
Nomad:
54+
- any:
55+
- changed-files:
56+
- any-glob-to-any-file: [
57+
'content/nomad/**'
58+
]
59+
4760
# Add 'Packer' label to changes under 'content/packer'
4861
#
4962
# Label | Rule
@@ -217,19 +230,6 @@ Waypoint:
217230
'content/hcp-docs/content/docs/waypoint/**'
218231
]
219232

220-
# Add 'HCP Docs' label to changes under 'content/hcp-docs'
221-
#
222-
# Label | Rule
223-
# --------------- | ------------------------------------------------------------
224-
# HCP Docs | Default; applies to all doc updates
225-
226-
HCP Docs:
227-
- any:
228-
- changed-files:
229-
- any-glob-to-any-file: [
230-
'content/hcp-docs/**'
231-
]
232-
233233
# Add 'Runtime' label to changes under 'content/consul', 'content/nomad', 'content/hcp-docs/content/docs/cli' and 'content/hcp-docs/content/docs/hcp'
234234
#
235235
# Label | Rule
@@ -245,8 +245,8 @@ Runtime:
245245
- any:
246246
- changed-files:
247247
- any-glob-to-any-file: [
248-
'content/consul/**'
249-
'content/nomad/**'
250-
'content/hcp-docs/content/docs/cli/**'
248+
'content/consul/**',
249+
'content/nomad/**',
250+
'content/hcp-docs/content/docs/cli/**',
251251
'content/hcp-docs/content/docs/hcp/**'
252252
]

.github/pull_request_template.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,9 @@ Please go to the `Preview` tab and select the appropriate template:
33
* [Consul](?expand=1&labels=Consul&title=Consul+Docs&template=consul_pull_request_template.md)
44
* [HCP services](?expand=1&template=hcp_pull_request_template.md)
55
* [Nomad](?expand=1&labels=Nomad&title=Nomad+Docs&template=nomad_pull_request_template.md)
6+
7+
### Terraform
8+
9+
* [HCP Terraform](?expand=1&labels=hcp,terraform&title=HCP+Terraform+Docs&template=hcp_terraform_pull_request_template.md)
10+
* [Terraform](?expand=1&labels=terraform&title=Terraform+Docs&template=terraform_pull_request_template.md)
611
* [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)

content/hcp-docs/content/docs/vault/get-started/access-cluster.mdx

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ description: |-
77

88
# Access a cluster
99

10-
HCP Vault Dedicated clusters, like self-managed Vault Enterprise clusters, can be accessed
11-
using:
10+
You can access your HCP Vault Dedicated clusters, like self-managed Vault Enterprise clusters,
11+
using the:
1212

1313
- [Vault command-line interface (CLI)](#cli-access)
1414
- [Application programming interface (API)](#api-access)
@@ -19,35 +19,44 @@ token](/hcp/docs/vault/get-started/generate-admin-token), or a token generated
1919
from a [Vault auth method](/vault/docs/auth).
2020

2121
Before you can access the Vault cluster, you must retrieve the cluster URL. When
22-
a Vault cluster is deployed with the cluster accessibility option set to
23-
**Private** you can use the private URL from [the HCP Portal](https://portal.cloud.hashicorp.com/) to connect from
24-
any device in a network that has a connection to the HashiCorp Virtual Network
22+
you deploy a Vault cluster with the cluster accessibility option set to
23+
**Private** you can use the private URL from [the HCP
24+
Portal](https://portal.cloud.hashicorp.com/) to connect from any device in a
25+
network that has a connection to the HashiCorp Virtual Network
2526
such as peering connection for Amazon Web Services or Microsoft Azure. Refer to
2627
the [HashiCorp Virtual Network documentation](/hcp/docs/hcp/network) for more
2728
information on supported connectivity options.
2829

29-
When the cluster accessibility option is set to **Public**, you can connect to
30+
When you set the cluster accessibility option to **Public**, you can connect using
3031
any internet connected device.
3132

3233
<Highlight title="Recommended practice for HCP administrators">
3334

34-
If your use case requires that you set the cluster accessibility option to
35-
public, we recommend you manage which addresses can connect to HCP Vault Dedicated using
36-
the IP allow list.
35+
If your use case requires the cluster accessibility option to
36+
public, we recommend you manage which addresses can connect to HCP Vault
37+
Dedicated using the IP allow list.
3738

3839
</Highlight>
3940

4041
## Retrieve HCP Vault Dedicated cluster address
4142

4243
Log into the [HCP Portal](https://portal.cloud.hashicorp.com/) and navigate to
43-
the Vault cluster you wish to access.
44+
the Vault cluster you want to access.
4445

4546
From the **Vault cluster** page, click either the **Private** or **Public**
4647
link to copy the address to your clipboard.
4748
![HCP Portal showing the HCP Vault Dedicated cluster overview page with the cluster
4849
URLs window highlighted with both a public and private URL link
4950
available](/img/docs/vault/ui-hcp-portal-vault-url.png)
5051

52+
<Highlight title="Supported TCP ports">
53+
54+
By default, you connect to Vault using Vault's standard port, `8200`. If your
55+
security policies require a different port, create a support ticket to have
56+
either port `443` or `8207` enabled for your HCP Vault Dedicated cluster.
57+
58+
</Highlight>
59+
5160
## Environment variables
5261

5362
For convenience, you can set the following environment variables:
@@ -57,15 +66,15 @@ For convenience, you can set the following environment variables:
5766
- `VAULT_NAMESPACE`: Set it to the target namespace to operate on (the top-level
5867
namespace is `admin`)
5968

60-
**Example:** The following command sets environment variables for the [admin
69+
The following command sets environment variables for the [admin
6170
token](/hcp/docs/vault/get-started/generate-admin-token), cluster URL, and
6271
namespace.
6372

6473
```shell-session
6574
$ export \
6675
VAULT_ADDR=https://<vault-cluster-address:8200> \
6776
VAULT_NAMESPACE=admin \
68-
VAULT_TOKEN=hvs.<foo...>
77+
VAULT_TOKEN=hvs.1234567890abcdef
6978
```
7079

7180
Refer to the Vault documentation for the list of Vault specific [environment

content/nomad/v1.10.x/content/docs/job-specification/volume.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ the [volume_mount][volume_mount] block in the `task` configuration.
8181
group always receives the volume with the same ID, if available. Use sticky
8282
volumes for [stateful deployments]. You may only use the `sticky` field for
8383
dynamic host volumes. For CSI volumes, the `per_alloc` field provides similar
84-
functionality
84+
functionality.
8585

8686
- `per_alloc` `(bool: false)` - Specifies that the `source` of the volume
8787
should have the suffix `[n]`, where `n` is the allocation index. This allows
@@ -92,8 +92,11 @@ the [volume_mount][volume_mount] block in the `task` configuration.
9292

9393
The `per_alloc` field cannot be true for system jobs, sysbatch jobs, or jobs
9494
that use canaries. `per_alloc` is mutually exclusive with the `sticky`
95-
property. Use `per_alloc` only with CSI volumes and `sticky` only
96-
with dynamic host volumes.
95+
property. If you use `per_alloc` with dynamic host volumes, you are
96+
responsible for ensuring that the volumes have unique volume names. Unless you
97+
need multiple allocations for the same job to use dynamic host volumes on the
98+
same host, we recommend using `sticky` for dynamic host volumes and
99+
`per_alloc` for CSI volumes.
97100

98101
The following fields are only valid for volumes with `type = "csi"` or dynamic
99102
host volumes with `type = "host"`:

content/nomad/v1.11.x/content/docs/job-specification/secret.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ as an example, you would reference the value in the secret key "foo" as
7979

8080
Config parameters:
8181

82-
- `engine` `(string: "kv_v2")` - Specifies what Vault storage engine to
83-
query. Options are `kv_v1` and `kv_v2`.
82+
- `engine` `(string: "kv")` - Specifies what Vault storage engine to
83+
query. Options are `kv` and `kv_v2`.
8484

8585

8686
## Custom providers

content/nomad/v1.11.x/content/docs/job-specification/volume.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ the [volume_mount][volume_mount] block in the `task` configuration.
8181
group always receives the volume with the same ID, if available. Use sticky
8282
volumes for [stateful deployments]. You may only use the `sticky` field for
8383
dynamic host volumes. For CSI volumes, the `per_alloc` field provides similar
84-
functionality
84+
functionality.
8585

8686
- `per_alloc` `(bool: false)` - Specifies that the `source` of the volume
8787
should have the suffix `[n]`, where `n` is the allocation index. This allows
@@ -92,8 +92,11 @@ the [volume_mount][volume_mount] block in the `task` configuration.
9292

9393
The `per_alloc` field cannot be true for system jobs, sysbatch jobs, or jobs
9494
that use canaries. `per_alloc` is mutually exclusive with the `sticky`
95-
property. Use `per_alloc` only with CSI volumes and `sticky` only
96-
with dynamic host volumes.
95+
property. If you use `per_alloc` with dynamic host volumes, you are
96+
responsible for ensuring that the volumes have unique volume names. Unless you
97+
need multiple allocations for the same job to use dynamic host volumes on the
98+
same host, we recommend using `sticky` for dynamic host volumes and
99+
`per_alloc` for CSI volumes.
97100

98101
The following fields are only valid for volumes with `type = "csi"` or dynamic
99102
host volumes with `type = "host"`:

content/terraform/v1.12.x/docs/language/meta-arguments/provider.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ type name. Note that the `provider` argument is distinct from the [`provider` bl
1111

1212
## Usage
1313

14-
By default, Terraform determines the local name of the provider from the first word in the resource type and uses that provider's default configuration to create the resource. For example, the resource type `google_compute_instance` automatically uses the default configuration for the `google` provider.
14+
By default, Terraform determines the local name of the provider from the first word in the resource type and uses that provider's default configuration to create the resource. For example, the resource type `google_compute_instance` automatically uses the default configuration for the `google` provider.
1515

1616
You can add multiple `provider` blocks to your configuration and use the `provider` argument to a resource definition to specify which provider it should use. For its value, the `provider` argument expects a reference formatted as `<PROVIDER>.<ALIAS>`. In the following example, the `google_compute_instance` resource selects the provider configuration with the `europe` alias.
1717

@@ -31,11 +31,11 @@ resource "google_compute_instance" "example" {
3131
}
3232
```
3333

34-
Quotation marks are not required. Arbitrary expressions are not permitted because Terraform must resolve the `provider` value while constructing the dependency graph before Terraform can safely evaluate expressions.
34+
Quotation marks are not required. Arbitrary expressions are not permitted because Terraform must resolve the `provider` value while constructing the dependency graph before Terraform can safely evaluate expressions.
3535

3636
A resource always has an implicit dependency on its associated provider. This ensures that the provider is fully configured before Terraform takes any actions on resources.
3737

38-
Creating multiple configurations for a single provider is a common pattern for managing resources in different regions of multi-region services.
38+
Creating multiple configurations for a single provider is a common pattern for managing resources in different regions of multi-region services.
3939

4040
## Supported constructs
4141

@@ -44,7 +44,7 @@ You can use `provider` in the following Terraform configuration blocks:
4444
- [`check` blocks](/terraform/language/block/check)
4545
- [`data` blocks](/terraform/language/block/data)
4646
- [`ephemeral` blocks](/terraform/language/block/ephemeral)
47-
- [`import` block ](/terraform/language/block/import)
47+
- [`import` block](/terraform/language/block/import)
4848
- [`resource` blocks](/terraform/language/block/resource)
4949

5050
## Example use cases
@@ -114,4 +114,4 @@ import {
114114
resource "aws_instance" "web" {
115115
# ...
116116
}
117-
```
117+
```

0 commit comments

Comments
 (0)