Skip to content

Commit

Permalink
docs: warn about UID overlap between workload and Envoy tproxy
Browse files Browse the repository at this point in the history
When using transparent proxy mode with the `connect` block, the UID of the
workload cannot be the same as the UID of the Envoy sidecar (currently 101 in
the default Envoy container image).

Fixes: #23508
  • Loading branch information
tgross committed Oct 24, 2024
1 parent 4e8f596 commit 851e44c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
3 changes: 3 additions & 0 deletions website/content/docs/integrations/consul/service-mesh.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,8 @@ Using transparent proxy has several important requirements:
`client_addr`).
* The Consul agent must be configured with [`recursors`][] if you want
allocations to make DNS queries for applications outside the service mesh.
* Your workload's task cannot use the same [Unix user ID (UID)][uid] as the
Envoy sidecar proxy.
* You cannot set a [`network.dns`][] block on the allocation (unless you set
[`no_dns`][tproxy_no_dns], see below).

Expand Down Expand Up @@ -515,3 +517,4 @@ nomad node meta apply -node-id $nodeID \
[consul_dns_port]: /consul/docs/agent/config/config-files#dns_port
[`network.dns`]: /nomad/docs/job-specification/network#dns-parameters
[`client.meta`]: /nomad/docs/configuration/client#meta
[uid]: /nomad/docs/job-specification/transparent_proxy#uid
5 changes: 4 additions & 1 deletion website/content/docs/job-specification/transparent_proxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Using transparent proxy has some important restrictions:
[`no_dns`](#no_dns), see below).
* The node where the allocation is placed must be configured as described in
the Service Mesh integration documentation for [Transparent Proxy][].
* The workload's task cannot use the same Unix user ID (UID) as the Envoy
sidecar proxy.

## `transparent_proxy` Parameters

Expand Down Expand Up @@ -78,7 +80,8 @@ Using transparent proxy has some important restrictions:
* `uid` `(string "101")` - The Unix user ID (UID) used by the Envoy proxy. You
should only set this value if you have a custom build of the Envoy container
image which uses a different UID. You can change the default value for a given
node via [client metadata](#client-metadata) (see below).
node via [client metadata](#client-metadata) (see below). Note that your
workload's task cannot use the same UID as the Envoy sidecar proxy.

## Client Metadata

Expand Down

0 comments on commit 851e44c

Please sign in to comment.