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

feat(load-balancer): Add new node-selector annotation #514

Merged
merged 8 commits into from
Sep 14, 2023
Merged

feat(load-balancer): Add new node-selector annotation #514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ec301c8
Add new node-selector annotation
xoxys Sep 14, 2023
e024151
make use of selectedNodes
xoxys Sep 14, 2023
09cdd9a
cleanup
xoxys Sep 14, 2023
dbe6f31
Update hcloud/load_balancers.go
xoxys Sep 14, 2023
a59e302
Update hcloud/load_balancers.go
xoxys Sep 14, 2023
ee1ec82
Update hcloud/load_balancers.go
xoxys Sep 14, 2023
d23a0ba
Update internal/annotation/load_balancer.go
xoxys Sep 14, 2023
0e8d19f
fix linter/formatting
apricote Sep 14, 2023
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
58 changes: 47 additions & 11 deletions hcloud/load_balancers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"fmt"

corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/labels"
cloudprovider "k8s.io/cloud-provider"
"k8s.io/klog/v2"

Expand Down Expand Up @@ -44,6 +45,29 @@ func newLoadBalancers(lbOps LoadBalancerOps, ac hcops.HCloudActionClient, disabl
}
}

func matchNodeSelector(svc *corev1.Service, nodes []*corev1.Node) ([]*corev1.Node, error) {
var (
err error
selectedNodes []*corev1.Node
)

selector := labels.Everything()
if v, ok := annotation.LBNodeSelector.StringFromService(svc); ok {
selector, err = labels.Parse(v)
if err != nil {
return nil, fmt.Errorf("unable to parse the node-selector annotation: %w", err)
}
}

for _, n := range nodes {
if selector.Matches(labels.Set(n.GetLabels())) {
selectedNodes = append(selectedNodes, n)
}
}

return selectedNodes, nil
}

