address review comments

projectcontour · Sep 26, 2023 · 0ca48ab · 0ca48ab
1 parent db7e074
commit 0ca48ab
Show file tree

Hide file tree

Showing 19 changed files with 237 additions and 78 deletions.
diff --git a/apis/projectcontour/v1alpha1/contourconfig.go b/apis/projectcontour/v1alpha1/contourconfig.go
@@ -85,10 +85,8 @@ type ContourConfigurationSpec struct {
 	// Tracing defines properties for exporting trace data to OpenTelemetry.
 	Tracing *TracingConfig `json:"tracing,omitempty"`
 
-	// useEndpointSlice configures contour to fetch endpoint data
-	// from k8s endpoint slices. defaults to false and reading endpoint
-	// data from the k8s endpoints.
-	UseEndpointSlice bool `json:"useEndpointSlice,omitempty"`
+	// FeatureFlags defines toggle for new contour features.
+	FeatureFlags FeatureFlags `json:"featureFlags,omitempty"`
 }
 
 // XDSServerType is the type of xDS server implementation.
@@ -864,3 +862,10 @@ type ContourConfigurationList struct {
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []ContourConfiguration `json:"items"`
 }
+
+type FeatureFlags struct {
+	// useEndpointSlice configures contour to fetch endpoint data
+	// from k8s endpoint slices. defaults to false and reading endpoint
+	// data from the k8s endpoints.
+	UseEndpointSlice bool `json:"useEndpointSlice,omitempty"`
+}
diff --git a/apis/projectcontour/v1alpha1/zz_generated.deepcopy.go b/apis/projectcontour/v1alpha1/zz_generated.deepcopy.go
diff --git a/changelogs/unreleased/5745-clayton-gonsalves-minor.md b/changelogs/unreleased/5745-clayton-gonsalves-minor.md
@@ -1,4 +1,4 @@
 Add Kubernetes Endpoint Slice support.
 
