Skip to content

Update annotations documentation to include support for named ports in NLB health check configuration #4386

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −3
Open

Update annotations documentation to include support for named ports in NLB health check configuration #4386

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 12 additions & 3 deletions docs/guide/service/annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
| [service.beta.kubernetes.io/aws-load-balancer-backend-protocol](#backend-protocol) | string | | |
| [service.beta.kubernetes.io/aws-load-balancer-additional-resource-tags](#additional-resource-tags) | stringMap | | |
| [service.beta.kubernetes.io/aws-load-balancer-healthcheck-protocol](#healthcheck-protocol) | string | TCP | |
| [service.beta.kubernetes.io/aws-load-balancer-healthcheck-port ](#healthcheck-port) | integer \| traffic-port | traffic-port | |
| [service.beta.kubernetes.io/aws-load-balancer-healthcheck-port ](#healthcheck-port) | integer \| traffic-port \| named-service-port | traffic-port | |
| [service.beta.kubernetes.io/aws-load-balancer-healthcheck-path](#healthcheck-path) | string | "/" for HTTP(S) protocols | |
| [service.beta.kubernetes.io/aws-load-balancer-healthcheck-healthy-threshold](#healthcheck-healthy-threshold) | integer | 3 | |
| [service.beta.kubernetes.io/aws-load-balancer-healthcheck-unhealthy-threshold](#healthcheck-unhealthy-threshold) | integer | 3 | |
Expand Down Expand Up @@ -431,8 +431,13 @@ Health check on target groups can be configured with following annotations:

- <a name="healthcheck-port">`service.beta.kubernetes.io/aws-load-balancer-healthcheck-port`</a> specifies the TCP port to use for target group health check.

!!!note "default value"
- if you do not specify the health check port, the default value will be `spec.healthCheckNodePort` when `externalTrafficPolicy=local` or `traffic-port` otherwise.
!!!note "accepted values"
- `traffic-port` - use the same port as the target group traffic (default when `externalTrafficPolicy=Cluster`)
- Integer string (e.g., `"80"`) - use this specific port number
- Service port name (e.g., `"http"`) - resolves based on target type:
- **Instance targets**: uses the Service port's `NodePort`
- **IP targets**: uses the Service port's `targetPort` (must be numeric, not a named port)
- **Default**: `spec.healthCheckNodePort` when `externalTrafficPolicy=Local`, otherwise `traffic-port`

!!!example
- set the health check port to `traffic-port`
Expand All @@ -443,6 +448,10 @@ Health check on target groups can be configured with following annotations:
```
service.beta.kubernetes.io/aws-load-balancer-healthcheck-port: "80"
```
- set the health check port to a named Service port
```
service.beta.kubernetes.io/aws-load-balancer-healthcheck-port: "http"
```

- <a name="healthcheck-path">`service.beta.kubernetes.io/aws-load-balancer-healthcheck-path`</a> specifies the http path for the health check in case of http/https protocol.

Expand Down