Skip to content

Commit

Permalink
v1.29.0 docs and config updates (#6424)
Browse files Browse the repository at this point in the history
* Prepare documentation site for v1.29.0 release.
* Add changelog for v1.29.0 release.
* update compat matrix, versions.yaml
* update dependabot, trivy configs

Signed-off-by: Steve Kriss <stephen.kriss@gmail.com>
  • Loading branch information
skriss committed May 7, 2024
1 parent f2f403c commit fcf5007
Show file tree
Hide file tree
Showing 90 changed files with 18,369 additions and 82 deletions.
14 changes: 7 additions & 7 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ updates:
patterns:
- "actions/upload-artifact"
- "actions/download-artifact"

# release branch N targets
- target-branch: release-1.28
- target-branch: release-1.29
package-ecosystem: "gomod"
directory: "/"
schedule:
Expand All @@ -57,7 +57,7 @@ updates:
k8s-dependencies:
patterns:
- "k8s.io/*"
- target-branch: release-1.28
- target-branch: release-1.29
package-ecosystem: "github-actions"
directory: "/"
schedule:
Expand All @@ -80,7 +80,7 @@ updates:
- "actions/download-artifact"

# release branch N-1 targets
- target-branch: release-1.27
- target-branch: release-1.28
package-ecosystem: "gomod"
directory: "/"
schedule:
Expand All @@ -100,7 +100,7 @@ updates:
k8s-dependencies:
patterns:
- "k8s.io/*"
- target-branch: release-1.27
- target-branch: release-1.28
package-ecosystem: "github-actions"
directory: "/"
schedule:
Expand All @@ -123,7 +123,7 @@ updates:
- "actions/download-artifact"

# release branch N-2 targets
- target-branch: release-1.26
- target-branch: release-1.27
package-ecosystem: "gomod"
directory: "/"
schedule:
Expand All @@ -143,7 +143,7 @@ updates:
k8s-dependencies:
patterns:
- "k8s.io/*"
- target-branch: release-1.26
- target-branch: release-1.27
package-ecosystem: "github-actions"
directory: "/"
schedule:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/trivy-scan.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ jobs:
matrix:
branch:
- main
- release-1.29
- release-1.28
- release-1.27
- release-1.26
runs-on: ubuntu-latest
permissions:
security-events: write
Expand Down
144 changes: 144 additions & 0 deletions changelogs/CHANGELOG-v1.29.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
We are delighted to present version v1.29.0 of Contour, our layer 7 HTTP reverse proxy for Kubernetes clusters.

A big thank you to everyone who contributed to the release.


- [Major Changes](#major-changes)
- [Minor Changes](#minor-changes)
- [Other Changes](#other-changes)
- [Docs Changes](#docs-changes)
- [Deprecations/Removals](#deprecation-and-removal-notices)
- [Installing/Upgrading](#installing-and-upgrading)
- [Compatible Kubernetes Versions](#compatible-kubernetes-versions)
- [Community Thanks!](#community-thanks)

# Major Changes

## Default xDS Server Implementation is now Envoy

As of this release, Contour now uses the `envoy` xDS server implementation by default.
This xDS server implementation is based on Envoy's [go-control-plane project](https://github.com/envoyproxy/go-control-plane) and will eventually be the only supported xDS server implementation in Contour.
This change is expected to be transparent to users.

### I'm seeing issues after upgrading, how to I revert to the contour xDS server?

If you encounter any issues, you can easily revert to the `contour` xDS server with the following configuration:

(if using Contour config file)
```yaml
server:
xds-server-type: contour
```
(if using ContourConfiguration CRD)
```yaml
...
spec:
xdsServer:
type: contour
```
You will need to restart Contour for the changes to take effect.
(#6146, @skriss)
## Gateway API: Inform on v1 types
Contour no longer informs on v1beta1 resources that have graduated to v1.
This includes the "core" resources GatewayClass, Gateway, and HTTPRoute.
This means that users should ensure they have updated CRDs to Gateway API v1.0.0 or newer, which introduced the v1 version with compatibility with v1beta1.
(#6153, @sunjayBhatia)
# Minor Changes
## Use EndpointSlices by default
Contour now uses the Kubernetes EndpointSlices API by default to determine the endpoints to configure Envoy, instead of the Endpoints API.
Note: if you need to continue using the Endpoints API, you can disable the feature flag via `featureFlags: ["useEndpointSlices=false"]` in the Contour config file or ContourConfiguration CRD.

(#6149, @izturn)

## Gateway API: handle Route conflicts with HTTPRoute.Matches

It's possible that multiple HTTPRoutes will define the same Match conditions. In this case the following logic is applied to resolve the conflict:

- The oldest Route based on creation timestamp. For example, a Route with a creation timestamp of “2020-09-08 01:02:03” is given precedence over a Route with a creation timestamp of “2020-09-08 01:02:04”.
- The Route appearing first in alphabetical order (namespace/name) for example, foo/bar is given precedence over foo/baz.

With above ordering, any HTTPRoute that ranks lower, will be marked with below conditions accordionly
1. If only partial rules under this HTTPRoute are conflicted, it's marked with `Accepted: True` and `PartiallyInvalid: true` Conditions and Reason: `RuleMatchPartiallyConflict`.
2. If all the rules under this HTTPRoute are conflicted, it's marked with `Accepted: False` Condition and Reason `RuleMatchConflict`.

(#6188, @lubronzhan)

## Spawn Upstream Span is now enabled in tracing

As described in [Envoy documentations](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-tracing), ```spawn_upstream_span``` should be true when envoy is working as an independent proxy and from now on contour tracing spans will show up as a parent span to upstream spans.

(#6271, @SamMHD)


# Other Changes
- Fix data race in BackendTLSPolicy status update logic. (#6185, @sunjayBhatia)
- Fix for specifying a health check port with an ExternalName Service. (#6230, @yangyy93)
- Updates the example `envoyproxy/ratelimit` image tag to `19f2079f`, for multi-arch support and other improvements. (#6246, @skriss)
- In the `envoy` go-control-plane xDS server, use a separate snapshot cache for Endpoints, to minimize the amount of unnecessary xDS traffic generated. (#6250, @skriss)
- If there were no relevant resources for Contour in the watched namespaces during the startup of a follower instance of Contour, it did not reach a ready state. (#6295, @tsaarni)
- Added support for enabling circuit breaker statistics tracking. (#6297, @rajatvig)
- Updates to Go 1.22.2. See the [Go release notes](https://go.dev/doc/devel/release#go1.22.minor) for more information. (#6327, @skriss)
- Gateway API: add support for HTTPRoute's Timeouts.BackendRequest field. (#6335, @skriss)
- Updates Envoy to v1.30.1. See the v1.30.0 release notes [here](https://www.envoyproxy.io/docs/envoy/v1.30.1/version_history/v1.30/v1.30.0) and the v1.30.1 release notes [here](https://www.envoyproxy.io/docs/envoy/v1.30.1/version_history/v1.30/v1.30.1). (#6353, @tico88612)
- Gateway API: a timeout value of `0s` disables the timeout. (#6375, @skriss)
- Fix provisioner to use separate `--disable-feature` flags on Contour Deployment for each disabled feature. Previously a comma separated list was passed which was incorrect. (#6413, @sunjayBhatia)


# Deprecation and Removal Notices

## Configuring Contour with a GatewayClass controller name is no longer supported

Contour can no longer be configured with a GatewayClass controller name (gateway.controllerName in the config file or ContourConfiguration CRD), as the config field has been removed.
Instead, either use a specific Gateway reference (gateway.gatewayRef), or use the Gateway provisioner.

(#6145, @skriss)

## Contour xDS server implementation is now deprecated

As of this release, the `contour` xDS server implementation is now deprecated.
Once the go-control-plane based `envoy` xDS server has had sufficient production bake time, the `contour` implementation will be removed from Contour.
Notification of removal will occur at least one release in advance.

(#6146, @skriss)

## Use of Endpoints API is deprecated

Contour now uses the EndpointSlices API by default, and its usage of the Endpoints API is deprecated as of this release. Support for Endpoints, and the associated `useEndpointSlices` feature flag, will be removed in a future release.

(#6149, @izturn)


# Installing and Upgrading

For a fresh install of Contour, consult the [getting started documentation](https://projectcontour.io/getting-started/).

To upgrade an existing Contour installation, please consult the [upgrade documentation](https://projectcontour.io/resources/upgrading/).


# Compatible Kubernetes Versions

Contour v1.29.0 is tested against Kubernetes 1.27 through 1.29.

# Community Thanks!
We’re immensely grateful for all the community contributions that help make Contour even better! For this release, special thanks go out to the following contributors:

- @SamMHD
- @izturn
- @lubronzhan
- @rajatvig
- @tico88612
- @yangyy93


# Are you a Contour user? We would love to know!
If you're using Contour and want to add your organization to our adopters list, please visit this [page](https://projectcontour.io/resources/adopters/). If you prefer to keep your organization name anonymous but still give us feedback into your usage and scenarios for Contour, please post on this [GitHub thread](https://github.com/projectcontour/contour/issues/1269).
4 changes: 0 additions & 4 deletions changelogs/unreleased/6145-skriss-deprecation.md

This file was deleted.

5 changes: 0 additions & 5 deletions changelogs/unreleased/6146-skriss-deprecation.md

This file was deleted.

25 changes: 0 additions & 25 deletions changelogs/unreleased/6146-skriss-major.md

This file was deleted.

3 changes: 0 additions & 3 deletions changelogs/unreleased/6149-izturn-deprecation.md

This file was deleted.

5 changes: 0 additions & 5 deletions changelogs/unreleased/6149-izturn-minor.md

This file was deleted.

5 changes: 0 additions & 5 deletions changelogs/unreleased/6153-sunjayBhatia-major.md

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/6185-sunjayBhatia-small.md

This file was deleted.

10 changes: 0 additions & 10 deletions changelogs/unreleased/6188-lubronzhan-minor.md

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/6230-yangyy93-small.md

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/6246-skriss-small.md

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/6250-skriss-small.md

This file was deleted.

4 changes: 0 additions & 4 deletions changelogs/unreleased/6271-SamMHD-minor.md

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/6295-tsaarni-small.md

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/6297-rajatvig-small.md

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/6327-skriss-small.md

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/6335-skriss-small.md

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/6353-tico88612-small.md

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/6375-skriss-small.md

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/6413-sunjayBhatia-small.md

This file was deleted.

3 changes: 2 additions & 1 deletion site/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ params:
github_url: "https://github.com/projectcontour/contour"
github_raw_url: "https://raw.githubusercontent.com/projectcontour/contour"
slack_url: "https://kubernetes.slack.com/messages/contour"
latest_version: "1.28"
latest_version: "1.29"
use_advanced_docs: true
docs_right_sidebar: true
docs_search: true
Expand All @@ -39,6 +39,7 @@ params:
docs_versioning: true
docs_versions:
- main
- "1.29"
- "1.28"
- "1.27"
- "1.26"
Expand Down
48 changes: 48 additions & 0 deletions site/content/docs/1.29/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
cascade:
layout: docs
version: "1.29"
branch: release-1.29
---

## Overview
Contour is an Ingress controller for Kubernetes that works by deploying the [Envoy proxy][1] as a reverse proxy and load balancer.
Contour supports dynamic configuration updates out of the box while maintaining a lightweight profile.

## Philosophy
- Follow an opinionated approach which allows us to better serve most users
- Design Contour to serve both the cluster administrator and the application developer
- Use our experience with ingress to define reasonable defaults for both cluster administrators and application developers.
- Meet users where they are by understanding and adapting Contour to their use cases

See the full [Contour Philosophy][8] page.

## Why Contour?
Contour bridges other solution gaps in several ways:
- Dynamically update the ingress configuration with minimal dropped connections
- Safely support multiple types of ingress config in multi-team Kubernetes clusters
- [Ingress/v1][10]
- [HTTPProxy (Contour custom resource)][2]
- [Gateway API][9]
- Cleanly integrate with the Kubernetes object model

## Prerequisites
Contour is tested with Kubernetes clusters running version [1.21 and later][4].

## Get started
Getting started with Contour is as simple as one command.
See the [Getting Started][3] document.

## Troubleshooting
If you encounter issues review the [troubleshooting][5] page, [file an issue][6], or talk to us on the [#contour channel][7] on Kubernetes slack.

[1]: https://www.envoyproxy.io/
[2]: config/fundamentals.md
[3]: /getting-started
[4]: /resources/compatibility-matrix.md
[5]: /docs/main/troubleshooting
[6]: https://github.com/projectcontour/contour/issues
[7]: https://kubernetes.slack.com/messages/contour
[8]: /resources/philosophy
[9]: guides/gateway-api
[10]: /docs/{{< param version >}}/config/ingress
Loading

0 comments on commit fcf5007

Please sign in to comment.