Skip to content

Commit

Permalink
chore: clarify how to get internal NLB (kubernetes-sigs#2356)
Browse files Browse the repository at this point in the history
* chore: specify how to get classic nlb type

Adding clarifications about the current annotation "service.beta.kubernetes.io/aws-load-balancer-type: external" as it sounds confusing and does not show that an "internal" NLB can be achieved using that type.

* Move deprecation note to line start

* add tip about provisioning internal lb

* fix: only nlb can be provisioned

* chore: change to Internet-facing

Co-authored-by: Steven E. Harris <seh@panix.com>

* Update docs/guide/service/annotations.md

* Update docs/guide/service/annotations.md

* Update docs/guide/service/annotations.md

Co-authored-by: Steven E. Harris <seh@panix.com>

Co-authored-by: Steven E. Harris <seh@panix.com>
Co-authored-by: Kishor Joshi <joshikis@amazon.com>
  • Loading branch information
3 people authored Dec 3, 2021
1 parent 8bd25d2 commit f736deb
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/guide/service/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,12 @@ Traffic Routing can be controlled with following annotations:

- <a name="lb-type">`service.beta.kubernetes.io/aws-load-balancer-type`</a> specifies the load balancer type. This controller reconciles those service resources with this annotation set to either `nlb-ip` or `external`.

!!!tip
This annotation specifies the controller used to provision LoadBalancers (as specified in [legacy-cloud-provider](#legacy-cloud-provider)). Refer to [lb-scheme](#lb-scheme) to specify whether the LoadBalancer is internet-facing or internal.

!!!note ""
- For `nlb-ip` type, controller will provision NLB with IP targets. This value is supported for backwards compatibility
- For `external` type, NLB target type depend on the annotation [nlb-target-type](#nlb-target-type)
- [Deprecated] For type `nlb-ip`, the controller will provision an NLB with targets registered by IP address. This value is supported for backwards compatibility.
- For type `external`, the NLB target type depends on the [nlb-target-type](#nlb-target-type) annotation.

!!!warning "limitations"
- This annotation should not be modified after service creation.
Expand Down

0 comments on commit f736deb

Please sign in to comment.