Skip to content

Commit 0d71626

Browse files
author
carflo
committed
Updates docs with typo fixes and new flag
1 parent 5ad2025 commit 0d71626

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ _As contributors and maintainers of this project, and in the interest of fosteri
77
## Getting Started
88

99
### Building the project
10-
[Controller developement documentation](/docs/controller-devel.md) has instructions on how to build the project and project specific expectations.
10+
[Controller development documentation](/docs/controller-devel.md) has instructions on how to build the project and project specific expectations.
1111

1212
### Contributing to docs
1313

docs/guide/service/nlb.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
The AWS Load Balancer Controller (LBC) supports reconciliation for Kubernetes Service resources of type `LoadBalancer` by provisioning an AWS Network Load Balancer (NLB) with an `instance` or `ip` [target type](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#target-type).
44

55
!!! info "Secure by default"
6-
Since the [:octicons-tag-24: v2.2.0](https://github.com/kubernetes-sigs/aws-load-balancer-controller/releases/tag/v2.2.0) release, the LBC provisions an `internal` NLB by default.
7-
6+
Since the [:octicons-tag-24: v2.2.0](https://github.com/kubernetes-sigs/aws-load-balancer-controller/releases/tag/v2.2.0) release, the LBC provisions an `internal` NLB by default.
7+
88
To create an `internet-facing` NLB, the following annotation is required on your service:
99

1010
```yaml
@@ -28,20 +28,20 @@ The AWS Load Balancer Controller (LBC) supports reconciliation for Kubernetes Se
2828

2929
## Configuration
3030

31-
By default, Kubernetes Service resources of type `LoadBalancer` get reconciled by the Kubernetes controller built into the `CloudProvider` component of the `kube-controller-manager` or the `cloud-controller-manager`(also known as the in-tree controller).
31+
By default, Kubernetes Service resources of type `LoadBalancer` get reconciled by the Kubernetes controller built into the `CloudProvider` component of the `kube-controller-manager` or the `cloud-controller-manager`(also known as the in-tree controller).
3232

3333
In order for the LBC to manage the reconciliation of Kubernetes Service resources of type `LoadBalancer`, you need to offload the reconciliation from the in-tree controller to the LBC, explicitly.
3434

3535

3636
=== "With LoadBalancerClass"
37-
The LBC supports the `LoadBalancerClass` feature since the [:octicons-tag-24: v2.4.0](https://github.com/kubernetes-sigs/aws-load-balancer-controller/releases/tag/v2.4.0) release for Kubernetes v1.22+ clusters.
38-
37+
The LBC supports the `LoadBalancerClass` feature since the [:octicons-tag-24: v2.4.0](https://github.com/kubernetes-sigs/aws-load-balancer-controller/releases/tag/v2.4.0) release for Kubernetes v1.22+ clusters.
38+
3939
The `LoadBalancerClass` feature provides a `CloudProvider` agnostic way of offloading the reconciliation for Kubernetes Service resources of type `LoadBalancer` to an external controller.
40-
40+
4141
When you specify the `spec.loadBalancerClass` to be `service.k8s.aws/nlb` on a Kubernetes Service resource of type `LoadBalancer`, the LBC takes charge of reconciliation by provisioning an NLB.
4242

4343
!!! warning
44-
- If you modify a Service resource with matching `spec.loadBalancerClass` by changing its `type` from `LoadBalancer` to anything else, the controller will cleanup the provioned NLB for that Service.
44+
- If you modify a Service resource with matching `spec.loadBalancerClass` by changing its `type` from `LoadBalancer` to anything else, the controller will cleanup the provisioned NLB for that Service.
4545

4646
- If the `spec.loadBalancerClass` is set to a `loadBalancerClass` that isn't recognized by the LBC, it ignores the Service resource, regardless of the `service.beta.kubernetes.io/aws-load-balancer-type` annotation.
4747

@@ -89,22 +89,22 @@ In order for the LBC to manage the reconciliation of Kubernetes Service resource
8989
```
9090

9191
=== "With `service.beta.kubernetes.io/aws-load-balancer-type` annotation"
92-
The AWS in-tree controller supports an AWS specific way of offloading the reconciliation for Kubernetes Service resources of type `LoadBalancer` to an external controller.
92+
The AWS in-tree controller supports an AWS specific way of offloading the reconciliation for Kubernetes Service resources of type `LoadBalancer` to an external controller.
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

9696
!!! warning
9797
- 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.
9898

99-
- If you modify this annotation on an existing Service resource, you might end up with leaked LBC resources.
99+
- If you modify this annotation on an existing Service resource, you might end up with leaked LBC resources.
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:
103103
```
104104
service.beta.kubernetes.io/aws-load-balancer-type: external
105105
service.beta.kubernetes.io/aws-load-balancer-nlb-target-type: ip
106106
```
107-
107+
108108
!!! example "Example: instance mode"
109109
```yaml hl_lines="6 7"
110110
apiVersion: v1
@@ -144,7 +144,7 @@ In order for the LBC to manage the reconciliation of Kubernetes Service resource
144144
```
145145

146146
## Protocols
147-
The LBC supports both TCP and UDP protocols. The controller also configures TLS termination on your NLB if you configure the Service with a certificate annotation.
147+
The LBC supports both TCP and UDP protocols. The controller also configures TLS termination on your NLB if you configure the Service with a certificate annotation.
148148

149149
In the case of TCP, an NLB with IP targets doesn't pass the client source IP address, unless you specifically configure it to using target group attributes. Your application pods might not see the actual client IP address, even if the NLB passes it along. For example, if you're using instance mode with `externalTrafficPolicy` set to `Cluster`.
150150
In such cases, you can configure [NLB proxy protocol v2](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#proxy-protocol) using an [annotation](https://kubernetes.io/docs/concepts/services-networking/service/#proxy-protocol-support-on-aws) if you need visibility into
@@ -182,6 +182,8 @@ The controller automatically selects the worker node security groups that it mod
182182

183183
`${cluster-name}` is the name of the Kubernetes cluster.
184184

185+
In the case that you have more than one matching security group with the tag `kubernetes.io/cluster/${cluster-name}`, you may specify additional tags with the `endpoint-security-group-tags` to further specify the security group that should be used.
186+
185187
### Worker node security groups rules
186188

187189
=== "When client IP preservation is enabled"

0 commit comments

Comments
 (0)