docs(user-manual): write the Kubernetes environment page, and correct a version claim - #43
Merged
Merged
Conversation
Replaces a one-line placeholder. The supported-version table comes from the chainsaw job's matrix in each operator's test.yml and release.yml, which is consistent across repositories: 1.33.7, 1.34.3, 1.35.0. The cluster requirements come from what the built-in operators actually install. secret-operator and listener-operator are CSI drivers, not ordinary controllers — they register CSIDriver objects and run node DaemonSets that mount the kubelet directory, so a cluster that forbids that cannot run them, and without them no product cluster gets secrets or service exposure. Calls out the kubelet directory explicitly. The chart defaults kubeletDir to /var/lib/kubelet and its own values.yaml notes the path varies on microk8s; when it is wrong the driver never registers and every pod wanting a secret volume sits in Pending with nothing obviously broken. Includes the command to find the real path. Also notes that the charts declare no kubeVersion constraint, so the version table is a statement of what is tested rather than something the tooling enforces. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
zncdatadev#41 and zncdatadev#42 both stated a 1.29 floor. That number came from a comment next to KIND_K8S_VERSION in zookeeper-operator's Makefile, which is the default for a locally created kind cluster — not the project's tested range, and not even consistent across repositories: zookeeper-operator defaults to 1.36.1 while hdfs, trino, secret, listener and commons all default to 1.26.15. What CI actually exercises is a matrix in the chainsaw job, identical in every operator: 1.33.7, 1.34.3 and 1.35.0. The workspace-level notes say 1.26+, which is a third answer again. Point both pages at the new Kubernetes page instead of restating a number, and note in the development guideline that KIND_K8S_VERSION is a local default CI overrides, so the next reader does not draw the same wrong conclusion from it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fills the
user-manual/environment/kubernetes.mdplaceholder, and corrects a claim I got wrong in #41 and #42.The correction
Both merged pages stated a Kubernetes 1.29 floor. That number came from a comment next to
KIND_K8S_VERSIONinzookeeper-operator's Makefile — which is the default for a locally created kind cluster, not the project's tested range.It is not even consistent across repositories:
zookeeper-operatorMakefile defaulthdfs,trino,secret,listener,commonsMakefile defaultszookeeper-operatorMakefile commenttest.yml+release.yml, identical in every operator)The CI matrix is what actually gets exercised, so that is what the new page states. Both older pages now link to it instead of restating a number, and the development guideline notes that
KIND_K8S_VERSIONis a local default CI overrides — so the next reader does not draw the same wrong conclusion I did.The new page
Covers the supported-version table, and the cluster capabilities the built-in Operators actually need — taken from what they install rather than from general Kubernetes advice:
CSI is not optional.
secret-operatorandlistener-operatorare CSI drivers, not ordinary controllers. They registerCSIDriverobjects and run node DaemonSets that mount the kubelet directory. A cluster that forbids that cannot run them, and without them no product cluster gets secrets or service exposure.The kubelet directory gets called out explicitly. The chart defaults
kubeletDirto/var/lib/kubelet, and its ownvalues.yamlnotes the path varies on microk8s. When it is wrong the driver never registers and every pod wanting a secret volume sits inPendingwith nothing obviously broken. The page includes the command to find the real path and the--setto fix it.Also notes the charts declare no
kubeVersionconstraint, so the version table is a statement of what is tested rather than something the tooling enforces.Testing
npm run verifyexits 0 — 52 files linted with 0 errors, both locales builtid="supported-versions"andid="支持的版本"exist in the build output, and no anchor warnings in the logRemaining stage 2 placeholders
4 left:
kubebuilder,database(blocked — no operator consumes the CRD, see #38), andfaq/release-notes, which still need maintainer input rather than source research.🤖 Generated with Claude Code