Skip to content

docs: bump kgateway to v2.3.11 to install on Kubernetes 1.37 - #965

Merged
rashadism merged 1 commit into
openchoreo:mainfrom
Mirage20:kgateway-v2.3.11
Oct 29, 2026
Merged

rashadism merged 1 commit into
openchoreo:mainfrom
Mirage20:kgateway-v2.3.11

Conversation

@Mirage20

Copy link
Copy Markdown
Contributor

Purpose

Bump kgateway from v2.3.1 to v2.3.11 in the install guides (current, v1.3.x and v1.2.x). The v2.3.1 CRDs are rejected on Kubernetes 1.37 (CEL rule cost exceeds budget).

Related Issues

Fixes openchoreo/openchoreo#5203

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)

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

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 5456b3b and c235b42.

Files ignored due to path filters: 7
  • 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-k3d-locally/k3d-prerequisites.sh 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/air-gapped-installation.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.3.x/getting-started/try-it-out/on-k3d-locally.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.3.x/getting-started/try-it-out/on-your-environment.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.3.x/platform-engineer-guide/air-gapped-installation.mdx is excluded by !versioned_docs/**
Files selected for processing: 3
  • docs/getting-started/try-it-out/on-k3d-locally.mdx
  • docs/getting-started/try-it-out/on-your-environment.mdx
  • docs/platform-engineer-guide/air-gapped-installation.mdx

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the getting-started and air-gapped installation guides to use kgateway version v2.3.11.
    • Added the envoy-wrapper runtime image to the air-gapped installation image list.

Three installation guides now use kgateway version v2.3.11 instead of v2.3.1 in chart commands, image references, and local chart archive commands.

Changes: kgateway installation documentation

Layer / File(s) Summary
Update installation version references
docs/getting-started/try-it-out/on-k3d-locally.mdx, docs/getting-started/try-it-out/on-your-environment.mdx, docs/platform-engineer-guide/air-gapped-installation.mdx
The getting-started guides use v2.3.11 in kgateway chart install commands. The air-gapped guide uses v2.3.11 for image references, chart downloads, and local archive installation commands.

Priority: Normal

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

Change: Other · Severity of issue fixed: Medium

Suggested reviewers: nomadxd, akila-i

Merge Risk: Minimal · up to c235b

The guides consistently select kgateway v2.3.11. No actionable installation regression was established, although compatibility with Kubernetes 1.37 remains unverified.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Linked Issues check Warning Issue #5203 reports that kgateway v2.3.1 CRDs fail Kubernetes CEL cost validation and suggests kgateway v2.4.x, specifically v2.4.7. This PR changes the documented version to v2.3.11. The available ch… Update the affected installation commands to a kgateway version that resolves the Kubernetes 1.37 CRD validation failure, consistent with issue #5203's v2.4.x recommendation, and verify the affected guides use that version.
Passed Passed checks: 4 passed
Check name Status Explanation
Title check Passed The title states the main change: bumping kgateway from v2.3.1 to v2.3.11 in the docs so installation works on Kubernetes 1.37. The raw summary confirms the version bump across the getting-started and…
Description check Passed The description covers the Purpose section, which explains the version bump from v2.3.1 to v2.3.11 across the current, v1.3.x and v1.2.x guides and the CEL cost failure on Kubernetes 1.37. It also has…
Out of Scope Changes check Passed The reviewed changes update kgateway versions in installation, local k3d, and air-gapped documentation. These changes directly support the linked issue's kgateway installation fix and do not show unre…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Full details: Title check

Explanation

The title states the main change: bumping kgateway from v2.3.1 to v2.3.11 in the docs so installation works on Kubernetes 1.37. The raw summary confirms the version bump across the getting-started and air-gapped docs, and the description gives the same reason, so the title matches the changeset.

Full details: Description check

Explanation

The description covers the Purpose section, which explains the version bump from v2.3.1 to v2.3.11 across the current, v1.3.x and v1.2.x guides and the CEL cost failure on Kubernetes 1.37. It also has the Related Issues section, which links openchoreo/openchoreo#5203. The checklist is copied from the template but left unchecked, so the preview, build and link checks are not reported as done.

Full details: Out of Scope Changes check

Explanation

The reviewed changes update kgateway versions in installation, local k3d, and air-gapped documentation. These changes directly support the linked issue's kgateway installation fix and do not show unrelated product or documentation changes. Excluded versioned files were not used as evidence of additional changes.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

Full details: Linked Issues check

Explanation

Issue #5203 reports that kgateway v2.3.1 CRDs fail Kubernetes CEL cost validation and suggests kgateway v2.4.x, specifically v2.4.7. This PR changes the documented version to v2.3.11. The available change summary does not establish that v2.3.11 removes the reported validation failure. The PR therefore does not demonstrate compliance with the linked issue's required fix.

Resolution

Update the affected installation commands to a kgateway version that resolves the Kubernetes 1.37 CRD validation failure, consistent with issue #5203's v2.4.x recommendation, and verify the affected guides use that version.

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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 October 29, 2026 05:46
@rashadism
rashadism merged commit 4d6d556 into openchoreo:main Oct 29, 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.

Install Kgateway failed when following up the document Run OpenChoreo in Your Environment

2 participants