Skip to content

docs: add Kubernetes compatibility matrix, update stale max-kube version - #455

Open
yashrajshuklaaa wants to merge 2 commits into
kagent-dev:mainfrom
yashrajshuklaaa:docs/k8s-compatibility-matrix
Open

docs: add Kubernetes compatibility matrix, update stale max-kube version#455
yashrajshuklaaa wants to merge 2 commits into
kagent-dev:mainfrom
yashrajshuklaaa:docs/k8s-compatibility-matrix

Conversation

@yashrajshuklaaa

Copy link
Copy Markdown

Adds a Kubernetes version compatibility page under Resources, and fixes a stale value in the max-kube version snippet.

Addresses kagent-dev/kagent#2268

What this does

Adds docs-site/content/kagent/resources/kubernetes-compatibility.md, a new Resources page listing which Kubernetes version each kagent release is tested against, plus a stated support policy.
Updates docs-site/assets/versions/max-kube.md from 1.31 to 1.35. This snippet existed already but was stale and not referenced from any page, so it was silently out of date.

Where the numbers come from

The tested Kubernetes version is KIND_IMAGE_VERSION in the kagent repo's Makefile, which pins the kindest/node image used in CI. History pulled from git log on that Makefile:

v0.6.16 to v0.7.10: 1.34
v0.7.11 onward (current main): 1.35

CI currently tests one Kubernetes minor version per release, not a matrix. The page states this directly rather than implying broader coverage than what's actually tested. It also notes client-go's version skew policy as a rough guide for untested versions, without claiming compatibility kagent doesn't actually verify.

Follow-up, not part of this PR

Moving to an N-2 support policy (testing the current version plus two prior) would need CI to run a version matrix instead of a single pinned KIND_IMAGE_VERSION. That's a change to the kagent repo's CI, not this docs repo, so it's left as a follow-up rather than bundled here.

Testing

Built locally with hugo160 (extended, per DEVELOPMENT.md). Confirmed the reuse shortcode resolves correctly, the table renders, and the page appears in the Resources nav at weight 4, between Tools Ecosystem and FAQs.

Addresses kagent-dev/kagent#2268

Signed-off-by: Yashraj Shukla <shuklayashraj68@gmail.com>
…ion form)

Signed-off-by: Yashraj Shukla <shuklayashraj68@gmail.com>

@artberger artberger left a comment

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.

Thank you for this PR. I left some comments/questions.

Comment on lines +15 to +16
| v0.7.11 and later (including main) | 1.35 | Supported |
| v0.6.16 to v0.7.10 | 1.34 | Supported |

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)


## 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?

Comment on lines +2 to +3
title: Kubernetes Compatibility
linkTitle: Kubernetes Compatibility

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants