Skip to content

EndpointSlice support for IP target groups #2169

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

Merged
merged 5 commits into from
Sep 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ site

# editor and IDE paraphernalia
.idea
.vscode
*.swp
*.swo
*~
8 changes: 8 additions & 0 deletions config/rbac/role.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@ rules:
verbs:
- patch
- update
- apiGroups:
Copy link
Collaborator

Choose a reason for hiding this comment

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

You need to specify this via the kube-builder annotation. Please refer to the following

// +kubebuilder:rbac:groups="",resources=endpoints,verbs=get;list;watch

Once you specify the kubebuilder annotation, make generate will automatically generate this file

- discovery.k8s.io
resources:
- endpointslices
verbs:
- get
- list
- watch
- apiGroups:
- elbv2.k8s.aws
resources:
Expand Down
100 changes: 100 additions & 0 deletions controllers/elbv2/eventhandlers/endpointslices.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
package eventhandlers

import (
"context"

"github.com/go-logr/logr"
"github.com/pkg/errors"
discv1 "k8s.io/api/discovery/v1beta1"
"k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/util/workqueue"
elbv2api "sigs.k8s.io/aws-load-balancer-controller/apis/elbv2/v1beta1"
"sigs.k8s.io/aws-load-balancer-controller/pkg/k8s"
"sigs.k8s.io/aws-load-balancer-controller/pkg/targetgroupbinding"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)

const svcNameLabel = "kubernetes.io/service-name"

// NewEnqueueRequestsForEndpointSlicesEvent constructs new enqueueRequestsForEndpointSlicesEvent.
func NewEnqueueRequestsForEndpointSlicesEvent(k8sClient client.Client, logger logr.Logger) handler.EventHandler {
return &enqueueRequestsForEndpointSlicesEvent{
k8sClient: k8sClient,
logger: logger,
}
}

var _ handler.EventHandler = (*enqueueRequestsForEndpointSlicesEvent)(nil)

type enqueueRequestsForEndpointSlicesEvent struct {
k8sClient client.Client
logger logr.Logger
}

// Create is called in response to an create event - e.g. EndpointSlice Creation.
func (h *enqueueRequestsForEndpointSlicesEvent) Create(e event.CreateEvent, queue workqueue.RateLimitingInterface) {
epNew := e.Object.(*discv1.EndpointSlice)
h.logger.V(1).Info("Create event for EndpointSlices", "name", epNew.Name)
h.enqueueImpactedTargetGroupBindings(queue, epNew)
}

// Update is called in response to an update event - e.g. EndpointSlice Updated.
func (h *enqueueRequestsForEndpointSlicesEvent) Update(e event.UpdateEvent, queue workqueue.RateLimitingInterface) {
epOld := e.ObjectOld.(*discv1.EndpointSlice)
epNew := e.ObjectNew.(*discv1.EndpointSlice)
h.logger.V(1).Info("Update event for EndpointSlices", "name", epNew.Name)
if !equality.Semantic.DeepEqual(epOld.Ports, epNew.Ports) || !equality.Semantic.DeepEqual(epOld.Endpoints, epNew.Endpoints) {
h.logger.V(1).Info("Enqueue EndpointSlice", "name", epNew.Name)
h.enqueueImpactedTargetGroupBindings(queue, epNew)
}
}

// Delete is called in response to a delete event - e.g. EndpointSlice Deleted.
func (h *enqueueRequestsForEndpointSlicesEvent) Delete(e event.DeleteEvent, queue workqueue.RateLimitingInterface) {
epOld := e.Object.(*discv1.EndpointSlice)
h.logger.V(1).Info("Deletion event for EndpointSlices", "name", epOld.Name)
h.enqueueImpactedTargetGroupBindings(queue, epOld)
}

// Generic is called in response to an event of an unknown type or a synthetic event triggered as a cron or
// external trigger request - e.g. reconcile AutoScaling, or a WebHook.
func (h *enqueueRequestsForEndpointSlicesEvent) Generic(event.GenericEvent, workqueue.RateLimitingInterface) {
}

func (h *enqueueRequestsForEndpointSlicesEvent) enqueueImpactedTargetGroupBindings(queue workqueue.RateLimitingInterface, epSlice *discv1.EndpointSlice) {
tgbList := &elbv2api.TargetGroupBindingList{}
svcName, present := epSlice.Labels[svcNameLabel]
if !present {
err := errors.Errorf("EndpointSlice does not have a %v label", svcNameLabel)
h.logger.Error(err, "unable to find service name for endpointslice")
return
}
if err := h.k8sClient.List(context.Background(), tgbList,
client.InNamespace(epSlice.Namespace),
client.MatchingFields{targetgroupbinding.IndexKeyServiceRefName: svcName}); err != nil {
h.logger.Error(err, "failed to fetch targetGroupBindings")
return
}

epSliceKey := k8s.NamespacedName(epSlice)
for _, tgb := range tgbList.Items {
if tgb.Spec.TargetType == nil || (*tgb.Spec.TargetType) != elbv2api.TargetTypeIP {
continue
}

h.logger.V(1).Info("enqueue targetGroupBinding for endpointslices event",
"endpointslices", epSliceKey,
"targetGroupBinding", k8s.NamespacedName(&tgb),
)
queue.Add(reconcile.Request{
NamespacedName: types.NamespacedName{
Namespace: tgb.Namespace,
Name: tgb.Name,
},
})
}
}
183 changes: 183 additions & 0 deletions controllers/elbv2/eventhandlers/endpointslices_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
package eventhandlers

