Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ Boundary:
- changed-files:
- any-glob-to-any-file: [
'content/boundary/**',
'content/hcp-docs/content/docs/boundary/**'
]

# Add 'Consul' label to changes under 'content/consul'
Expand Down Expand Up @@ -44,6 +43,20 @@ HCP:
'content/hcp-docs/**'
]

# Add 'HCP Boundary' label to changes under 'content/hcp-boundary'
#
# Label | Rule
# --------------- | ------------------------------------------------------------
# HCP Boundary | Default; applies to all doc updates

HCP Boundary:
- any:
- changed-files:
- any-glob-to-any-file: [
'content/hcp-boundary/**',
]


# Add 'Nomad' label to changes under 'content/nomad'
#
# Label | Rule
Expand Down
7 changes: 3 additions & 4 deletions CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@
/content/hcp-docs/img/docs/vault* @hashicorp/vault-education-approvers

# HCP Boundary docs
/content/hcp-docs/content/docs/boundary/ @hashicorp/boundary-education-approvers
/content/hcp-docs/img/docs/boundary/ @hashicorp/boundary-education-approvers
/content/hcp-boundary/ @hashicorp/boundary-education-approvers @hashicorp/boundary

# HCP IAM
/content/hcp-docs/content/partials/hcp-administration/ @hashicorp/education @hashicorp/cloud-access-control @hashicorp/cloud-identity
Expand All @@ -71,7 +70,7 @@
/content/vagrant @hashicorp/Vagrant

# Nomad
/content/nomad/ @hashicorp/nomad-docs @hashicorp/nomad-eng
/content/nomad/ @hashicorp/nomad-docs @hashicorp/nomad-eng

# Packer
/content/packer @hashicorp/team-docs-packer-and-terraform @hashicorp/packer
/content/packer @hashicorp/team-docs-packer-and-terraform @hashicorp/packer
66 changes: 66 additions & 0 deletions content/hcp-boundary/data/hcp-docs-nav-data.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
[
{
"heading": "HCP Boundary"
},
{
"title": "Overview",
"path": ""
},
{
"title": "How HCP Boundary works",
"path": "how-boundary-works"
},
{
"title": "Self-managed worker operations",
"routes": [
{
"title": "Introduction",
"path": "self-managed-workers"
},
{
"title": "High availability and sizing",
"path": "self-managed-workers/size-self-managed-workers"
},
{
"title": "Install self-managed workers",
"path": "self-managed-workers/install-self-managed-workers"
},
{
"title": "Register self-managed workers",
"path": "self-managed-workers/register-self-managed-workers"
},
{
"title": "Manage self-managed workers",
"path": "self-managed-workers/manage-self-managed-workers"
},
{
"title": "Configure session recording",
"path": "self-managed-workers/session-recording"
}
]
},
{
"title": "Audit log streaming",
"path": "audit-logging"
},
{
"title": "Configure auth token TTL",
"path": "configure-ttl"
},
{
"title": "Configure maintenance windows",
"path": "maintenance-window"
},
{
"title": "Support policy",
"path": "support-policy"
},
{
"title": "Get started",
"href": "https://learn.hashicorp.com/collections/boundary/hcp-getting-started"
},
{
"title": "Boundary documentation",
"href": "https://www.boundaryproject.io/docs"
}
]
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ page_title: Audit log streaming
description: |-
Set up audit log streaming for HCP Boundary with AWS CloudWatch or Datadog.
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2026-02-03T10:18:53-05:00
created_at: 2026-03-04T22:41:25.000Z
last_modified: 2026-03-04T22:41:25.000Z
# END AUTO GENERATED METADATA
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ page_title: Configure auth token time to live (TTL)
description: >-
Learn how to configure the time to live (TTL) for the auth token that Boundary controllers issue.
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2025-09-05T13:57:53-05:00
created_at: 2026-03-04T22:41:25.000Z
last_modified: 2026-03-04T22:41:25.000Z
# END AUTO GENERATED METADATA
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ page_title: How HCP Boundary Works
description: |-
Describe the access model and deployment options of HCP Boundary.
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2025-11-11T10:12:07-05:00
created_at: 2026-03-04T22:41:25.000Z
last_modified: 2026-03-04T22:41:25.000Z
# END AUTO GENERATED METADATA
---

Expand Down Expand Up @@ -49,7 +49,7 @@ deployment model, HashiCorp manages the control plane and worker nodes, making i
Self-managed workers allow Boundary users to securely connect to private endpoints without exposing an organization's networks to the public, or to HashiCorp-managed
resources. The organization's worker nodes proxy all session activities. To learn more about self-managed workers see the
self-managed workers [tutorial](/boundary/tutorials/hcp-administration/hcp-manage-workers) and
[operations document](/hcp/docs/boundary/self-managed-workers).
[operations document](/boundary/hcp-docs/self-managed-workers).

