Skip to content

docs: align Kubernetes version requirements across doc versions - #814

Merged
Mirage20 merged 2 commits into
openchoreo:mainfrom
Mirage20:k8s-version-requirement
Aug 10, 2026
Merged

docs: align Kubernetes version requirements across doc versions#814
Mirage20 merged 2 commits into
openchoreo:mainfrom
Mirage20:k8s-version-requirement

Conversation

@Mirage20

@Mirage20 Mirage20 commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Purpose

The platform engineer guide and FAQ stated Kubernetes 1.32 or later in every doc version, while the v1.2.x getting started page stated 1.33 or later. The kubectl version was also inconsistent across these pages, and the getting started pages described the cluster version as a recommended baseline rather than a requirement.

Kubernetes 1.32 and 1.33 have both reached end of life, so current and v1.2.x now state 1.34 or later.

Changes

  • Current and v1.2.x state Kubernetes 1.34 or later, and kubectl v1.34+, across the deployment topology, FAQ, and getting started pages
  • v1.0.x and v1.1.x keep their 1.32 baseline, with a note that the default build workflows need 1.33 or later, since those quick starts create a 1.32 cluster
  • Getting started pages now say "Minimum supported Kubernetes version" instead of "Recommended cluster baseline", so all pages state the same requirement
  • Removed the kernel, containerd, and runc version requirements. These are implied by the Kubernetes version and are not the only node level dependencies, so listing them is incomplete and hard to keep current.

Related Issues

N/A

Checklist

  • Updated sidebars.ts if adding a new documentation page
  • Run npm run start to preview the changes locally
  • Run npm run build to ensure the build passes without errors
  • Verified all links are working (no broken links)

The platform engineer guide and FAQ stated Kubernetes 1.32 or later in every
doc version, while the v1.2.x getting started page stated 1.33 or later. The
kubectl version was also inconsistent across pages.

Kubernetes 1.32 and 1.33 both reached end of life, so current and v1.2.x now
state 1.34 or later. The v1.0.x and v1.1.x pages keep their 1.32 baseline and
note that the default build workflows need 1.33 or later, since those quick
starts create a 1.32 cluster.

Signed-off-by: Miraj Abeysekara <miraj@wso2.com>
@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated setup and deployment prerequisites to require Kubernetes 1.34+ and kubectl v1.34+.
    • Updated local K3d, environment setup, deployment topology, and FAQ guidance.
    • Removed outdated user namespaces warnings and related runtime requirements.

Walkthrough

The documentation updates Kubernetes and kubectl minimum versions to 1.34+ across setup, deployment, and FAQ pages. The environment guide also removes obsolete user namespace and runtime requirements.

Changes

Kubernetes prerequisite documentation

Layer / File(s) Summary
Align documented Kubernetes requirements
docs/getting-started/try-it-out/on-k3d-locally.mdx, docs/getting-started/try-it-out/on-your-environment.mdx, docs/platform-engineer-guide/deployment-topology.mdx, docs/reference/faq.md
The documentation now requires Kubernetes and kubectl 1.34+. The environment guide removes the previous user namespace and runtime requirements warning.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: rashadism

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the main change: aligning Kubernetes version requirements across documentation versions.
Description check ✅ Passed The description explains the purpose, lists the documentation changes, addresses related issues, and completes the relevant checklist items.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Mirage20
Mirage20 marked this pull request as ready for review August 10, 2026 05:09

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/getting-started/try-it-out/on-your-environment.mdx`:
- Line 35: Update the cluster version wording in the getting-started
documentation to explicitly identify Kubernetes 1.34+ as the minimum supported
version, replacing the ambiguous “Recommended cluster baseline” phrasing while
retaining the LoadBalancer and default StorageClass requirements.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: e272d6a0-bb7d-4ff4-a689-cbad24bce4f1

📥 Commits

Reviewing files that changed from the base of the PR and between 62cc3fe and 210b57a.

⛔ Files ignored due to path filters (12)
  • versioned_docs/version-v1.0.x/getting-started/try-it-out/on-k3d-locally.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.0.x/getting-started/try-it-out/on-your-environment.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.0.x/platform-engineer-guide/deployment-topology.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.0.x/reference/faq.md is excluded by !versioned_docs/**
  • versioned_docs/version-v1.1.x/getting-started/try-it-out/on-k3d-locally.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.1.x/getting-started/try-it-out/on-your-environment.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.1.x/platform-engineer-guide/deployment-topology.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.1.x/reference/faq.md is excluded by !versioned_docs/**
  • versioned_docs/version-v1.2.x/getting-started/try-it-out/on-k3d-locally.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.2.x/getting-started/try-it-out/on-your-environment.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.2.x/platform-engineer-guide/deployment-topology.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.2.x/reference/faq.md is excluded by !versioned_docs/**
📒 Files selected for processing (4)
  • docs/getting-started/try-it-out/on-k3d-locally.mdx
  • docs/getting-started/try-it-out/on-your-environment.mdx
  • docs/platform-engineer-guide/deployment-topology.mdx
  • docs/reference/faq.md

Comment thread docs/getting-started/try-it-out/on-your-environment.mdx Outdated
The getting started pages described the cluster version as a recommended
baseline, which reads as optional next to the deployment topology and FAQ
pages that state it as a requirement.

Signed-off-by: Miraj Abeysekara <miraj@wso2.com>
@Mirage20
Mirage20 merged commit ae86791 into openchoreo:main Aug 10, 2026
3 checks passed
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