import (
"context"
"testing"

"github.com/golang/mock/gomock"
"github.com/google/go-cmp/cmp"
"github.com/stretchr/testify/assert"
discv1 "k8s.io/api/discovery/v1beta1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/util/workqueue"
elbv2api "sigs.k8s.io/aws-load-balancer-controller/apis/elbv2/v1beta1"
mock_client "sigs.k8s.io/aws-load-balancer-controller/mocks/controller-runtime/client"
"sigs.k8s.io/aws-load-balancer-controller/pkg/testutils"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllertest"
"sigs.k8s.io/controller-runtime/pkg/log"
)

func Test_enqueueRequestsForEndpointSlicesEvent_enqueueImpactedTargetGroupBindings(t *testing.T) {
instanceTargetType := elbv2api.TargetTypeInstance
ipTargetType := elbv2api.TargetTypeIP

type tgbListCall struct {
opts []client.ListOption
tgbs []*elbv2api.TargetGroupBinding
err error
}
type fields struct {
tgbListCalls []tgbListCall
}
type args struct {
epslice *discv1.EndpointSlice
}
tests := []struct {
name string
fields fields
args args
wantRequests []ctrl.Request
}{
{
name: "service event should enqueue impacted ip TargetType TGBs",
fields: fields{
tgbListCalls: []tgbListCall{
{
opts: []client.ListOption{
client.InNamespace("awesome-ns"),
client.MatchingFields{"spec.serviceRef.name": "awesome-svc"},
},
tgbs: []*elbv2api.TargetGroupBinding{
{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "tgb-1",
},
Spec: elbv2api.TargetGroupBindingSpec{
TargetType: &ipTargetType,
},
},
{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "tgb-2",
},
Spec: elbv2api.TargetGroupBindingSpec{
TargetType: &instanceTargetType,
},
},
{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "tgb-3",
},
Spec: elbv2api.TargetGroupBindingSpec{
TargetType: &ipTargetType,
},
},
},
},
},
},
args: args{
epslice: &discv1.EndpointSlice{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-svc",
Labels: map[string]string{"kubernetes.io/service-name": "awesome-svc"},
},
},
},
wantRequests: []ctrl.Request{
{
NamespacedName: types.NamespacedName{Namespace: "awesome-ns", Name: "tgb-1"},
},
{
NamespacedName: types.NamespacedName{Namespace: "awesome-ns", Name: "tgb-3"},
},
},
},
{
name: "service event should enqueue impacted ip TargetType TGBs - ignore nil TargetType",
fields: fields{
tgbListCalls: []tgbListCall{
{
opts: []client.ListOption{
client.InNamespace("awesome-ns"),
client.MatchingFields{"spec.serviceRef.name": "awesome-svc"},
},
tgbs: []*elbv2api.TargetGroupBinding{
{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "tgb-1",
},
Spec: elbv2api.TargetGroupBindingSpec{
TargetType: &ipTargetType,
},
},
{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "tgb-2",
},
Spec: elbv2api.TargetGroupBindingSpec{
TargetType: nil,
},
},
},
},
},
},
args: args{
epslice: &discv1.EndpointSlice{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-svc",
Labels: map[string]string{"kubernetes.io/service-name": "awesome-svc"},
},
},
},
wantRequests: []ctrl.Request{
{
NamespacedName: types.NamespacedName{Namespace: "awesome-ns", Name: "tgb-1"},
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ctrl := gomock.NewController(t)
defer ctrl.Finish()

k8sClient := mock_client.NewMockClient(ctrl)
for _, call := range tt.fields.tgbListCalls {
var extraMatchers []interface{}
for _, opt := range call.opts {
extraMatchers = append(extraMatchers, testutils.NewListOptionEquals(opt))
}
k8sClient.EXPECT().List(gomock.Any(), gomock.Any(), extraMatchers...).DoAndReturn(
func(ctx context.Context, tgbList *elbv2api.TargetGroupBindingList, opts ...client.ListOption) error {
for _, tgb := range call.tgbs {
tgbList.Items = append(tgbList.Items, *(tgb.DeepCopy()))
}
return call.err
},
)
}

h := &enqueueRequestsForEndpointSlicesEvent{
k8sClient: k8sClient,
logger: &log.NullLogger{},
}
queue := controllertest.Queue{Interface: workqueue.New()}
h.enqueueImpactedTargetGroupBindings(queue, tt.args.epslice)
gotRequests := testutils.ExtractCTRLRequestsFromQueue(queue)
assert.True(t, cmp.Equal(tt.wantRequests, gotRequests),
"diff", cmp.Diff(tt.wantRequests, gotRequests))
})
}
}
Loading