func (l *loadBalancers) GetLoadBalancer(
ctx context.Context, _ string, service *corev1.Service,
) (status *corev1.LoadBalancerStatus, exists bool, err error) {
Expand Down Expand Up @@ -97,13 +121,19 @@ func (l *loadBalancers) EnsureLoadBalancer(
metrics.OperationCalled.WithLabelValues(op).Inc()

var (
reload bool
lb *hcloud.LoadBalancer
err error
reload bool
lb *hcloud.LoadBalancer
err error
selectedNodes []*corev1.Node
)

nodeNames := make([]string, len(nodes))
for i, n := range nodes {
selectedNodes, err = matchNodeSelector(svc, nodes)
if err != nil {
return nil, fmt.Errorf("%s: %w", op, err)
}

nodeNames := make([]string, len(selectedNodes))
for i, n := range selectedNodes {
nodeNames[i] = n.Name
}
klog.InfoS("ensure Load Balancer", "op", op, "service", svc.Name, "nodes", nodeNames)
Expand Down Expand Up @@ -149,7 +179,7 @@ func (l *loadBalancers) EnsureLoadBalancer(
}
reload = reload || servicesChanged

targetsChanged, err := l.lbOps.ReconcileHCLBTargets(ctx, lb, svc, nodes)
targetsChanged, err := l.lbOps.ReconcileHCLBTargets(ctx, lb, svc, selectedNodes)
if err != nil {
return nil, fmt.Errorf("%s: %w", op, err)
}
Expand Down Expand Up @@ -236,12 +266,18 @@ func (l *loadBalancers) UpdateLoadBalancer(
metrics.OperationCalled.WithLabelValues(op).Inc()

var (
lb *hcloud.LoadBalancer
err error
lb *hcloud.LoadBalancer
err error
selectedNodes []*corev1.Node
)

nodeNames := make([]string, len(nodes))
for i, n := range nodes {
selectedNodes, err = matchNodeSelector(svc, nodes)
if err != nil {
return fmt.Errorf("%s: %w", op, err)
}

nodeNames := make([]string, len(selectedNodes))
for i, n := range selectedNodes {
nodeNames[i] = n.Name
}
klog.InfoS("update Load Balancer", "op", op, "service", svc.Name, "nodes", nodeNames)
Expand All @@ -263,7 +299,7 @@ func (l *loadBalancers) UpdateLoadBalancer(
if _, err = l.lbOps.ReconcileHCLB(ctx, lb, svc); err != nil {
return fmt.Errorf("%s: %w", op, err)
}
if _, err = l.lbOps.ReconcileHCLBTargets(ctx, lb, svc, nodes); err != nil {
if _, err = l.lbOps.ReconcileHCLBTargets(ctx, lb, svc, selectedNodes); err != nil {
return fmt.Errorf("%s: %w", op, err)
}
if _, err = l.lbOps.ReconcileHCLBServices(ctx, lb, svc); err != nil {
Expand Down
119 changes: 119 additions & 0 deletions hcloud/load_balancers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,27 @@ package hcloud
import (
"errors"
"net"
"reflect"
"testing"

"github.com/stretchr/testify/assert"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

"github.com/hetznercloud/hcloud-cloud-controller-manager/internal/annotation"
"github.com/hetznercloud/hcloud-cloud-controller-manager/internal/hcops"
"github.com/hetznercloud/hcloud-go/v2/hcloud"
)

func newNodeSelectorNode(name string, labels map[string]string) *corev1.Node {
return &corev1.Node{
ObjectMeta: metav1.ObjectMeta{
Name: name,
Labels: labels,
},
}
}

func TestLoadBalancers_GetLoadBalancer(t *testing.T) {
tests := []LoadBalancerTestCase{
{
Expand Down Expand Up @@ -713,3 +724,111 @@ func TestLoadBalancers_EnsureLoadBalancerDeleted(t *testing.T) {

RunLoadBalancerTests(t, tests)
}

func TestLoadBalancer_matchNodeSelector(t *testing.T) {
cases := []struct {
name string
service *corev1.Service
k8sNodes []*corev1.Node
expected []*corev1.Node
}{
{
name: "no node selector",
service: &corev1.Service{
ObjectMeta: metav1.ObjectMeta{},
},
k8sNodes: []*corev1.Node{
newNodeSelectorNode("node1", nil),
newNodeSelectorNode("node2", nil),
},
expected: []*corev1.Node{
newNodeSelectorNode("node1", nil),
newNodeSelectorNode("node2", nil),
},
},
{
name: "empty node selector",
service: &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{
string(annotation.LBNodeSelector): "",
},
},
},
k8sNodes: []*corev1.Node{
newNodeSelectorNode("node1", nil),
newNodeSelectorNode("node2", nil),
},
expected: []*corev1.Node{
newNodeSelectorNode("node1", nil),
newNodeSelectorNode("node2", nil),
},
},
{
name: "single node selector to select all",
service: &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{
string(annotation.LBNodeSelector): "environment=production",
},
},
},
k8sNodes: []*corev1.Node{
newNodeSelectorNode("node1", map[string]string{"environment": "production"}),
newNodeSelectorNode("node2", map[string]string{"environment": "production"}),
},
expected: []*corev1.Node{
newNodeSelectorNode("node1", map[string]string{"environment": "production"}),
newNodeSelectorNode("node2", map[string]string{"environment": "production"}),
},
},
{
name: "single node selector to select some",
service: &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{
string(annotation.LBNodeSelector): "environment=production",
},
},
},
k8sNodes: []*corev1.Node{
newNodeSelectorNode("node1", map[string]string{"environment": "production"}),
newNodeSelectorNode("node2", map[string]string{"environment": "staging"}),
},
expected: []*corev1.Node{
newNodeSelectorNode("node1", map[string]string{"environment": "production"}),
},
},
{
name: "multiple node selector to select all",
service: &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{
string(annotation.LBNodeSelector): "environment=production,zone=nue",
},
},
},
k8sNodes: []*corev1.Node{
newNodeSelectorNode("node1", map[string]string{"environment": "production", "zone": "fsn"}),
newNodeSelectorNode("node2", map[string]string{"environment": "production", "zone": "nue"}),
},
expected: []*corev1.Node{
newNodeSelectorNode("node2", map[string]string{"environment": "production", "zone": "nue"}),
},
},
}

for _, c := range cases {
c := c // prevent scopelint from complaining
t.Run(c.name, func(t *testing.T) {
nodes, err := matchNodeSelector(c.service, c.k8sNodes)
if err != nil {
t.Fatal(err)
}

if !reflect.DeepEqual(nodes, c.expected) {
t.Errorf("expected: %+v got %+v", c.expected, nodes)
}
})
}
}
10 changes: 10 additions & 0 deletions internal/annotation/load_balancer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,16 @@ const (
// Mutually exclusive with LBLocation.
LBNetworkZone Name = "load-balancer.hetzner.cloud/network-zone"

// LBNodeSelector can be set to restrict which Nodes are added as targets to the
// Load Balancer. It accepts a Kubernetes label selector string, using either the
// set-based or equality-based formats.
//
// If the selector can not be parsed, the targets in the Load Balancer are not
// updated and an Event is created with the error message.
//
// Format: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
LBNodeSelector Name = "load-balancer.hetzner.cloud/node-selector"

// LBSvcProxyProtocol specifies if the Load Balancer services should
// use the proxy protocol.
//
Expand Down