![Diagram of user requests flow through the self-managed worker before connecting to the target system.](/img/docs/boundary/self-managed-workers.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ sidebar_title: Overview
description: |-
This topic provides an overview of HCP Boundary, HashiCorp's secure access management solution.
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2025-11-11T10:12:07-05:00
created_at: 2026-03-04T22:41:25.000Z
last_modified: 2026-03-04T22:41:25.000Z
# END AUTO GENERATED METADATA
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ page_title: Configure maintenance windows
description: |-
This topic describes how to configure a maintenance windnow for HCP upgrades and updates.
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2026-01-05T13:16:30-05:00
created_at: 2026-03-04T22:41:25.000Z
last_modified: 2026-03-04T22:41:25.000Z
# END AUTO GENERATED METADATA
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ page_title: Self-managed worker operations
description: |-
Learn how self-managed workers let HCP Boundary users securely connect to private endpoints without exposing their organizations' networks to the public.
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2025-09-05T13:57:53-05:00
created_at: 2026-03-04T22:41:26.000Z
last_modified: 2026-03-04T22:41:26.000Z
# END AUTO GENERATED METADATA
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ page_title: Install self-managed workers
description: |-
Learn how to install and start your own HCP Boundary self-managed workers to securely connect to private endpoints without exposing your network to the public.
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2025-09-05T13:57:53-05:00
created_at: 2026-03-04T22:41:26.000Z
last_modified: 2026-03-04T22:41:26.000Z
# END AUTO GENERATED METADATA
---

# Install self-managed workers

HCP Boundary allows organizations to register and manage their own workers.
You can deploy these [self-managed
workers](/hcp/docs/boundary/self-managed-workers/) in private networks, and they
workers](/boundary/hcp-docs/self-managed-workers/) in private networks, and they
can communicate with an upstream HCP Boundary cluster.

For a step-by-step example of configuring a self-managed worker instance, refer
Expand Down Expand Up @@ -408,7 +408,7 @@ worker configuration file, for example `/home/worker.hcl`.
Note the `Worker Auth Registration Request:` value on line 12. You can also
locate this value in the `auth_request_token` file. You must provide this value
when you [Register a new worker with
HCP](/hcp/docs/boundary/self-managed-workers/register-self-managed-workers).
HCP](/boundary/hcp-docs/self-managed-workers/register-self-managed-workers).

Enter the following command to start the worker:

Expand Down Expand Up @@ -501,5 +501,5 @@ It is also saved to a file, `auth_request_token`,
defined by the `auth_storage_path` in the worker configuration file.

After you install and start the self-managed worker, you must
[register](/hcp/docs/boundary/self-managed-workers/register-self-managed-workers)
[register](/boundary/hcp-docs/self-managed-workers/register-self-managed-workers)
it with HCP in your environment's admin console.
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ page_title: Manage self-managed workers
description: |-
Learn how to view, update, and delete HCP Boundary self-managed workers to manage secure connections to your private endpoints without exposing your network.
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2025-09-05T13:57:53-05:00
created_at: 2026-03-04T22:41:26.000Z
last_modified: 2026-03-04T22:41:26.000Z
# END AUTO GENERATED METADATA
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ page_title: Register self-managed workers
description: |-
Learn how to register and create your own HCP Boundary self-managed workers to securely connect to private endpoints without exposing your network to the public.
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2025-09-05T13:57:53-05:00
created_at: 2026-03-04T22:41:26.000Z
last_modified: 2026-03-04T22:41:26.000Z
# END AUTO GENERATED METADATA
---

# Register self-managed workers

