Skip to content

Commit

Permalink
Update Internal Load Balancer docs (#10062)
Browse files Browse the repository at this point in the history
* Update internal load balancer doc

Signed-off-by: z1cheng <[email protected]>

* Fix incorrect description

Signed-off-by: z1cheng <[email protected]>

* GenerateREADME.md using helm-docs

Signed-off-by: z1cheng <[email protected]>

* Regenerate the docs

Signed-off-by: z1cheng <[email protected]>

---------

Signed-off-by: z1cheng <[email protected]>
  • Loading branch information
z1cheng authored Jun 8, 2023
1 parent 4c00085 commit 5bfc566
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
8 changes: 6 additions & 2 deletions charts/ingress-nginx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,10 @@ controller:
internal:
enabled: true
annotations:
# Create internal ELB
service.beta.kubernetes.io/aws-load-balancer-internal: "true"
# Create internal NLB
service.beta.kubernetes.io/aws-load-balancer-scheme: "internet-facing"
# Create internal ELB(Deprecated)
# service.beta.kubernetes.io/aws-load-balancer-internal: "true"
# Any other annotation can be declared here.
```

Expand Down Expand Up @@ -187,6 +189,8 @@ controller:
# Any other annotation can be declared here.
```

The load balancer annotations of more cloud service providers can be found: [Internal load balancer](https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer).

An use case for this scenario is having a split-view DNS setup where the public zone CNAME records point to the external balancer URL while the private zone CNAME records point to the internal balancer URL. This way, you only need one ingress kubernetes object.

Optionally you can set `controller.service.loadBalancerIP` if you need a static IP for the resulting `LoadBalancer`.
Expand Down
8 changes: 6 additions & 2 deletions charts/ingress-nginx/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,10 @@ controller:
internal:
enabled: true
annotations:
# Create internal ELB
service.beta.kubernetes.io/aws-load-balancer-internal: "true"
# Create internal NLB
service.beta.kubernetes.io/aws-load-balancer-scheme: "internet-facing"
# Create internal ELB(Deprecated)
# service.beta.kubernetes.io/aws-load-balancer-internal: "true"
# Any other annotation can be declared here.
```

Expand Down Expand Up @@ -184,6 +186,8 @@ controller:
# Any other annotation can be declared here.
```

The load balancer annotations of more cloud service providers can be found: [Internal load balancer](https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer).

An use case for this scenario is having a split-view DNS setup where the public zone CNAME records point to the external balancer URL while the private zone CNAME records point to the internal balancer URL. This way, you only need one ingress kubernetes object.

Optionally you can set `controller.service.loadBalancerIP` if you need a static IP for the resulting `LoadBalancer`.
Expand Down

0 comments on commit 5bfc566

Please sign in to comment.