Skip to content

Commit 811ad26

Browse files
authored
docs for 2.2.x (#657)
* template Signed-off-by: Art Berger <art.berger@solo.io> * hugo and versions.json Signed-off-by: Art Berger <art.berger@solo.io> * versions and shortcodes Signed-off-by: Art Berger <art.berger@solo.io> * version Signed-off-by: Art Berger <art.berger@solo.io> * latest to 2.1.x Signed-off-by: Art Berger <art.berger@solo.io> * main to latest Signed-off-by: Art Berger <art.berger@solo.io> * 2.3 main Signed-off-by: Art Berger <art.berger@solo.io> * relnotes Signed-off-by: Art Berger <art.berger@solo.io> --------- Signed-off-by: Art Berger <art.berger@solo.io> Signed-off-by: Art <artberger@users.noreply.github.com>
1 parent 0b6961f commit 811ad26

273 files changed

Lines changed: 15192 additions & 3215 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/release.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ assignees: ''
1515
- [ ] Confirm that the upgrade and release note pages are updated. Typically, this is a separate issue.
1616
- [ ] In `content/docs`, create the new `main` by making a copy of the current main directory. Rename the directories appropriately. For example, the old main is copied to a new `main`, the old main becomes `latest`, and the old latest becomes a `2.x.x` version.
1717
- [ ] In the `hugo.yaml` file, update the `versions` to include the new minor version as main, the previous main as latest, and the previous latest as its version.
18+
- [ ] In the `versions.json` file, update the `versions` to include the new minor version as main, the previous main as latest, and the previous latest as its version.
1819
- [ ] Retire any version older than `n-3` (remove the directory and version from the `hugo.yaml` file)
1920
- [ ] Update the version conrefs in the `assets/docs/versions` directory. Often, there is not a release for the next version, so you might have to use the same for latest and main.
2021
- [ ] Add the release date to the version table in `assets/docs/pages/reference/versions.md`, and remove any retired versions.
@@ -35,4 +36,5 @@ assignees: ''
3536

3637
- [ ] Merge in the autogenerated PR that the workflow created
3738
- [ ] Verify that the docs are published
38-
- [ ] Cut a GitHub release of the docs repo for the new release, and include any retired version (such as `Release for 2.6.x and last state for retired 2.2.x`)
39+
- [ ] Cut a GitHub release of the docs repo for the new release, and include any retired version (such as `Release for 2.6.x and last state for retired 2.2.x`)
40+
- [ ] If maintaining a downstream version, update the content paths for the new version.

assets/docs/pages/about/custom-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Kgateway uses the following custom resources to attach policies to routes and ga
6767

6868
* [**DirectResponse**]({{< link-hextra path="/traffic-management/direct-response/" >}}): Directly respond to incoming requests with a custom HTTP response code and body.
6969
* [**HTTPListenerPolicy**]({{< link-hextra path="/about/policies/httplistenerpolicy/" >}}): Apply policies to all HTTP and HTTPS listeners.
70-
* [**TrafficPolicy**](https://kgateway.dev/docs/envoy/main/about/policies/trafficpolicy/): Attach policies to routes in an HTTPRoute resource.
70+
* [**TrafficPolicy**]({{< link-hextra path="/about/policies/trafficpolicy/" >}}): Attach policies to routes in an HTTPRoute resource.
7171

7272
### {{< reuse "docs/snippets/backend.md" >}}s
7373

assets/docs/pages/about/policies-index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ While the {{< reuse "docs/snippets/k8s-gateway-api-name.md" >}} allows you to do
77

88
Kgateway uses the following custom resources to attach policies to routes and gateway listeners.
99

10-
{{< version include-if="2.2.x,2.1.x" >}}
10+
{{< version exclude-if="2.0.x" >}}
1111
{{< cards >}}
1212
{{< card link="../policies/backendconfigpolicy/" title="BackendConfigPolicy" subtitle="Configure connection settings to an upstream service." >}}
1313
{{< card link="../../traffic-management/direct-response/" title="Direct response" subtitle="Directly respond to incoming requests with a custom HTTP response code and body." >}}
@@ -37,12 +37,12 @@ Review the policies that you can configure in kgateway and the level at which yo
3737
| [External authorization](../../security/external-auth) | GatewayExtension and {{< reuse "docs/snippets/trafficpolicy.md" >}} |
3838
| [External processing (ExtProc)](../../traffic-management/extproc/) | {{< reuse "docs/snippets/trafficpolicy.md" >}} |
3939
| [Health checks for the Gateway](../../traffic-management/health-checks/gateway)| HTTPListenerPolicy |
40-
| [Health checks for the Backends](../../traffic-management/health-checks/backend)| BackendConfigPolicy |{{% version include-if="2.2.x,2.1.x" %}}
40+
| [Health checks for the Backends](../../traffic-management/health-checks/backend)| BackendConfigPolicy |{{% version exclude-if="2.0.x" %}}
4141
| [HTTP connection settings](../../resiliency/connection)| BackendConfigPolicy |
4242
| [Outlier detection](../../resiliency/outlier-detection)| BackendConfigPolicy | {{% /version %}}
4343
| [Rate limiting](../../security/ratelimit/) | {{< reuse "docs/snippets/trafficpolicy.md" >}} |
4444
| [Session affinity - Simple load balancing](../../traffic-management/session-affinity/loadbalancing/) | BackendConfigPolicy |
45-
| [Session affinity - Consistent hashing](../../traffic-management/session-affinity/consistent-hashing/) | BackendConfigPolicy | {{% version include-if="2.2.x,2.1.x" %}}
45+
| [Session affinity - Consistent hashing](../../traffic-management/session-affinity/consistent-hashing/) | BackendConfigPolicy | {{% version exclude-if="2.0.x" %}}
4646
| [TCP keepalive](../../resiliency/tcp-keepalive/) | BackendConfigPolicy | {{% /version %}}
4747
| [Transformations](../../traffic-management/transformations) | {{< reuse "docs/snippets/trafficpolicy.md" >}} |
4848
## Policy behavior

assets/docs/pages/install/advanced.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For more information, see the [Helm reference docs]({{< link-hextra path="/refer
2020

2121
When using the development build {{< reuse "docs/versions/patch-dev.md" >}}, add `--set controller.image.pullPolicy=Always` to ensure you get the latest image. For production environments, this setting is not recommended as it might impact performance.
2222

23-
{{< version include-if="2.2.x" >}}
23+
{{< version exclude-if="2.0.x,2.1.x" >}}
2424

2525
### Experimental Gateway API features {#experimental-gateway-api-features}
2626

@@ -40,7 +40,7 @@ controller:
4040
```
4141
{{< /version >}}
4242
43-
{{< version include-if="2.2.x,2.1.x" >}}
43+
{{< version exclude-if="2.0.x,2.1.x" >}}
4444
4545
## Leader election
4646
@@ -87,7 +87,7 @@ discoveryNamespaceSelectors:
8787
version: v3
8888
```
8989

90-
{{< version include-if="2.2.x,2.1.x" >}}
90+
{{< version exclude-if="2.0.x,2.1.x" >}}
9191

9292
## TLS encryption {#tls-encryption}
9393

assets/docs/pages/operations/upgrade.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,9 +185,8 @@ For Istio upgrades, consult the docs based on the way that you installed Istio.
185185

186186
4. Upgrade the {{< reuse "docs/snippets/kgateway.md" >}} control plane Helm installation.
187187
* Make sure to include your Helm values when you upgrade either as a configuration file or with `--set` flags. Otherwise, any previous custom values that you set might be overwritten.
188-
* When using the development build v{{< reuse "docs/versions/patch-dev.md" >}}, add the `--set controller.image.pullPolicy=Always` option to ensure you get the latest image. Alternatively, you can specify the exact image digest.{{< version include-if="2.2.x,2.1.x" >}}
189-
* To use experimental Gateway API features, include the experimental feature gate, `--set controller.extraEnv.KGW_ENABLE_GATEWAY_API_EXPERIMENTAL_FEATURES=true`.
190-
{{< /version >}}
188+
* When using the development build v{{< reuse "docs/versions/patch-dev.md" >}}, add the `--set controller.image.pullPolicy=Always` option to ensure you get the latest image. Alternatively, you can specify the exact image digest.{{< version exclude-if="2.0.x" >}}
189+
* To use experimental Gateway API features, include the experimental feature gate, `--set controller.extraEnv.KGW_ENABLE_GATEWAY_API_EXPERIMENTAL_FEATURES=true`.{{< /version >}}
191190

192191
```sh
193192
helm upgrade -i -n {{< reuse "docs/snippets/namespace.md" >}} {{< reuse "/docs/snippets/helm-kgateway.md" >}} oci://{{< reuse "/docs/snippets/helm-path.md" >}}/charts/{{< reuse "/docs/snippets/helm-kgateway.md" >}} \

assets/docs/pages/reference/add-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ The documentation maintainers of the kgateway project will review your pull requ
253253
The kgateway project automatically generates the following documentation from the code.
254254

255255
* [API reference]({{< link-hextra path="/reference/api/" >}})
256-
* [Helm reference]({{< link-hextra path="/reference/helm/" >}}){{< version include-if="2.2.x,2.1.x" >}}
256+
* [Helm reference]({{< link-hextra path="/reference/helm/" >}}){{< version exclude-if="2.0.x" >}}
257257
* [Control plane metrics](../../../observability/control-plane-metrics/){{< /version >}}
258258

259259
To learn more about how to generate these docs, see the [GitHub Workflows README](https://github.com/kgateway-dev/kgateway.dev/tree/main/.github/workflows/README.md).

assets/docs/pages/reference/versions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Review the following information about supported release versions for kgateway.
44

55
| Kgateway | Release date | Kubernetes | Gateway API`*` | Envoy | Helm | Istio`` |
66
|----------|--------------|------------|----------------|-------|------|----------|
7+
| 2.1.x | 09 Feb 2026 | 1.31 - 1.35 | 1.4.x | Proxy 1.35, API v3 | >= 3.12 | 1.23 - 1.27 |
78
| 2.1.x | 10 Oct 2025 | 1.31 - 1.34 | 1.4.x | Proxy 1.35, API v3 | >= 3.12 | 1.23 - 1.27 |
89
| 2.0.x | 01 Apr 2025 | 1.27 - 1.31 | 1.2.x | Proxy 1.33, API v3 | >= 3.12 | 1.18 - 1.23 |
910

0 commit comments

Comments
 (0)