deprecate xDS server type field (projectcontour#6561)

Fields are planned to be removed in the 1.31 release. Updates projectcontour#2134. Signed-off-by: Steve Kriss <[email protected]> Signed-off-by: Geoff Macartney <[email protected]>
chaosbox · Aug 22, 2024 · c9d6233 · c9d6233
1 parent 4962632
commit c9d6233
Show file tree

Hide file tree

Showing 12 changed files with 38 additions and 3 deletions.
diff --git a/apis/projectcontour/v1alpha1/contourconfig.go b/apis/projectcontour/v1alpha1/contourconfig.go
@@ -129,6 +129,9 @@ type XDSServerConfig struct {
 	// Values: `envoy` (default), `contour (deprecated)`.
 	//
 	// Other values will produce an error.
+	//
+	// Deprecated: this field will be removed in a future release when
+	// the `contour` xDS server implementation is removed.
 	// +optional
 	Type XDSServerType `json:"type,omitempty"`
 

diff --git a/changelogs/unreleased/6561-skriss-deprecation.md b/changelogs/unreleased/6561-skriss-deprecation.md
@@ -0,0 +1,4 @@
+## xDS server type fields in config file and ContourConfiguration CRD are deprecated
+
+These fields are officially deprecated now that the `contour` xDS server implementation is deprecated.
+They are planned to be removed in the 1.31 release, along with the `contour` xDS server implementation.
diff --git a/cmd/contour/serve.go b/cmd/contour/serve.go
@@ -510,6 +510,7 @@ func (s *Server) doServe() error {
 	// the contents of the Contour xDS caches after the DAG is built.
 	var snapshotHandler *xdscache_v3.SnapshotHandler
 
+	// nolint:staticcheck
 	if contourConfiguration.XDSServer.Type == contour_v1alpha1.EnvoyServerType {
 		snapshotHandler = xdscache_v3.NewSnapshotHandler(resources, s.log.WithField("context", "snapshotHandler"))
 
@@ -924,13 +925,15 @@ func (x *xdsServer) Start(ctx context.Context) error {
 
 	grpcServer := xds.NewServer(x.registry, grpcOptions(log, x.config.TLS)...)
 
+	// nolint:staticcheck
 	switch x.config.Type {
 	case contour_v1alpha1.EnvoyServerType:
 		contour_xds_v3.RegisterServer(envoy_server_v3.NewServer(ctx, x.snapshotHandler.GetCache(), contour_xds_v3.NewRequestLoggingCallbacks(log)), grpcServer)
 	case contour_v1alpha1.ContourServerType:
 		contour_xds_v3.RegisterServer(contour_xds_v3.NewContourServer(log, xdscache.ResourcesOf(x.resources)...), grpcServer)
 	default:
 		// This can't happen due to config validation.
+		// nolint:staticcheck
 		log.Fatalf("invalid xDS server type %q", x.config.Type)
 	}
 
@@ -945,6 +948,7 @@ func (x *xdsServer) Start(ctx context.Context) error {
 		log = log.WithField("insecure", true)
 	}
 
+	// nolint:staticcheck
 	log.Infof("started xDS server type: %q", x.config.Type)
 	defer log.Info("stopped xDS server")
 

diff --git a/examples/contour/01-crds.yaml b/examples/contour/01-crds.yaml
@@ -1149,6 +1149,8 @@ spec:
                       Defines the XDSServer to use for `contour serve`.
                       Values: `envoy` (default), `contour (deprecated)`.
                       Other values will produce an error.
+                      Deprecated: this field will be removed in a future release when
+                      the `contour` xDS server implementation is removed.
                     type: string
                 type: object
             type: object
@@ -4931,6 +4933,8 @@ spec:
                           Defines the XDSServer to use for `contour serve`.
                           Values: `envoy` (default), `contour (deprecated)`.
                           Other values will produce an error.
+                          Deprecated: this field will be removed in a future release when
+                          the `contour` xDS server implementation is removed.
                         type: string
                     type: object
                 type: object

diff --git a/examples/render/contour-deployment.yaml b/examples/render/contour-deployment.yaml
@@ -1369,6 +1369,8 @@ spec:
                       Defines the XDSServer to use for `contour serve`.
                       Values: `envoy` (default), `contour (deprecated)`.
                       Other values will produce an error.
+                      Deprecated: this field will be removed in a future release when
+                      the `contour` xDS server implementation is removed.
                     type: string
                 type: object
             type: object
@@ -5151,6 +5153,8 @@ spec:
                           Defines the XDSServer to use for `contour serve`.
                           Values: `envoy` (default), `contour (deprecated)`.
                           Other values will produce an error.
+                          Deprecated: this field will be removed in a future release when
+                          the `contour` xDS server implementation is removed.
                         type: string
                     type: object
                 type: object

diff --git a/examples/render/contour-gateway-provisioner.yaml b/examples/render/contour-gateway-provisioner.yaml
@@ -1160,6 +1160,8 @@ spec:
                       Defines the XDSServer to use for `contour serve`.
                       Values: `envoy` (default), `contour (deprecated)`.
                       Other values will produce an error.
+                      Deprecated: this field will be removed in a future release when
+                      the `contour` xDS server implementation is removed.
                     type: string
                 type: object
             type: object
@@ -4942,6 +4944,8 @@ spec:
                           Defines the XDSServer to use for `contour serve`.
                           Values: `envoy` (default), `contour (deprecated)`.
                           Other values will produce an error.
+                          Deprecated: this field will be removed in a future release when
+                          the `contour` xDS server implementation is removed.
                         type: string
                     type: object
                 type: object

diff --git a/examples/render/contour-gateway.yaml b/examples/render/contour-gateway.yaml
@@ -1185,6 +1185,8 @@ spec:
                       Defines the XDSServer to use for `contour serve`.
                       Values: `envoy` (default), `contour (deprecated)`.
                       Other values will produce an error.
+                      Deprecated: this field will be removed in a future release when
+                      the `contour` xDS server implementation is removed.
                     type: string
                 type: object
             type: object
@@ -4967,6 +4969,8 @@ spec:
                           Defines the XDSServer to use for `contour serve`.
                           Values: `envoy` (default), `contour (deprecated)`.
                           Other values will produce an error.
+                          Deprecated: this field will be removed in a future release when
+                          the `contour` xDS server implementation is removed.
                         type: string
                     type: object
                 type: object

diff --git a/examples/render/contour.yaml b/examples/render/contour.yaml
@@ -1369,6 +1369,8 @@ spec:
                       Defines the XDSServer to use for `contour serve`.
                       Values: `envoy` (default), `contour (deprecated)`.
                       Other values will produce an error.
+                      Deprecated: this field will be removed in a future release when
+                      the `contour` xDS server implementation is removed.
                     type: string
                 type: object
             type: object
@@ -5151,6 +5153,8 @@ spec:
                           Defines the XDSServer to use for `contour serve`.
                           Values: `envoy` (default), `contour (deprecated)`.
                           Other values will produce an error.
+                          Deprecated: this field will be removed in a future release when
+                          the `contour` xDS server implementation is removed.
                         type: string
                     type: object
                 type: object

diff --git a/internal/contourconfig/contourconfiguration_test.go b/internal/contourconfig/contourconfiguration_test.go
@@ -206,12 +206,12 @@ func TestOverlayOnDefaults(t *testing.T) {
 		"ContourConfig with single non-default field is overlaid correctly": {
 			contourConfig: contour_v1alpha1.ContourConfigurationSpec{
 				XDSServer: &contour_v1alpha1.XDSServerConfig{
-					Type: contour_v1alpha1.EnvoyServerType,
+					Port: 7777,
 				},
 			},
 			want: func() contour_v1alpha1.ContourConfigurationSpec {
 				res := contourconfig.Defaults()
-				res.XDSServer.Type = contour_v1alpha1.EnvoyServerType
+				res.XDSServer.Port = 7777
 				return res
 			},
 		},

diff --git a/pkg/config/parameters.go b/pkg/config/parameters.go
@@ -242,6 +242,8 @@ func (t ProtocolParameters) Validate() error {
 type ServerParameters struct {
 	// Defines the XDSServer to use for `contour serve`.
 	// Defaults to "envoy"
+	// Deprecated: this field will be removed in a future release when
+	// the `contour` xDS server implementation is removed.
 	XDSServerType ServerType `yaml:"xds-server-type,omitempty"`
 }
 

diff --git a/site/content/docs/main/config/api-reference.html b/site/content/docs/main/config/api-reference.html
@@ -9046,6 +9046,8 @@ <h3 id="projectcontour.io/v1alpha1.XDSServerConfig">XDSServerConfig
 <p>Defines the XDSServer to use for <code>contour serve</code>.</p>
 <p>Values: <code>envoy</code> (default), <code>contour (deprecated)</code>.</p>
 <p>Other values will produce an error.</p>
+<p>Deprecated: this field will be removed in a future release when
+the <code>contour</code> xDS server implementation is removed.</p>
 </td>
 </tr>
 <tr>

diff --git a/site/content/docs/main/configuration.md b/site/content/docs/main/configuration.md
@@ -206,7 +206,7 @@ The server configuration block can be used to configure various settings for the
 
 | Field Name      | Type   | Default | Description                                                                   |
 | --------------- | ------ | ------- | ----------------------------------------------------------------------------- |
-| xds-server-type | string | envoy   | This field specifies the xDS Server to use. Options are `envoy` or `contour` (deprecated). |
+| xds-server-type | string | envoy   | This field specifies the xDS Server to use. Options are `envoy` or `contour` (deprecated). **This field is deprecated** and will be removed in a future release when the `contour` xDS server implementation is removed. |
 
 ### Gateway Configuration