Skip to content

Fix typo in the Note section of load balancer allocator #1835

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.

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: master
Choose a base branch
from

Conversation

anupamdialpad
Copy link

I think the Notes section below had a typo. This PR fixes that.

@@ -83,4 +83,4 @@ When running the controller outside a pod, both `POD_NAME` and `POD_NAMESPACE` m

## Notes

It's not possible to specify the addresses for the load balancer services. A externalIP service can be used instead.
If it is not possible to specify the addresses for the load balancer services, an [externalIP service](https://kubernetes.io/docs/concepts/services-networking/service/#external-ips) can be used instead.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Most of this edit is fine, however, we should not add an If to the front of this. It's not up to the user on whether or not to specify an IP address on the Load Balancer. kube-router currently doesn't allow for this in its LoadBalancer implementation.

If users want to have full control over the IP address a service gets, then they must use an ExternalIP.

Copy link
Author

Choose a reason for hiding this comment

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

Oh! In my case I assigned an ip address in the loadBalancerIP field of the service manifest and saw that the IP got shown under the "External IP" column. Hence I thought in some cases it works. Then this Pull Request is not even required I think.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Hmm... I don't see any handling of the loadBalancerIP field in the actual Load Balancer Allocation controller (https://github.com/cloudnativelabs/kube-router/blob/master/pkg/controllers/lballoc/lballoc.go) so I'd be a bit surprised if this is working the way that you're expecting.

That being said, I see references to it in other controllers like the services controller, so its possible that its just working anyway even without the Load Balancer Allocator handling it properly.

Are you able to show me the full YAML of your service? It would be kind of interesting to see how its setup to see if I can make more sense of it.

@aauren
Copy link
Collaborator

aauren commented Apr 17, 2025

Thanks for reading the docs and contributing!

I left one comment, and also as a slight nitpic, it would be nice if you could update your commit message to match the existing commit message structure of this repo. Something like doc(loadbalancer): fix typo in note section should be fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants