docs(troubleshooting): fix KubeOVN MASTER_NODES example path and key#483
docs(troubleshooting): fix KubeOVN MASTER_NODES example path and key#483
Conversation
The KubeOVN Not Scheduling troubleshooting example in the generic Kubernetes install guide had two problems: 1. The key was kube-ovn (with a dash), but the field name in packages/core/platform/values.yaml (networking.kubeovn.MASTER_NODES) is kubeovn without a dash. A reader following the old example ended up with a block that matched no values in the platform schema. 2. The YAML sketch lacked an apiVersion/kind/metadata block, so it was not obvious which Package it was supposed to patch. Rewriting it as a full cozystack.cozystack-platform manifest ties it to the documented path in the Platform Package reference and matches what the platform chart actually consumes. Also link back to the Platform Package reference entry for networking.kubeovn.MASTER_NODES so readers can cross-check the field name. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Aleksei Sviridkin <f@lex.la>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 8 minutes and 5 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ 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 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the troubleshooting documentation for Kubernetes installation by correcting the Package manifest structure for MASTER_NODES configuration. The changes include updating the component hierarchy and correcting the kubeovn key to match the platform package reference. A review comment suggests including the variant field in the example manifest to ensure consistency with other documentation examples.
| spec: | ||
| components: | ||
| networking: | ||
| platform: |
There was a problem hiding this comment.
The Package manifest is missing the variant field (e.g., variant: isp-full-generic), which is typically required for this resource. While this is a troubleshooting example, including it would ensure the manifest is complete and consistent with the installation examples provided earlier in this document (see line 224).
There was a problem hiding this comment.
Applied — added variant: isp-full-generic to the Package manifest so the troubleshooting example is consistent with the other cozystack.cozystack-platform examples earlier in the same file (see the existing manifests at lines 224 and 405).
…ge manifest The Package manifest in the generic Kubernetes install guide was missing spec.variant, which is required for cozystack.cozystack-platform and consistent with the other Package examples in the same file (lines 224 and 405). Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Aleksei Sviridkin <f@lex.la>
2 participants
What
Fixes the KubeOVN Not Scheduling troubleshooting example in
content/en/docs/v1/install/kubernetes/generic.md:kube-ovnwith a dash, but the field inpackages/core/platform/values.yamlisnetworking.kubeovn.MASTER_NODES— no dash. A reader copying the old block ended up with a value block that matched nothing in the platform schema.apiVersion/kind/metadata, so it was not obvious which Package it was meant to patch. Rewrite the example as a fullcozystack.cozystack-platformmanifest that matches the documented path in the Platform Package reference, and add a cross-reference to that reference entry.Why
Reported in the community chat:
The typo was a drift between the
packages/core/platform/values.yamlschema (where the field isnetworking.kubeovn.MASTER_NODES) and this troubleshooting example. The Platform Package reference (operations/configuration/platform-package.md) already uses the correctkubeovnform, so the troubleshooting example was the odd one out.Verification
Checked the target field name against
packages/core/platform/values.yamlin upstreamcozystack/cozystack:Confirmed that
content/en/docs/v1/operations/configuration/platform-package.mdalready documents the same key path (networking.kubeovn.MASTER_NODES), so the fix aligns with the existing reference.hugobuilds cleanly; the troubleshooting section renders with the corrected manifest.Out of scope
content/en/docs/v1/install/how-to/kubespan.mdstill useskube-ovn:underspec.components.networking.valuesfor an MTU override. That example needs its own verification pass against upstream chart values (mtuis not inpackages/system/kubeovn/charts/kube-ovn/values.yamlat all, so it may already be stale) and is left for a follow-up.