[GitHub] [apisix-ingress-controller] tokers commented on a change in pull request #252: feat: add support for Endpointslices

[GitBox <gi...@apache.org>]

tokers commented on a change in pull request #252:
URL: https://github.com/apache/apisix-ingress-controller/pull/252#discussion_r572623095



##########
File path: conf/config-default.yaml
##########
@@ -30,6 +30,7 @@ log_output: "stderr" # the output file path of error log, default is stderr, whe
 http_listen: ":8080"   # the HTTP Server listen address, default is ":8080"
 enable_profiling: true # enable profileing via web interfaces
                        # host:port/debug/pprof, default is true.
+enable_endpointslice: false # enable endpointSlice support, default is false

Review comment:
       Missing a period `.`.

##########
File path: pkg/ingress/controller/endpointslice.go
##########
@@ -0,0 +1,251 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package controller
+
+import (
+	"context"
+
+	"go.uber.org/zap"
+	discoveryv1beta1 "k8s.io/api/discovery/v1beta1"
+	k8serrors "k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/client-go/tools/cache"
+	"k8s.io/client-go/util/workqueue"
+
+	"github.com/apache/apisix-ingress-controller/pkg/apisix"
+	apisixcache "github.com/apache/apisix-ingress-controller/pkg/apisix/cache"
+	"github.com/apache/apisix-ingress-controller/pkg/kube"
+	"github.com/apache/apisix-ingress-controller/pkg/log"
+	"github.com/apache/apisix-ingress-controller/pkg/seven/state"
+	"github.com/apache/apisix-ingress-controller/pkg/types"
+	apisixv1 "github.com/apache/apisix-ingress-controller/pkg/types/apisix/v1"
+)
+
+type endpointSliceController struct {
+	controller *Controller
+	workqueue  workqueue.RateLimitingInterface
+	workers    int
+	epInformer cache.SharedIndexInformer
+}
+
+func (c *Controller) newEndpointSliceController() *endpointSliceController {
+	ctl := &endpointSliceController{
+		controller: c,
+		workqueue:  workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "endpointslice"),
+		workers:    1,
+		epInformer: kube.CoreSharedInformerFactory.Discovery().V1beta1().EndpointSlices().Informer(),
+	}
+
+	ctl.epInformer.AddEventHandler(
+		cache.ResourceEventHandlerFuncs{
+			AddFunc:    ctl.onAdd,
+			UpdateFunc: ctl.onUpdate,
+			DeleteFunc: ctl.onDelete,
+		},
+	)
+
+	return ctl
+}
+
+func (c *endpointSliceController) run(ctx context.Context) {
+	log.Info("endpointslice controller started")
+	defer log.Info("endpointslice controller exited")
+
+	if ok := cache.WaitForCacheSync(ctx.Done(), c.epInformer.HasSynced); !ok {
+		log.Error("informers sync failed")
+		return
+	}
+
+	handler := func() {
+		for {
+			obj, shutdown := c.workqueue.Get()
+			if shutdown {
+				return
+			}
+
+			err := c.sync(ctx, obj.(*types.Event))
+			c.workqueue.Done(obj)
+			c.handleSyncErr(obj, err)
+		}
+	}
+
+	for i := 0; i < c.workers; i++ {
+		go handler()
+	}
+
+	<-ctx.Done()
+	c.workqueue.ShutDown()
+}
+
+func (c *endpointSliceController) sync(ctx context.Context, ev *types.Event) error {
+	ep := ev.Object.(*discoveryv1beta1.EndpointSlice)
+	svc, err := c.controller.svcLister.Services(ep.Namespace).Get(ep.Name)
+	if err != nil {
+		if k8serrors.IsNotFound(err) {
+			log.Warnf("service %s/%s was deleted", ep.Namespace, ep.Name)
+			return nil
+		}
+		log.Errorf("failed to get service %s/%s: %s", ep.Namespace, ep.Name, err)
+		return err
+	}
+	portMap := make(map[string]int32)
+	for _, port := range svc.Spec.Ports {
+		portMap[port.Name] = port.Port
+	}
+	clusters := c.controller.apisix.ListClusters()
+	for _, port := range ep.Ports {
+		svcPort, ok := portMap[*port.Name]
+		if !ok {
+			// This shouldn't happen.
+			log.Errorf("port %s in endpointslice %s/%s but not in service", *port.Name, ep.Namespace, ep.Name)
+			continue
+		}
+		nodes, err := c.controller.translator.TranslateUpstreamNodesFromEndpointSlice(ep, svcPort)
+		if err != nil {
+			log.Errorw("failed to translate upstream nodes",
+				zap.Error(err),
+				zap.Any("endpointslice", ep),
+				zap.Int32("port", svcPort),
+			)

Review comment:
       It seems we should return `err` here since error occurred. The same logic in endpoints controller should also be changed.

##########
File path: conf/config-default.yaml
##########
@@ -30,6 +30,7 @@ log_output: "stderr" # the output file path of error log, default is stderr, whe
 http_listen: ":8080"   # the HTTP Server listen address, default is ":8080"
 enable_profiling: true # enable profileing via web interfaces
                        # host:port/debug/pprof, default is true.
+enable_endpointslice: false # enable endpointSlice support, default is false

Review comment:
       What about putting this option to `kubernetes` section?

##########
File path: pkg/ingress/controller/controller.go
##########
@@ -126,20 +123,28 @@ func NewController(cfg *config.Config) (*Controller, error) {
 		crdInformerFactory: sharedInformerFactory,
 		watchingNamespace:  watchingNamespace,
 
-		epInformer:             kube.CoreSharedInformerFactory.Core().V1().Endpoints().Informer(),
-		epLister:               kube.CoreSharedInformerFactory.Core().V1().Endpoints().Lister(),
 		svcInformer:            kube.CoreSharedInformerFactory.Core().V1().Services().Informer(),
 		svcLister:              kube.CoreSharedInformerFactory.Core().V1().Services().Lister(),
 		apisixUpstreamInformer: sharedInformerFactory.Apisix().V1().ApisixUpstreams().Informer(),
 		apisixUpstreamLister:   sharedInformerFactory.Apisix().V1().ApisixUpstreams().Lister(),
 	}
-	c.translator = kube.NewTranslator(&kube.TranslatorOptions{
-		EndpointsLister:      c.epLister,
-		ServiceLister:        c.svcLister,
-		ApisixUpstreamLister: c.apisixUpstreamLister,
-	})
 
-	c.endpointsController = c.newEndpointsController()
+	if c.cfg.EnableEndpointSlice {

Review comment:
       We should whether the running Kubernetes cluster supports the EndpointsSlice resource, if not, Ingress controller shouldn't launch.

##########
File path: pkg/kube/translator.go
##########
@@ -120,17 +136,42 @@ func (t *translator) TranslateUpstreamConfig(au *configv1.ApisixUpstreamConfig)
 }
 
 func (t *translator) TranslateUpstream(namespace, name string, port int32) (*apisixv1.Upstream, error) {
-	endpoints, err := t.EndpointsLister.Endpoints(namespace).Get(name)
-	if err != nil {
+	var endpoints *corev1.Endpoints
+	var endpointSlice *discoveryvibeta1.EndpointSlice
+	var nodes []apisixv1.UpstreamNode
+	var err error
+	switch t.EndpointMode {
+	case EndpointSliceOnly:
+		endpointSlice, err = CoreSharedInformerFactory.Discovery().V1beta1().EndpointSlices().Lister().EndpointSlices(namespace).Get(name)
+		if err != nil {
+			return nil, &translateError{
+				field:  "endpointslice",
+				reason: err.Error(),
+			}
+		}
+		nodes, err = t.TranslateUpstreamNodesFromEndpointSlice(endpointSlice, port)
+		if err != nil {
+			return nil, err
+		}
+	case EndpointsOnly:
+		endpoints, err = CoreSharedInformerFactory.Core().V1().Endpoints().Lister().Endpoints(namespace).Get(name)
+		if err != nil {
+			return nil, &translateError{
+				field:  "endpoints",
+				reason: err.Error(),
+			}
+		}
+		nodes, err = t.TranslateUpstreamNodes(endpoints, port)
+		if err != nil {
+			return nil, err
+		}
+	default:

Review comment:
       Just panic is OK, since we never should have other EndpointMode value.

##########
File path: pkg/kube/translator.go
##########
@@ -120,17 +136,42 @@ func (t *translator) TranslateUpstreamConfig(au *configv1.ApisixUpstreamConfig)
 }
 
 func (t *translator) TranslateUpstream(namespace, name string, port int32) (*apisixv1.Upstream, error) {
-	endpoints, err := t.EndpointsLister.Endpoints(namespace).Get(name)
-	if err != nil {
+	var endpoints *corev1.Endpoints
+	var endpointSlice *discoveryvibeta1.EndpointSlice
+	var nodes []apisixv1.UpstreamNode
+	var err error

Review comment:
       Use `var` block instead of multiple single line `var` statements.
   ```suggestion
   	var (
   	    endpoints *corev1.Endpoints
   	    endpointSlice *discoveryvibeta1.EndpointSlice
   	    nodes []apisixv1.UpstreamNode
   	    err error
   	)
   ```
   
   

##########
File path: pkg/kube/translator.go
##########
@@ -56,7 +60,8 @@ type Translator interface {
 // TranslatorOptions contains options to help Translator
 // work well.
 type TranslatorOptions struct {
-	EndpointsLister      listerscorev1.EndpointsLister
+	// EndpointMode decides what source to use to get endpoint information

Review comment:
       what => which, it's object clauses.

##########
File path: pkg/kube/translator.go
##########
@@ -18,6 +18,7 @@ import (
 	"fmt"
 
 	corev1 "k8s.io/api/core/v1"
+	discoveryvibeta1 "k8s.io/api/discovery/v1beta1"

Review comment:
       Typo name, should be `discoveryv1beta1 `.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org