After you [install](/hcp/docs/boundary/self-managed-workers/install-self-managed-workers) and [start](/hcp/docs/boundary/self-managed-workers/install-self-managed-workers#start-the-self-managed-worker) the self-managed worker, you must register it with HCP.
After you [install](/boundary/hcp-docs/self-managed-workers/install-self-managed-workers) and [start](/boundary/hcp-docs/self-managed-workers/install-self-managed-workers#start-the-self-managed-worker) the self-managed worker, you must register it with HCP.
You can use the Admin Console Web UI or Boundary CLI to register self-managed workers.

<Tabs>
Expand All @@ -28,15 +28,15 @@ Complete the following steps to register the worker with HCP using the UI:

1. Click **New**.

1. (Optional) You can construct the contents of the `worker.hcl` file on the new workers page, if you did not [create the configuration file](/hcp/docs/boundary/self-managed-workers/install-self-managed-workers#create-the-self-managed-worker-configuration-file) as part of the installation process.
1. (Optional) You can construct the contents of the `worker.hcl` file on the new workers page, if you did not [create the configuration file](/boundary/hcp-docs/self-managed-workers/install-self-managed-workers#create-the-self-managed-worker-configuration-file) as part of the installation process.
Provide the following details, and Boundary constructs the worker configuration file for you:
- Boundary Cluster ID
- Worker public address
- Config file path
- Worker Tags

1. Scroll to the bottom of the new workers page, and paste the **Worker Auth Registration Request** key.
Boundary provides you with the **Worker Auth Registration Request** key in the CLI output when you [start the self-managed worker](/hcp/docs/boundary/self-managed-workers/install-self-managed-workers#start-the-self-managed-worker).
Boundary provides you with the **Worker Auth Registration Request** key in the CLI output when you [start the self-managed worker](/boundary/hcp-docs/self-managed-workers/install-self-managed-workers#start-the-self-managed-worker).
You can also locate this value in the `auth_request_token` file.

1. Click **Register Worker**.
Expand Down Expand Up @@ -92,7 +92,7 @@ name, and admin password when prompted.
$ export WORKER_TOKEN=<Worker Auth Registration Request Value>
```

Boundary provides you with the **Worker Auth Registration Request** key in the CLI output when you [start the self-managed worker](/hcp/docs/boundary/self-managed-workers/install-self-managed-workers#start-the-self-managed-worker).
Boundary provides you with the **Worker Auth Registration Request** key in the CLI output when you [start the self-managed worker](/boundary/hcp-docs/self-managed-workers/install-self-managed-workers#start-the-self-managed-worker).
You can also locate this value in the `auth_request_token` file.

The token is used to issue a create worker request that will authorize the worker to Boundary and make it available.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ page_title: Configure session recording
description: |-
Learn how to configure self-managed workers to record users' HCP Boundary sessions. You can view the recordings later for auditing purposes.
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2026-01-26T13:56:49-05:00
created_at: 2026-03-04T22:41:26.000Z
last_modified: 2026-03-04T22:41:26.000Z
# END AUTO GENERATED METADATA
---

Expand Down Expand Up @@ -55,6 +55,6 @@ When the session is closed, the recording is moved to remote storage and Boundar

## Next steps

1. [Register the self-managed worker](/hcp/docs/boundary/self-managed-workers/register-self-managed-workers), if it is not already registered.
1. [Register the self-managed worker](/boundary/hcp-docs/self-managed-workers/register-self-managed-workers), if it is not already registered.
1. [Create a storage bucket](/boundary/docs/configuration/session-recording/create-storage-bucket).
1. [Enable session recording on a target](/boundary/docs/configuration/session-recording/enable-session-recording).
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ page_title: Recommendations for High Availability
description: |-
Learn best practices for configuring and sizing HCP Boundary self-managed workers for high availability.
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2025-09-05T13:57:53-05:00
created_at: 2026-03-04T22:41:26.000Z
last_modified: 2026-03-04T22:41:26.000Z
# END AUTO GENERATED METADATA
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ page_title: HCP Boundary Support Policy for Self-Managed Workers & Boundary Clie
description: |-
This topic provides recommendations for upgrading and maintaining HCP Boundary self-managed worker and Boundary client versions
# START AUTO GENERATED METADATA, DO NOT EDIT
created_at: 2025-09-05T13:57:53-05:00
last_modified: 2025-09-05T13:57:53-05:00
created_at: 2026-03-04T22:41:27.000Z
last_modified: 2026-03-04T22:41:27.000Z
# END AUTO GENERATED METADATA
---

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<EnterpriseAlert product="boundary">This feature requires <a href="https://www.hashicorp.com/products/boundary">HCP Boundary Plus</a>.</EnterpriseAlert>
26 changes: 26 additions & 0 deletions content/hcp-boundary/redirects.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/**
* Redirects in this file are intended to be for documentation content only.
* The redirects will be applied to developer.hashicorp.com.
*/
[
{
"source": "/hcp/docs/boundary",
"destination": "/boundary/hcp-docs",
"permanent": true,
},
{
"source": "/hcp/docs/boundary/self-managed-workers/support-considerations",
"destination": "/boundary/hcp-docs/support-policy",
"permanent": true,
},
{
"source": "/hcp/docs/boundary/security-model",
"destination": "/boundary/hcp-docs/how-boundary-works",
"permanent": true,
},
{
"source": "/hcp/docs/boundary/:path*",
"destination": "/boundary/hcp-docs/:path*",
"permanent": true,
}
]
Loading
Loading