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.

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

Metallb --lb-class cmd arg to support multiple LoadBalancer implementations #10550

Conversation

Seal1998
Copy link
Contributor

@Seal1998 Seal1998 commented Oct 20, 2023

What type of PR is this?

/kind feature

What this PR does / why we need it:
In this PR, I tried using the new Metallb feature (effective from version 0.13.2), which is the ability to specify the --lb-class command line argument. This argument instructs MetalLB to listen exclusively for the loadBalancerClass defined in the .spec.loadBalancerClass of the LoadBalancer manifest.

In my scenario, this enhancement is very beneficial as I'm operating a cluster with multiple controllers that have the capability to monitor and manage the LoadBalancer service. Among these controllers are the cloud controller provided by my cloud provider and MetalLB respectively.

With this little change, I have configured MetalLB to strictly monitor a specific type of LoadBalancer, while delegating the management of all other LoadBalancer entities to the cloud controller.
Which issue(s) this PR fixes:

Not related to any particular issue

Special notes for your reviewer:
Thank you for your hard work! Version 2.23.0 is functioning smoothly. I'd really like to be able to specify loadBalancerClass in future releases
Does this PR introduce a user-facing change?:

Metallb --lb-class cmd arg to support multiple LoadBalancer implementations 

@k8s-ci-robot k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Oct 20, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Oct 20, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot requested review from bozzo and oomichi October 20, 2023 16:35
@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Oct 20, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @Seal1998!

It looks like this is your first PR to kubernetes-sigs/kubespray 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubespray has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 20, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @Seal1998. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Oct 20, 2023
@yankay
Copy link
Member

yankay commented Oct 23, 2023

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 23, 2023
@@ -1724,6 +1724,9 @@ spec:
- args:
- --port={{ metallb_port }}
- --log-level={{ metallb_log_level }}
{% if 'loadbalancer_class' in metallb_config.keys() and metallb_config.loadbalancer_class != "" %}
- --lb-class={{ metallb_config.loadbalancer_class }}
{% endif %}
Copy link
Member

@yankay yankay Oct 23, 2023

Choose a reason for hiding this comment

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

Thanks @Seal1998

Is is better to define the loadbalancer_class at the https://github.com/kubernetes-sigs/kubespray/blob/v2.23.0/roles/kubernetes-apps/metallb/defaults/main.yml#L4 instead of the metallb_config .

The same as the metallb_port :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey @yankay, thanks for review! I have changed the condition and role defaults accordingly. Unfortunately, to my understanding, we cannot have the --lb-class flag defined by default, similar to --port. This is because it would instruct MetalLB to listen for a specific class of LoadBalancer. However, Kubernetes does not have any "default" class to listen for, as per its documentation. The loadBalancerClass is undefined by default on all LoadBalancer services. (https://kubernetes.io/docs/concepts/services-networking/service/#load-balancer-class)

By default, .spec.loadBalancerClass is not set and a LoadBalancer type of Service uses the cloud provider's default load balancer implementation if the cluster is configured with a cloud provider using the --cloud-provider component flag.

In my opinion, we should keep --lb-class undefined until the user specifically sets the metallb_loadbalancer_class variable to something meaningful. In this way, MetalLB will act as the 'default' LoadBalancer implementation until we specifically set --lb-class

Official metallb helmchart also uses this approach

{{- if .Values.loadBalancerClass }}
        - --lb-class={{ .Values.loadBalancerClass }}
{{- end }}

Please review

@Seal1998 Seal1998 requested a review from yankay October 23, 2023 11:49
@yankay
Copy link
Member

yankay commented Oct 24, 2023

Thanks @ Seal1998 for the PR very much
/approve

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 24, 2023
Copy link
Member

@MrFreezeex MrFreezeex left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution! :D
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 8, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: MrFreezeex, Seal1998, yankay

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

The pull request process is described 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 k8s-ci-robot merged commit 6305dd3 into kubernetes-sigs:master Nov 8, 2023
59 checks passed
@yankay yankay mentioned this pull request Dec 15, 2023
pedro-peter pushed a commit to pedro-peter/kubespray that referenced this pull request May 8, 2024
…ations (kubernetes-sigs#10550)

* metallb --lb-class cmd arg to support multiple load balancer implementations

* removed loadbalancer_class from metallb_config; metallb_loadbalancer_class in role defaults
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants