Skip to content

Commit

Permalink
deprecate xDS server type field
Browse files Browse the repository at this point in the history 
Fields are planned to be removed in the 1.31 release.

Updates projectcontour#2134.

Signed-off-by: Steve Kriss <[email protected]>
  • Loading branch information
@skriss
skriss committed Jul 17, 2024
1 parent 260151f commit 978048a
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 1 deletion.
3 changes: 3 additions & 0 deletions apis/projectcontour/v1alpha1/contourconfig.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"`

Expand Down
4 changes: 4 additions & 0 deletions examples/contour/01-crds.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions examples/render/contour-deployment.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions examples/render/contour-gateway-provisioner.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions examples/render/contour-gateway.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions examples/render/contour.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions pkg/config/parameters.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"`
}

Expand Down
2 changes: 2 additions & 0 deletions site/content/docs/main/config/api-reference.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9031,6 +9031,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>
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/main/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 978048a

Please sign in to comment.