Skip to content

Fix healthcheck annotations scope in documentation (ELB + NLB) #1184

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
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix healthcheck annotations scope in documentation (ELB + NLB) #1184

wants to merge 1 commit into from
+29 −29

Conversation

samuel-esp
Copy link
Contributor

@samuel-esp samuel-esp commented Jul 1, 2025 •
edited
Loading

What type of PR is this?
/kind bug

What this PR does / why we need it:

Fix healthcheck annotations scope in documentation: the healthcheck annotations apply to both ELB and NLB

Which issue(s) this PR fixes:

Fixes #1183

Special notes for your reviewer:
This PR is partially related to #1182 (that solves issue #1181). The documention will be a bit misleading until that PR is merged since specifying a lowercase value for the protocol annotation ("http" or "tpc") will create a wrong configuration on the AWS ELB

Does this PR introduce a user-facing change?:
None

Fix healthcheck annotations scope in documentation: the healthcheck annotations apply to both ELB and NLB

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Jul 1, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign cartermckinnon for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If cloud-provider-aws contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 1, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @samuel-esp. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 1, 2025
This was referenced Jul 7, 2025
Closed
Open
mtulio
mtulio reviewed Jul 7, 2025
View reviewed changes
docs/service_controller.md
| service.beta.kubernetes.io/aws-load-balancer-eip-allocations | Comma-separated list | - | NLB | List of EIP allocations to associate with a internet-facing load balancer. Only valid for NLB. |
| service.beta.kubernetes.io/aws-load-balancer-healthcheck-path | - | / | ELB,NLB | Specifies the http path for the health check in case of http/https protocol. |
| service.beta.kubernetes.io/aws-load-balancer-healthcheck-port | [traffic-port\|1-65535] | traffic-port | ELB,NLB | Specifies the TCP target port for the target group health check. |
| service.beta.kubernetes.io/aws-load-balancer-healthcheck-protocol | [tcp\|http\|https] | tcp | ELB,NLB | Specifies the protocol to use for the target group health check. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! What do you think to document the current state of master, upper case requirement for ELB (as described in #1181), while #1182 is not merged yet? Or do you want to wait for it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mtulio Thanks! I think we could do it as you said; just in case we need to make sure the PR that describes the current state gets approved fast. Otherwise we might just wait that #1181 and this one are merged at the same time

mtulio
mtulio reviewed Jul 7, 2025
View reviewed changes
Copy link
Contributor

@mtulio mtulio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good to me, I just want to understand if you want to wait for ELB fix #1181 to merge this one.

cc @kmala @elmiko

@elmiko
Copy link
Contributor

elmiko commented Jul 7, 2025

lgtm, thanks for the heads up. i'm not sure i follow the nuance around merge timing.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 30, 2025
@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cartermckinnon cartermckinnon Awaiting requested review from cartermckinnon

@mmerkes mmerkes Awaiting requested review from mmerkes

1 more reviewer

@mtulio mtulio mtulio left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Healthcheck annotations incorrectly documented as limited to NLB
4 participants
@samuel-esp @k8s-ci-robot @elmiko @mtulio