-This change optionally enables Contour to consume the kuberentes endpointslice API to determine the endpoints to configure Envoy with.
-Note: This change is off by default and is gated by the config flag `useEndpointSlice`.
+This change optionally enables Contour to consume the kubernetes endpointslice API to determine the endpoints to configure Envoy with.
+Note: This change is off by default and is gated by the feature flag `useEndpointSlice`.
diff --git a/cmd/contour/serve.go b/cmd/contour/serve.go
@@ -457,7 +457,7 @@ func (s *Server) doServe() error {
 
 	// Endpoints updates are handled directly by the EndpointsTranslator/EndpointSliceTranslator due to the high update volume.
 	var endpointHandler EndpointsTranslator
-	if contourConfiguration.UseEndpointSlice {
+	if contourConfiguration.FeatureFlags.UseEndpointSlice {
 		endpointHandler = xdscache_v3.NewEndpointSliceTranslator(s.log.WithField("context", "endpointstranslator"))
 	} else {
 		endpointHandler = xdscache_v3.NewEndpointsTranslator(s.log.WithField("context", "endpointstranslator"))
@@ -600,19 +600,19 @@ func (s *Server) doServe() error {
 	}
 
 	// Inform on endpoints/endpointSlices.
-	if contourConfiguration.UseEndpointSlice {
+	if contourConfiguration.FeatureFlags.UseEndpointSlice {
 		if err := informOnResource(&discoveryv1.EndpointSlice{}, &contour.EventRecorder{
 			Next:    endpointHandler,
 			Counter: contourMetrics.EventHandlerOperations,
 		}, s.mgr.GetCache()); err != nil {
-			s.log.WithError(err).WithField("resource", "endpoints").Fatal("failed to create informer")
+			s.log.WithError(err).WithField("resource", "endpointslices").Fatal("failed to create informer")
 		}
 	} else {
 		if err := informOnResource(&corev1.Endpoints{}, &contour.EventRecorder{
 			Next:    endpointHandler,
 			Counter: contourMetrics.EventHandlerOperations,
 		}, s.mgr.GetCache()); err != nil {
-			s.log.WithError(err).WithField("resource", "endpoints").Fatal("failed to create informer")
+			s.log.WithError(err).WithField("resource", "endpointslices").Fatal("failed to create informer")
 		}
 	}
 

diff --git a/cmd/contour/servecontext.go b/cmd/contour/servecontext.go
@@ -588,7 +588,9 @@ func (ctx *serveContext) convertToContourConfigurationSpec() contour_api_v1alpha
 		Policy:                      policy,
 		Metrics:                     &contourMetrics,
 		Tracing:                     tracingConfig,
-		UseEndpointSlice:            ctx.Config.UseEndpointSlice,
+		FeatureFlags: contour_api_v1alpha1.FeatureFlags{
+			UseEndpointSlice: ctx.Config.FeatureFlags.UseEndpointSlice,
+		},
 	}
 
 	xdsServerType := contour_api_v1alpha1.ContourServerType

diff --git a/examples/contour/01-crds.yaml b/examples/contour/01-crds.yaml
@@ -448,6 +448,15 @@ spec:
                         type: string
                     type: object
                 type: object
+              featureFlags:
+                description: FeatureFlags defines toggle for new contour features.
+                properties:
+                  useEndpointSlice:
+                    description: useEndpointSlice configures contour to fetch endpoint
+                      data from k8s endpoint slices. defaults to false and reading
+                      endpoint data from the k8s endpoints.
+                    type: boolean
+                type: object
               gateway:
                 description: Gateway contains parameters for the gateway-api Gateway
                   that Contour is configured to serve traffic.
@@ -947,11 +956,6 @@ spec:
                 required:
                 - extensionService
                 type: object
-              useEndpointSlice:
-                description: useEndpointSlice configures contour to fetch endpoint
-                  data from k8s endpoint slices. defaults to false and reading endpoint
-                  data from the k8s endpoints.
-                type: boolean
               xdsServer:
                 description: XDSServer contains parameters for the xDS server.
                 properties:
@@ -3894,6 +3898,15 @@ spec:
                             type: string
                         type: object
                     type: object
+                  featureFlags:
+                    description: FeatureFlags defines toggle for new contour features.
+                    properties:
+                      useEndpointSlice:
+                        description: useEndpointSlice configures contour to fetch
+                          endpoint data from k8s endpoint slices. defaults to false
+                          and reading endpoint data from the k8s endpoints.
+                        type: boolean
+                    type: object
                   gateway:
                     description: Gateway contains parameters for the gateway-api Gateway
                       that Contour is configured to serve traffic.
@@ -4405,11 +4418,6 @@ spec:
                     required:
                     - extensionService
                     type: object
-                  useEndpointSlice:
-                    description: useEndpointSlice configures contour to fetch endpoint
-                      data from k8s endpoint slices. defaults to false and reading
-                      endpoint data from the k8s endpoints.
-                    type: boolean
                   xdsServer:
                     description: XDSServer contains parameters for the xDS server.
                     properties:

diff --git a/examples/contour/02-role-contour.yaml b/examples/contour/02-role-contour.yaml
@@ -18,6 +18,14 @@ rules:
   - get
   - list
   - watch
+- apiGroups:
+  - discovery.k8s.io
+  resources:
+  - endpointslices
+  verbs:
+  - get
+  - list
+  - watch
 - apiGroups:
   - gateway.networking.k8s.io
   resources:

diff --git a/examples/gateway-provisioner/01-roles.yaml b/examples/gateway-provisioner/01-roles.yaml
@@ -59,6 +59,14 @@ rules:
   - create
   - get
   - update
+- apiGroups:
+  - discovery.k8s.io
+  resources:
+  - endpointslices
+  verbs:
+  - get
+  - list
+  - watch
 - apiGroups:
   - gateway.networking.k8s.io
   resources:

diff --git a/examples/render/contour-deployment.yaml b/examples/render/contour-deployment.yaml
@@ -667,6 +667,15 @@ spec:
                         type: string
                     type: object
                 type: object
+              featureFlags:
+                description: FeatureFlags defines toggle for new contour features.
+                properties:
+                  useEndpointSlice:
+                    description: useEndpointSlice configures contour to fetch endpoint
+                      data from k8s endpoint slices. defaults to false and reading
+                      endpoint data from the k8s endpoints.
+                    type: boolean
+                type: object
               gateway:
                 description: Gateway contains parameters for the gateway-api Gateway
                   that Contour is configured to serve traffic.
@@ -1166,11 +1175,6 @@ spec:
                 required:
                 - extensionService
                 type: object
-              useEndpointSlice:
-                description: useEndpointSlice configures contour to fetch endpoint
-                  data from k8s endpoint slices. defaults to false and reading endpoint
-                  data from the k8s endpoints.
-                type: boolean
               xdsServer:
                 description: XDSServer contains parameters for the xDS server.
                 properties:
@@ -4113,6 +4117,15 @@ spec:
                             type: string
                         type: object
                     type: object
+                  featureFlags:
+                    description: FeatureFlags defines toggle for new contour features.
+                    properties:
+                      useEndpointSlice:
+                        description: useEndpointSlice configures contour to fetch
+                          endpoint data from k8s endpoint slices. defaults to false
+                          and reading endpoint data from the k8s endpoints.
+                        type: boolean
+                    type: object
                   gateway:
                     description: Gateway contains parameters for the gateway-api Gateway
                       that Contour is configured to serve traffic.
@@ -4624,11 +4637,6 @@ spec:
                     required:
                     - extensionService
                     type: object
-                  useEndpointSlice:
-                    description: useEndpointSlice configures contour to fetch endpoint
-                      data from k8s endpoint slices. defaults to false and reading
-                      endpoint data from the k8s endpoints.
-                    type: boolean
                   xdsServer:
                     description: XDSServer contains parameters for the xDS server.
                     properties:
@@ -8382,6 +8390,14 @@ rules:
   - get
   - list
   - watch
+- apiGroups:
+  - discovery.k8s.io
+  resources:
+  - endpointslices
+  verbs:
+  - get
+  - list
+  - watch
 - apiGroups:
   - gateway.networking.k8s.io
   resources:

diff --git a/examples/render/contour-gateway-provisioner.yaml b/examples/render/contour-gateway-provisioner.yaml
@@ -462,6 +462,15 @@ spec:
                         type: string
                     type: object
                 type: object
+              featureFlags:
+                description: FeatureFlags defines toggle for new contour features.
+                properties:
+                  useEndpointSlice:
+                    description: useEndpointSlice configures contour to fetch endpoint
+                      data from k8s endpoint slices. defaults to false and reading
+                      endpoint data from the k8s endpoints.
+                    type: boolean
+                type: object
               gateway:
                 description: Gateway contains parameters for the gateway-api Gateway
                   that Contour is configured to serve traffic.
@@ -961,11 +970,6 @@ spec:
                 required:
                 - extensionService
                 type: object
-              useEndpointSlice:
-                description: useEndpointSlice configures contour to fetch endpoint
-                  data from k8s endpoint slices. defaults to false and reading endpoint
-                  data from the k8s endpoints.
-                type: boolean
               xdsServer:
                 description: XDSServer contains parameters for the xDS server.
                 properties:
@@ -3908,6 +3912,15 @@ spec:
                             type: string
                         type: object
                     type: object
+                  featureFlags:
+                    description: FeatureFlags defines toggle for new contour features.
+                    properties:
+                      useEndpointSlice:
+                        description: useEndpointSlice configures contour to fetch
+                          endpoint data from k8s endpoint slices. defaults to false
+                          and reading endpoint data from the k8s endpoints.
+                        type: boolean
+                    type: object
                   gateway:
                     description: Gateway contains parameters for the gateway-api Gateway
                       that Contour is configured to serve traffic.
@@ -4419,11 +4432,6 @@ spec:
                     required:
                     - extensionService
                     type: object
-                  useEndpointSlice:
-                    description: useEndpointSlice configures contour to fetch endpoint
-                      data from k8s endpoint slices. defaults to false and reading
-                      endpoint data from the k8s endpoints.
-                    type: boolean
                   xdsServer:
                     description: XDSServer contains parameters for the xDS server.
                     properties:
@@ -19140,6 +19148,14 @@ rules:
   - create
   - get
   - update
+- apiGroups:
+  - discovery.k8s.io
+  resources:
+  - endpointslices
+  verbs:
+  - get
+  - list
+  - watch
 - apiGroups:
   - gateway.networking.k8s.io
   resources: