Skip to content
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

Jump to bottom

Outdated documentation for Service object annotation "service.beta.kubernetes.io/aws-load-balancer-healthcheck-timeout" #3838

Open
saikrishnaburugula opened this issue Sep 3, 2024 · 4 comments · May be fixed by #3945
Open

Outdated documentation for Service object annotation "service.beta.kubernetes.io/aws-load-balancer-healthcheck-timeout" #3838

saikrishnaburugula opened this issue Sep 3, 2024 · 4 comments · May be fixed by #3945
Assignees
@phuhung273
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.

Comments

@saikrishnaburugula
Copy link

Describe the bug
Service Annotations documentation states the following for annotation "service.beta.kubernetes.io/aws-load-balancer-healthcheck-timeout"

The controller currently ignores the timeout configuration due to the limitations on the AWS NLB. The default timeout for TCP is 10s and HTTP is 6s.

Reference: https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/guide/service/annotations/#healthcheck-timeout

As per AWS NLB documentation https://docs.aws.amazon.com/elasticloadbalancing/latest/network/target-group-health-checks.html#health-check-settings

HealthCheckTimeoutSeconds : The amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. The default values are 6 seconds for HTTP and 10 seconds for TCP and HTTPS health checks.

As per the AWS load balancer controller documentation https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.8/deploy/configurations/ the feature gate NLBHealthCheckAdvancedConfiguration should be enabled or disabled
to set advanced health check configuration for NLB, for example health check timeout.

Steps to reproduce

  • Using the service annotations it is possible to set the timeout value to a different value than default as specified in the NLB documentation.

Expected outcome
Update the AWS LBC documentation to reflect the latest information regarding the usage of service.beta.kubernetes.io/aws-load-balancer-healthcheck-timeout and confirm if controller currently ignores the timeout configuration due to the limitations on the AWS NLB. If yes, please update the documentation with the limitations.
Environment

  • AWS Load Balancer controller version: v2.8
  • Kubernetes version: 1.29
  • Using EKS (yes/no), if so version? Yes. 1.29
@shraddhabang shraddhabang added kind/documentation Categorizes issue or PR as related to documentation. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels Sep 4, 2024
@andreybutenko
Copy link
Contributor

Thanks for the feedback! You're right, we should 1/ update the controller logic to remove this restriction on NLB health check settings, and 2/ update the controller documentation accordingly. We are open to PRs for this :)

@Shiravani24
Copy link

Would like to work on this request

@luca-rui
Copy link

Is there any soft timeline on when we can expect the custom timeouts to be supported?

@phuhung273
Copy link

/assign

@phuhung273 phuhung273 linked a pull request Nov 20, 2024 that will close this issue
Open
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@phuhung273 phuhung273

Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(doc): update service healthcheck timeout documentation phuhung273/aws-load-balancer-controller
6 participants
@andreybutenko @shraddhabang @saikrishnaburugula @phuhung273 @luca-rui @Shiravani24