[kubernetes] Explicitly mention available K8s versions #1212
Conversation
Follow-up to #1191 Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
WalkthroughDocumentation and schema descriptions for the managed Kubernetes service were updated to explicitly state that supported Kubernetes versions for tenant clusters range from 1.28 to 1.33. These clarifications were made in the README, values schema, and values YAML comment, without altering any functional code or exported entities. Changes
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Summary of Changes
Hello @NickVolynkin, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request aims to improve the clarity and completeness of the documentation and configuration schema by explicitly detailing the supported Kubernetes versions for tenant clusters. The changes ensure that users are well-informed about the available version options when configuring their Kubernetes environments.
Highlights
- Documentation Update: I've updated the
README.mdto explicitly state that Kubernetes versions in tenant clusters are independent of the management cluster and that users can select patch versions from 1.28 to 1.33. - Parameter Description Clarity: I've enhanced the description for the
versionparameter in bothREADME.mdandvalues.yamlto clearly list the available Kubernetes versions (1.28 to 1.33). - Schema Definition Enhancement: I've updated the
values.schema.jsonto include the range of available Kubernetes versions (1.28 to 1.33) in the description for theversionfield, improving the schema's helpfulness.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to explicitly mention the available Kubernetes versions. The changes are clear and helpful. I've added a few suggestions to improve the clarity and consistency of the new documentation, mainly around how users select versions and ensuring the version format is consistent across all files. Overall, a good improvement!
| The control-plane operates within containers, while the worker nodes are deployed as virtual machines, all seamlessly managed by the application. | ||
|
|
||
| Kubernetes version in tenant clusters is independent of Kubernetes in the management cluster. | ||
| Users can select the latest patch versions from 1.28 to 1.33. |
There was a problem hiding this comment.
This phrasing could be a bit clearer for users. They select a minor version, not a patch version directly. Also, for consistency with the actual values, it's helpful to prefix the version numbers with v. How about rephrasing this for better clarity?
| Users can select the latest patch versions from 1.28 to 1.33. | |
| Users can select a Kubernetes minor version from v1.28 to v1.33, which automatically uses the latest supported patch release. |
| | `controlPlane.replicas` | Number of replicas for Kubernetes control-plane components. | `2` | | ||
| | `storageClass` | StorageClass used to store user data. | `replicated` | | ||
| | `version` | Kubernetes version given as vMAJOR.MINOR | `v1.32` | | ||
| | `version` | Kubernetes version given as vMAJOR.MINOR. Available are versions from 1.28 to 1.33. | `v1.32` | |
There was a problem hiding this comment.
For consistency with the actual values (which are prefixed with v, like the default v1.32), it would be clearer to also use the v prefix in the description of available versions.
| | `version` | Kubernetes version given as vMAJOR.MINOR. Available are versions from 1.28 to 1.33. | `v1.32` | | |
| | `version` | Kubernetes version given as vMAJOR.MINOR. Available are versions from v1.28 to v1.33. | `v1.32` | |
| "version": { | ||
| "type": "string", | ||
| "description": "Kubernetes version given as vMAJOR.MINOR", | ||
| "description": "Kubernetes version given as vMAJOR.MINOR. Available are versions from 1.28 to 1.33.", |
There was a problem hiding this comment.
To maintain consistency with the enum and default values in this schema, which are prefixed with v, the available versions in the description should also include the v prefix.
"description": "Kubernetes version given as vMAJOR.MINOR. Available are versions from v1.28 to v1.33.",
| ## @param controlPlane.replicas Number of replicas for Kubernetes control-plane components. | ||
| ## @param storageClass StorageClass used to store user data. | ||
| ## @param version Kubernetes version given as vMAJOR.MINOR | ||
| ## @param version Kubernetes version given as vMAJOR.MINOR. Available are versions from 1.28 to 1.33. |
There was a problem hiding this comment.
For consistency with the actual values a user would provide (e.g., v1.32), it's best to include the v prefix for the version range in this documentation comment.
## @param version Kubernetes version given as vMAJOR.MINOR. Available are versions from v1.28 to v1.33.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
packages/apps/kubernetes/values.schema.json (1)
126-137: Keep enum and description in sync via a single source of truthThe hard-coded enum list now matches the freshly updated description (“1.28 to 1.33”). When the next Kubernetes release arrives, we’ll need to touch this place as well as the README and values.yaml comments.
Consider extracting the supported-versions list into a dedicated JSON fragment (or Helm
_helpers.tpl) and templating it into all three locations to avoid future drift.packages/apps/kubernetes/values.yaml (1)
6-6: Wording nit: “latest patch” vs. MAJOR.MINORThe comment says “Available are versions from 1.28 to 1.33” yet the parameter only takes the MAJOR.MINOR string and implicitly resolves to the latest patch. Perhaps rephrase to something like:
## @param version Kubernetes minor version (vMAJOR.MINOR). Latest patch of each minor from 1.28 – 1.33 is deployed.Purely documentation, but it removes potential confusion.
packages/apps/kubernetes/README.md (1)
14-16: Clarify minor vs. patch terminology“Users can select the latest patch versions from 1.28 to 1.33” could be read as if the user can specify patch numbers. The parameter actually accepts only
v1.28…v1.33(minor). To keep wording consistent with the schema and values.yaml, suggest:Users can select Kubernetes minor versions from
v1.28tov1.33; the chart deploys the latest available patch for the selected minor.Minor doc tweak, no functional impact.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
packages/apps/kubernetes/README.md(2 hunks)packages/apps/kubernetes/values.schema.json(1 hunks)packages/apps/kubernetes/values.yaml(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.406Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.
packages/apps/kubernetes/README.md (1)
Learnt from: lllamnyp
PR: cozystack/cozystack#1130
File: hack/e2e-apps/kubernetes.bats:101-101
Timestamp: 2025-07-11T06:11:25.438Z
Learning: In cozystack, the plural form for the Kubernetes custom resource is `kuberneteses.apps.cozystack.io`, not `kubernetes.apps.cozystack.io`. This is defined in the API schema even though it's not grammatically perfect.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build
🔇 Additional comments (1)
packages/apps/kubernetes/README.md (1)
92-92: Table entry mirrors schema—LGTMRow update correctly mirrors the schema change; no further action needed.
Follow-up to #1191
Signed-off-by: Nick Volynkin nick.volynkin@gmail.com
Summary by CodeRabbit