Skip to content

Commit aff7344

Browse files
authored
Docs for 1.18 LTS backport (#10476)
Co-authored-by: Nadine Spies <[email protected]>
1 parent db58c52 commit aff7344

11 files changed

+69
-18
lines changed
+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
changelog:
2+
- type: NON_USER_FACING
3+
description: >-
4+
Prepare 1.18 docs.
5+
skipCI-kube-tests:true

docs/active_versions.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"latest": "v1.17.x",
2+
"latest": "v1.18.x",
33
"versions": [
44
"main",
5-
"v1.17.x"
5+
"v1.18.x"
66
],
77
"oldVersions": [
8+
"v1.17.x",
89
"v1.16.x",
9-
"v1.15.x",
10-
"v1.14.x"
10+
"v1.15.x"
1111
]
1212
}

docs/content/operations/upgrading/faq.md

+50-4
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,50 @@ The Envoy dependency in Gloo Gateway 1.18 was upgraded from 1.29.x to 1.31.x. Th
6565
* **HTTP/2**: HTTP/2 colon prefixed headers are now sanitized by Envoy. Previously, sanitation was performed by the `nghttp2` library, which caused pseudo headers with upper case letters to fail validation. Now, these pseudo headers pass validation. You can temporarily revert this change by setting the runtime guard `envoy.reloadable_features.sanitize_http2_headers_without_nghttp2` to `false`.
6666
* **Local ratelimit**: The token bucket implementation changed. Previously, a timer-based token bucket was used to assign tokens to connections. In Envoy 1.31.x, the new AtomicToken bucket is used that is no longer timer-based. Tokens are now automatically refilled when the token bucket is accessed. Because of this change, the `x-ratelimit-reset` header is no longer sent. You can temporarily revert this change by setting the runtime guard `envoy.reloadable_features.no_timer_based_rate_limit_token_bucket` to `false`.
6767

68+
## New features
69+
70+
### Watch namespace based on label
71+
72+
Previously, the namespaces that you wanted Gloo Gateway to watch for resources needed to be provided as a static list via the `watchNamespaces` setting in the Settings resource and had to be updated manually every time a namespace was added or deleted. Starting in 1.18.0, you can now define the namespaces that you want to watch by using the `WatchNamespaceSelectors` option on the Settings CR. This way, Gloo Gateway automatically includes new namespaces that have the required selectors.
73+
74+
Label selectors can use exact matches or an `In`, `NotIn`, `Exists`, or `DoesNotExist` expression. You can also chain label selectors to form logical `AND` or `OR` expressions as shown in the following example.
75+
76+
```yaml
77+
settings:
78+
watchNamespaceSelectors:
79+
- matchLabels:
80+
label: match
81+
- matchLabels:
82+
label: and
83+
- matchExpressions:
84+
- key: expression
85+
operator: In
86+
values:
87+
- and
88+
```
89+
90+
{{% notice note %}}
91+
If you specify both the `watchNamespaces` and `watchNamespaceSelectors` setting, the `watchNamespaces` setting takes precedence.
92+
{{% /notice %}}
93+
94+
For more information, see [Specify namespaces to watch for Kuberenetes services and Gloo Gateway CRs]({{% versioned_link_path fromRoot="/installation/advanced_configuration/multiple-gloo-installs/#specify-namespaces-to-watch-for-kuberenetes-services-and-gloo-gateway-crs " %}}).
95+
96+
### ARM images
97+
98+
In Gloo Gateway Enterprise, ARM images are now supported for Gloo Gateway components. An image that is tagged with -arm is compatible with ARM64 architectures. Note that ARM images are currently not published for VMs.
99+
100+
### Kubernetes 1.30 and 1.31 support
101+
102+
Starting in version 1.18.0, Gloo Gateway can now run on Kubernetes 1.30 and 1.31. For more information about supported Kubernetes, Envoy, and Istio versions, see [Supported versions]({{% versioned_link_path fromRoot="/reference/support/" %}}).
103+
104+
### Front channel logout
105+
106+
You can configure a front channel logout path on an AuthConfig that configures OIDC authorization code for your apps.
107+
108+
Front channel logout is a security mechanism that is used in the context of Single Sign-On (SSO) and Identity and Access Management (IAM) systems to ensure that when a user logs out of one app or service, they are also automatically logged out of the Identity Provider (IdP) and therefore all related apps and services in a secure and synchronized manner. Without front channel logout, the user is logged out of the requested app only.
109+
110+
For more information, see [Front channel logout]({{% versioned_link_path fromRoot="/guides/security/auth/extauth/oauth/#front-channel-logout" %}}).
111+
68112

