docs(mongodb): fix broken commands, example refs, and container names found by executing the guides#989
Conversation
… found by executing the guides
- get sts -> get petset in resource-listing commands (workload is a PetSet CR, get sts returns nothing): quickstart, clustering/{replicaset,sharding,standalone}, arbiter/{replicaset,sharding}, hidden-node/sharding
- podTemplate container name mongo -> mongodb (name mongo silently drops resource/args overrides): clustering/standalone, configuration/using-podtemplate
- fix nonexistent/mis-cased example YAML refs: configuration/using-config-file (replicaset.yaml -> demo-1.yaml), initialization/using-script (replicaset.yaml -> demo-1.yaml), initialization/gitsync (initialization -> Initialization)
- initialization/using-script auth-secret key user -> username
- rotate-auth: jq .spec.authsecret.name -> .spec.authSecret.name (lowercase returns null), filename typo mongobd.yaml -> mongodb.yaml, hardcoded raw/v2025.6.30 URL -> version template
- quickstart: fix garbled 'Check 0' text and regenerate the corrupt mongodbversions output table
Signed-off-by: Tamal Saha <tamal@appscode.com>
|
Warning Review limit reached
Next review available in: 21 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR updates MongoDB documentation guides across arbiter, clustering, configuration, hidden-node, initialization, quickstart, and rotate-auth sections. Changes replace ChangesMongoDB documentation fixes
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
…d references Signed-off-by: Tamal Saha <tamal@appscode.com>
Found by re-executing the MongoDB guides on a live KubeDB v2026.6.19 cluster (single-node k3s). Every fix below was confirmed on-cluster or against the source of truth (apimachinery API/ops types, example YAMLs) before editing.
Executable command fixes
kubectl get ...,sts,...->...,petset,...in the resource-listing commands. The KubeDB workload is aPetSetCR (apps.k8s.appscode.com), sokubectl get stsreturns nothing. Verifiedkubectl get sts -n demo->No resources found. Files:quickstart/quickstart.md(3x),clustering/{replicaset,sharding,standalone}.md,arbiter/{replicaset,sharding}.md,hidden-node/sharding.md.name: mongo->name: mongodbinclustering/standalone.mdandconfiguration/using-podtemplate.md. The operator's container ismongodb; withname: mongothe resource/args overrides are silently dropped. Verified on cluster:name: mongoyielded default 800m/1536Mi, whereas the example'sname: mongodbcorrectly applied cpu=250m/mem=1Gi and--maxConns=100.Broken example-YAML references (raw fetch 404)
configuration/using-config-file.md:configuration/replicaset.yaml(does not exist) ->configuration/demo-1.yaml(matches inlinemgo-custom-config; deployed successfully,net.maxIncomingConnections=10000verified).initialization/using-script.md:Initialization/replicaset.yaml(does not exist) ->Initialization/demo-1.yaml(matches inlinemgo-init-script).initialization/gitsync.md: lowercaseinitialization/git-sync-public.yaml->Initialization/git-sync-public.yaml(directory is case-sensitiveInitialization).Wrong field / secret key
initialization/using-script.md: auth-secret example used keyuser:->username:(basic-auth key; the guide's own prose and jsonpath already useusername).rotate-auth/rotateauth.md:jq .spec.authsecret.name->.spec.authSecret.name(3x + prose). Verified the lowercase form returnsnull;.spec.authSecret.namereturns the secret name. Source:apimachinery/apis/kubedb/v1/mongodb_types.go(json:"authSecret").Minor
rotate-auth/rotateauth.md: filename typomongobd.yaml->mongodb.yaml; hardcodedraw/v2025.6.30/...URL ->{{ .version }}template (matching the rest of the file).quickstart/quickstart.md: fixed garbledCheck 0text and replaced the corruptkubectl get mongodbversionsoutput table (misaligned columns / nonsensical rows from a prior bad find-replace) with the real current-cluster output.Verified but NOT changed
apiVersion: kubedb.com/v1is correct for MongoDB (kept).apiVersion: kubedb.com/v1alpha2+terminationPolicyapplies fine (conversion webhook stores it as v1/deletionPolicy); left as-is.Summary by CodeRabbit
petsetin Kubernetes listings instead ofsts.