Skip to content

Commit ea7ed5c

Browse files
Update index.mdx - public_addr note for HCP workers (#5287)
* Update index.mdx - public_addr note for HCP workers Added a note that the public_addr is not needed if connecting to HCP worker in multi-hop sessions * Update index.mdx * Update index.mdx changed to active voice per Robin's suggestion * fix hcp_boundary_cluster_id note --------- Co-authored-by: stellarsquall <[email protected]>
1 parent f2c84ad commit ea7ed5c

File tree

1 file changed

+4
-2
lines changed
  • website/content/docs/configuration/worker

1 file changed

+4
-2
lines changed

website/content/docs/configuration/worker/index.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ worker {
6262
useful for cloud environments that do not bind a publicly accessible IP to a
6363
NIC on the host directly, such as an Amazon EIP.
6464

65+
You should omit this parameter in multi-hop configurations if this self-managed worker connects to an upstream HCP-managed worker.
66+
6567
This value can reference any of the following:
6668
- a direct address string
6769
- a file on disk (file://) from which an address will be read
@@ -75,8 +77,8 @@ worker {
7577
using env or file, their contents must formatted as a JSON array:
7678
`["127.0.0.1", "192.168.0.1", "10.0.0.1"]`
7779

78-
HCP Boundary workers require the [`hcp_boundary_cluster_id`](/boundary/docs/configuration/worker/#hcp_boundary_cluster_id) parameter instead of `initial upstreams`.
79-
If you configure an HCP worker with `initial_upstreams`, the worker configuration fails.
80+
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.
81+
If you configure a self-managed worker with both `initial_upstreams` and `hcp_boundary_cluster_id`, the worker configuration fails.
8082

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

0 commit comments

Comments
 (0)