Skip to content

Commit

Permalink
Update proxy-proto.md to remove warning about aws load balancer annot…
Browse files Browse the repository at this point in the history
…ations not working (#6097)

Signed-off-by: Luong Vo <[email protected]>
  • Loading branch information
luong-komorebi authored Jan 19, 2024
1 parent 61b6fae commit ea4d4f9
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 20 deletions.
6 changes: 1 addition & 5 deletions site/content/docs/1.25/guides/proxy-proto.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The former cannot be used to load balance TLS traffic, because your cloud provid
So the latter must be used when Contour handles HTTP and HTTPS traffic.

However this leads to a situation where the remote IP address of the client is reported as the inside address of your cloud provider's load balancer.
To rectify the situation, you can add annotations to your service and flags to your Contour Deployment or DaemonSet to enable the [PROXY][0] protocol which forwards the original client IP details to Envoy.
To rectify the situation, you can add annotations to your service and flags to your Contour Deployment or DaemonSet to enable the [PROXY][0] protocol which forwards the original client IP details to Envoy.

## Enable PROXY protocol on your service in GKE

Expand All @@ -35,8 +35,6 @@ spec:
...
```

**NOTE**: The service annotation `service.beta.kubernetes.io/aws-load-balancer-proxy-protocol: '*'` used to toggle the PROXY protocol is found to have no effect on NLBs (Due to this open [issue][2]). Hence, follow the steps mentioned in this AWS [documentation][3] to manually toggle PROXY protocol on NLBs

## Enable PROXY protocol support for all Envoy listening ports

```
Expand All @@ -53,5 +51,3 @@ spec:

[0]: http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt
[1]: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer
[2]: https://github.com/kubernetes/kubernetes/issues/57250
[3]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#enable-proxy-protocol
6 changes: 1 addition & 5 deletions site/content/docs/1.26/guides/proxy-proto.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The former cannot be used to load balance TLS traffic, because your cloud provid
So the latter must be used when Contour handles HTTP and HTTPS traffic.

However this leads to a situation where the remote IP address of the client is reported as the inside address of your cloud provider's load balancer.
To rectify the situation, you can add annotations to your service and flags to your Contour Deployment or DaemonSet to enable the [PROXY][0] protocol which forwards the original client IP details to Envoy.
To rectify the situation, you can add annotations to your service and flags to your Contour Deployment or DaemonSet to enable the [PROXY][0] protocol which forwards the original client IP details to Envoy.

## Enable PROXY protocol on your service in GKE

Expand All @@ -35,8 +35,6 @@ spec:
...
```

**NOTE**: The service annotation `service.beta.kubernetes.io/aws-load-balancer-proxy-protocol: '*'` used to toggle the PROXY protocol is found to have no effect on NLBs (Due to this open [issue][2]). Hence, follow the steps mentioned in this AWS [documentation][3] to manually toggle PROXY protocol on NLBs

## Enable PROXY protocol support for all Envoy listening ports

```
Expand All @@ -53,5 +51,3 @@ spec:

[0]: http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt
[1]: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer
[2]: https://github.com/kubernetes/kubernetes/issues/57250
[3]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#enable-proxy-protocol
6 changes: 1 addition & 5 deletions site/content/docs/1.27/guides/proxy-proto.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The former cannot be used to load balance TLS traffic, because your cloud provid
So the latter must be used when Contour handles HTTP and HTTPS traffic.

However this leads to a situation where the remote IP address of the client is reported as the inside address of your cloud provider's load balancer.
To rectify the situation, you can add annotations to your service and flags to your Contour Deployment or DaemonSet to enable the [PROXY][0] protocol which forwards the original client IP details to Envoy.
To rectify the situation, you can add annotations to your service and flags to your Contour Deployment or DaemonSet to enable the [PROXY][0] protocol which forwards the original client IP details to Envoy.

## Enable PROXY protocol on your service in GKE

Expand All @@ -35,8 +35,6 @@ spec:
...
```

**NOTE**: The service annotation `service.beta.kubernetes.io/aws-load-balancer-proxy-protocol: '*'` used to toggle the PROXY protocol is found to have no effect on NLBs (Due to this open [issue][2]). Hence, follow the steps mentioned in this AWS [documentation][3] to manually toggle PROXY protocol on NLBs

## Enable PROXY protocol support for all Envoy listening ports

```
Expand All @@ -53,5 +51,3 @@ spec:

[0]: http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt
[1]: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer
[2]: https://github.com/kubernetes/kubernetes/issues/57250
[3]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#enable-proxy-protocol
6 changes: 1 addition & 5 deletions site/content/docs/main/guides/proxy-proto.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ spec:
...
```

**NOTE**: The service annotation `service.beta.kubernetes.io/aws-load-balancer-proxy-protocol: '*'` used to toggle the PROXY protocol is found to have no effect on NLBs (Due to this open [issue][2]). Hence, follow the steps mentioned in this AWS [documentation][3] to manually toggle PROXY protocol on NLBs

## Enable PROXY protocol support for all Envoy listening ports

```
Expand All @@ -52,6 +50,4 @@ spec:
```

[0]: http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt
[1]: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer
[2]: https://github.com/kubernetes/kubernetes/issues/57250
[3]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#enable-proxy-protocol
[1]: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer

0 comments on commit ea4d4f9

Please sign in to comment.