Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update index.mdx - public_addr note for HCP workers #5287

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update index.mdx - public_addr note for HCP workers #5287

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b4f9dd
Update index.mdx - public_addr note for HCP workers
vanphan24 Nov 25, 2024
53e215f
Update index.mdx
vanphan24 Nov 25, 2024
c51de65
Update index.mdx
vanphan24 Nov 25, 2024
bd31b6f
fix hcp_boundary_cluster_id note
stellarsquall Nov 26, 2024
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
6 changes: 4 additions & 2 deletions website/content/docs/configuration/worker/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ worker {
useful for cloud environments that do not bind a publicly accessible IP to a
NIC on the host directly, such as an Amazon EIP.

You should omit this parameter in multi-hop configurations if this self-managed worker connects to an upstream HCP-managed worker.

This value can reference any of the following:
- a direct address string
- a file on disk (file://) from which an address will be read
Expand All @@ -75,8 +77,8 @@ worker {
using env or file, their contents must formatted as a JSON array:
`["127.0.0.1", "192.168.0.1", "10.0.0.1"]`

HCP Boundary workers require the [`hcp_boundary_cluster_id`](/boundary/docs/configuration/worker/#hcp_boundary_cluster_id) parameter instead of `initial upstreams`.
If you configure an HCP worker with `initial_upstreams`, the worker configuration fails.
Self-managed workers connecting to HCP Boundary require the [`hcp_boundary_cluster_id`](/boundary/docs/configuration/worker/#hcp_boundary_cluster_id) parameter instead of `initial upstreams`, unless you are configuring an HCP-managed worker as an ingress worker.
If you configure a self-managed worker with both `initial_upstreams` and `hcp_boundary_cluster_id`, the worker configuration fails.

- `hcp_boundary_cluster_id` - A string required to configure workers using worker-led or controller-led registration
to connect to your HCP Boundary cluster rather than specifying
Expand Down