diff --git a/apis/projectcontour/v1alpha1/contourconfig.go b/apis/projectcontour/v1alpha1/contourconfig.go index 08fd76a23fc..05545e30493 100644 --- 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/examples/contour/01-crds.yaml b/examples/contour/01-crds.yaml index 00aebca5e95..bef93fe89c9 100644 --- a/examples/contour/01-crds.yaml +++ b/examples/contour/01-crds.yaml @@ -1143,6 +1143,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 @@ -4919,6 +4921,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 index b7663b38be1..345f4f3f74e 100644 --- a/examples/render/contour-deployment.yaml +++ b/examples/render/contour-deployment.yaml @@ -1363,6 +1363,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 @@ -5139,6 +5141,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 index 91a8ac8a800..327714592e0 100644 --- a/examples/render/contour-gateway-provisioner.yaml +++ b/examples/render/contour-gateway-provisioner.yaml @@ -1154,6 +1154,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 @@ -4930,6 +4932,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 index 0d70b6c4c4f..750fd066b16 100644 --- a/examples/render/contour-gateway.yaml +++ b/examples/render/contour-gateway.yaml @@ -1179,6 +1179,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 @@ -4955,6 +4957,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 index b44c26538bc..626eac5888e 100644 --- a/examples/render/contour.yaml +++ b/examples/render/contour.yaml @@ -1363,6 +1363,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 @@ -5139,6 +5141,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/pkg/config/parameters.go b/pkg/config/parameters.go index b4c7aaa3869..51a1ba3eec8 100644 --- 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 index b9ba8f7400d..8dba46b5e33 100644 --- a/site/content/docs/main/config/api-reference.html +++ b/site/content/docs/main/config/api-reference.html @@ -9031,6 +9031,8 @@
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.