Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs-site/assets/versions/max-kube.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.35
29 changes: 29 additions & 0 deletions docs-site/content/kagent/resources/kubernetes-compatibility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Kubernetes Compatibility
linkTitle: Kubernetes Compatibility
Comment on lines +2 to +3

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might want to call this page just "Version support" and rename the file versions.md in case we want to discuss more than just Kubernetes versions down the road.

For example, related projects like agentgateway.

description: Which Kubernetes versions kagent is tested and supported against.
weight: 4
author: kagent.dev
---

kagent's CI tests against Kubernetes {{< reuse "versions/max-kube.md" >}} today. Below is a history of which Kubernetes version each release was tested against, and the policy we follow going forward.

## Compatibility matrix

| kagent version | Kubernetes version tested | Status |
|---|---|---|
| v0.7.11 and later (including main) | 1.35 | Supported |
| v0.6.16 to v0.7.10 | 1.34 | Supported |
Comment on lines +15 to +16

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does Supported mean? I am not sure that we support any old versions of kagent except the latest (v0.9)

| Earlier than v0.6.16 | 1.33 and earlier | Untested, best effort only |

The tested version comes from `KIND_IMAGE_VERSION` in the [kagent Makefile](https://github.com/kagent-dev/kagent/blob/main/Makefile). This pins the [kindest/node](https://hub.docker.com/r/kindest/node) image used to spin up the Kind cluster in [CI](https://github.com/kagent-dev/kagent/blob/main/.github/workflows/ci.yaml). Right now CI only exercises one Kubernetes minor version per release, not a matrix.

## Support policy

kagent tests and supports one Kubernetes minor version per release: whatever `KIND_IMAGE_VERSION` was pinned to when that release was cut. We want to move to an N-2 policy (current version plus the two before it) once CI actually runs a version matrix instead of a single pinned version.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typically avoid 1st-person/"we".

We want to move to an N-2 policy

When was this decided? I did not see it in the issue, for example. Was it at a community meeting?


Versions not listed in the table above are not tested in CI. They might still work. kagent's Kubernetes client libraries (client-go, k8s.io/api, k8s.io/apimachinery) follow the [official client-go skew policy](https://github.com/kubernetes/client-go#compatibility-matrix), which generally supports API servers within one minor version of the client. That said, kagent does not guarantee compatibility outside the versions above.

## Keeping this page current

Update this page whenever `KIND_IMAGE_VERSION` changes in the kagent Makefile, or when a new kagent version ships. The current tested version is sourced from `docs-site/assets/versions/max-kube.md`. Update that file, then add a new row to the table for the release.