Skip to content

Commit 1dd2dee

Browse files
authored
Update docs for service.beta.kubernetes.io/aws-load-balancer-type annotation (#4578)
1 parent 898d0b9 commit 1dd2dee

File tree

4 files changed

+12
-8
lines changed

4 files changed

+12
-8
lines changed

docs/deploy/installation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ The LBC is supported by AWS. Some clusters may be using the legacy "in-tree" fun
1111
!!!warning "When using AWS Load Balancer Controller v2.5+"
1212
The AWS LBC provides a mutating webhook for service resources to set the `spec.loadBalancerClass` field for service of type LoadBalancer on create.
1313
This makes the AWS LBC the **default controller for service** of type LoadBalancer. You can disable this feature and revert to set Cloud Controller Manager (in-tree controller) as the default by setting the helm chart value **enableServiceMutatorWebhook to false** with `--set enableServiceMutatorWebhook=false` .
14-
You will no longer be able to provision new Classic Load Balancer (CLB) from your kubernetes service unless you disable this feature. Existing CLB will continue to work fine.
14+
You will no longer be able to provision new Classic Load Balancer (CLB) from your kubernetes service unless you disable this feature. Existing CLB will continue to work fine.
15+
16+
If you are updating the `type` of an existing Service to `LoadBalancer`, the webhook **will not** run. If you want the LBC to be the controller for your Service, you must specify it explicitly. [See instructions](../guide/service/nlb.md).
1517

1618
## Supported Kubernetes versions
1719
* AWS Load Balancer Controller v2.0.0~v2.1.3 requires Kubernetes 1.15-1.21

docs/guide/service/annotations.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,9 @@ Traffic Routing can be controlled with following annotations:
9292
- [Deprecated] For type `nlb-ip`, the controller will provision an NLB with targets registered by IP address. This value is supported for backwards compatibility.
9393
- For type `external`, the NLB target type depends on the [nlb-target-type](#nlb-target-type) annotation.
9494

95-
!!!warning "limitations"
96-
- This annotation should not be modified after service creation.
95+
!!!warning "Limitations"
96+
- Do not add or modify this annotation on an existing Service.
97+
- Adding or modifying this annotation on an existing Service can result in misconfigured resources, such as leaked AWS resources or exposing your NLB to the internet.
9798

9899
!!!example
99100
```

docs/guide/service/nlb.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,10 @@ In order for the LBC to manage the reconciliation of Kubernetes Service resource
9393

9494
When you specify the [`service.beta.kubernetes.io/aws-load-balancer-type` annotation](./annotations.md#lb-type) to be `external` on a Kubernetes Service resource of type `LoadBalancer`, the in-tree controller ignores the Service resource. In addition, if you specify the [`service.beta.kubernetes.io/aws-load-balancer-nlb-target-type` annotation](./annotations.md#nlb-target-type) on the Service resource, the LBC takes charge of reconciliation by provisioning an NLB.
9595

96-
!!! warning
97-
- It's not recommended to modify or add the `service.beta.kubernetes.io/aws-load-balancer-type` annotation on an existing Service resource. If a change is desired, delete the existing Service resource and create a new one instead of modifying an existing Service.
98-
99-
- If you modify this annotation on an existing Service resource, you might end up with leaked LBC resources.
96+
!!! warning "Limitations"
97+
- Do not add or modify the `service.beta.kubernetes.io/aws-load-balancer-type` annotation on an existing Service.
98+
- Adding or modifying this annotation on an existing Service can result in misconfigured resources, such as leaked AWS resources or exposing your NLB to the internet.
99+
- If a change is desired, delete the existing Service resource and create a new one instead of modifying an existing Service.
100100

101101
!!! note "backwards compatibility for `nlb-ip` type"
102102
For backwards compatibility, both the in-tree and LBC controller supports `nlb-ip` as a value for the `service.beta.kubernetes.io/aws-load-balancer-type` annotation. The controllers treats it as if you specified both of the following annotations:

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@ markdown_extensions:
9494
- pymdownx.tasklist:
9595
custom_checkbox: true
9696
- pymdownx.superfences
97-
- pymdownx.tabbed
97+
- pymdownx.tabbed:
98+
alternate_style: true
9899
- pymdownx.emoji:
99100
emoji_index: !!python/name:material.extensions.emoji.twemoji
100101
emoji_generator: !!python/name:material.extensions.emoji.to_svg

0 commit comments

Comments
 (0)