69113
<!-- ggv2-related changes:
70114
ggv2 - Disable Istio Envoy proxy from running by default and only rely on proxyless Istio agent mtls integration. Note: Although this is a change to the default behavior of the istio integration, this should not have any impact on most users as the sidecar proxy was unused in the data path. (https://github.com/solo-io/solo-projects/issues/5711)
@@ -184,7 +228,7 @@ New CRDs are automatically applied to your cluster when performing a `helm insta
184228

185229
Review the following summary of important new, deprecated, or removed CRD updates. For full details, see the [changelogs](#changelogs).
186230

187-
As part of the {{< readfile file="static/content/version_geoss_latest.md" markdown="true">}} release, no CLI changes were introduced.
231+
As part of the {{< readfile file="static/content/version_geoss_latest.md" markdown="true">}} release, no CRD changes were introduced.
188232
<!--
189233
**New and updated CRDs**:
190234

@@ -200,13 +244,15 @@ N/A
200244

201245
You must upgrade `glooctl` before you upgrade Gloo Gateway. Because `glooctl` can create resources in your cluster, such as with `glooctl add route`, you might have errors in Gloo Gateway if you create resources with an older version of `glooctl`.
202246

203-
As part of the {{< readfile file="static/content/version_geoss_latest.md" markdown="true">}} release, no CLI changes were introduced.
204-
<!--
247+
205248
Review the following summary of important new, deprecated, or removed CLI options. For full details, see the [changelogs](#changelogs).
206249

207250
**New CLI commands or options**:
208251

209-
* `glooctl create secret encryptionkey`: [Create encryption secrets]({{% versioned_link_path fromRoot="/reference/cli/glooctl_create_secret_encryptionkey/" %}}), such as to use in the `cipherConfig` field of the `ExtAuthConfig` resource.
252+
* `glooctl proxy snapshot`: [Create a snapshot of the current state in Envoy]({{% versioned_link_path fromRoot="/reference/cli/glooctl_proxy_snapshot/" %}}) for the purpose of simplified issue reporting and triaging.
253+
254+
<!-->
255+
As part of the {{< readfile file="static/content/version_geoss_latest.md" markdown="true">}} release, no CLI changes were introduced.
210256

211257
**Changed behavior**:-->
212258

docs/content/reference/support.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ Gloo Gateway Enterprise offers `n-3` patching support for bug and critical secur
1212

1313
| Gloo Gateway | Kubernetes | Envoy | Helm | Istio`` |
1414
|------|----------|---------|--------|-------------|
15+
| 1.18.x | 1.27 - 1.31 | v3 xDS API | >= 3.12 | 1.18 - 1.23 |
1516
| 1.17.x | 1.25 - 1.29 | v3 xDS API | >= 3.12 | 1.16 - 1.22 |
1617
| 1.16.x | 1.24 - 1.28 | v3 xDS API | >= 3.12 | 1.14 - 1.20 |
1718
| 1.15.x | 1.23 - 1.27 | v3 xDS API | >= 3.11 | 1.13 - 1.18 |
18-
| 1.14.x | 1.23 - 1.25 | v3 xDS API | >= 3.8 | 1.13 - 1.18 |
1919

2020
{{% notice note %}}`` **Istio versions**: Istio must run on a compatible version of Kubernetes. For example, Istio 1.22 is tested, but not supported, on Kubernetes 1.26. For more information, see the [Istio docs](https://istio.io/latest/docs/releases/supported-releases/). If you want hardened `n-4` versions of Istio for particular requirements such as FIPS, consider using [Gloo Mesh Enterprise](https://www.solo.io/products/gloo-mesh/), which includes ingress gateway and service mesh components.
2121

@@ -52,7 +52,7 @@ You have two options for specifying the variant for a Gloo Gateway image in your
5252

5353
Gloo Gateway Enterprise releases are built on the OSS codebase and typically follow the equivalent Gloo Gateway OSS release. The OSS version is always released as the latest build, while Enterprise version is always released as the first stable build of that version. For example, the latest build of Gloo Gateway OSS is {{< readfile file="static/content/version_geoss_latest.md" markdown="true">}}, while the latest stable build of Gloo Gateway Enterprise is {{< readfile file="static/content/version_gee_latest.md" markdown="true">}}.
5454

55-
Stable builds for both Gloo Gateway Enterprise and OSS are released as minor versions approximately every three months. A stable branch for a minor version, such as 1.14, is tagged from `main`, and stable builds for both Enterprise and OSS are supported from that branch.
55+
Stable builds for both Gloo Gateway Enterprise and OSS are released as minor versions approximately every three months. A stable branch for a minor version, such as 1.18, is tagged from `main`, and stable builds for both Enterprise and OSS are supported from that branch.
5656

5757
## Release development
5858

@@ -64,7 +64,7 @@ New features for Gloo Gateway Enterprise and OSS are always developed on `main`.
6464

6565
Development of a quality stable release on `main` typically follows this process:
6666
1. New feature development is suspended on `main`.
67-
2. Release candidates are created, such as `1.14.0-rc1`, `1.14.0-rc2`, and so on.
67+
2. Release candidates are created, such as `1.18.0-rc1`, `1.18.0-rc2`, and so on.
6868
3. A full suite fo tests is performed for each release candidate. Testing includes all documented workflows, a test matrix of all supported platforms, and more.
6969
4. Documentation for that release is prepared, vetted, and staged.
7070
5. The stable minor version is released.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.18.0-rc3
1+
1.18.0
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.18.0-rc3
1+
1.18.0
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.17.3
1+
1.17.4
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.17.2
1+
1.17.3
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.18.0-rc3
1+
1.18.0
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.18.0-rc3
1+
1.19.0-beta2
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.17.15
1+
1.17.16

0 commit comments

Comments
 (0)