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.

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

docs: Enable proxy protocol on ingress-nginx controller installation #4082

Merged
merged 7 commits into from
Jul 4, 2024
Merged
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
3 changes: 3 additions & 0 deletions docs/install/kubernetes/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ controller:
configNameSpace: $(POD_NAMESPACE)/udp-services
config:
proxy-body-size: "0"
use-proxy-protocol: true
service:
# AWS Annotations for LoadBalaner with Certificate ARN
annotations:
Expand All @@ -122,9 +123,11 @@ controller:
service.beta.kubernetes.io/aws-load-balancer-ssl-ports: "443"
service.beta.kubernetes.io/aws-load-balancer-type: "nlb"
service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout: "120"
service.beta.kubernetes.io/aws-load-balancer-target-group-attributes: proxy_protocol_v2.enabled=true
# TLS (https) terminated at ELB, so internal endpoint is 'http'
targetPorts:
https: http
externalTrafficPolicy: Cluster
ingressClassResource:
default: true
```
Expand Down
3 changes: 3 additions & 0 deletions docs/install/kubernetes/aws_terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ controller:
configNameSpace: $(POD_NAMESPACE)/udp-services
config:
proxy-body-size: "0"
use-proxy-protocol: true
service:
# AWS Annotations for LoadBalaner with Certificate ARN
annotations:
Expand All @@ -221,9 +222,11 @@ controller:
service.beta.kubernetes.io/aws-load-balancer-ssl-ports: "443"
service.beta.kubernetes.io/aws-load-balancer-type: "nlb"
service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout: "120"
service.beta.kubernetes.io/aws-load-balancer-target-group-attributes: proxy_protocol_v2.enabled=true
# TLS (https) terminated at ELB, so internal endpoint is 'http'
targetPorts:
https: http
externalTrafficPolicy: Cluster
ingressClassResource:
default: true
```
Expand Down
2 changes: 2 additions & 0 deletions docs/install/kubernetes/digital-ocean.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ helm --kubeconfig=./k8s-flowforge-kubeconfig.yaml install nginx-ingress \
--set controller.publishService.enabled=true \
--set controller.ingressClassResource.default=true \
--set controller.config.proxy-body-size="0" \
--set controller.config.use-proxy-protocol="true" \
--set controller.service.annotations."service\.beta\.kubernetes\.io\/do-loadbalancer-enable-proxy-protocol"="true" \
--wait

```
Expand Down
24 changes: 24 additions & 0 deletions docs/upgrade/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,30 @@ Details of how to upgrade can be found for each deployment model:
- [Kubernetes](../install/kubernetes/README.md#upgrade)


### Upgrading to 2.6.0


#### Required AWS EKS configuration change

This release introduces the new Embedded Editor which integrates the Node-RED editor with the FlowFuse dashboard when using Node-RED 4.0. This has required some changes to be made on how certain HTTP headers are passed between the NGINX Ingress controller and AWS NLB.

The following configuration change must be applied otherwise users will not be able to login to Node-RED 4.0 instances.

The following configuration needs to be added in the values passed to the ingress-nginx helm chart. See [full configuration](https://flowfuse.com/docs/install/kubernetes/aws/#nginx-ingress) for the reference.

```
controller:
config:
use-proxy-protocol: true
service:
annotations:
service.beta.kubernetes.io/aws-load-balancer-target-group-attributes: proxy_protocol_v2.enabled=true
externalTrafficPolicy: Cluster
```

The Proxy Protocol feature will be enabled only on newly created Target Groups.
To enable the Proxy Protocol on an existing Target Group, manual intervention is required. For detailed instructions, please refer to the [official AWS documentation](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#enable-proxy-protocol).

### Upgrading to 2.0.0

> **⚠️** Breaking changes introduced!
Expand Down