docs: update k3s setup command for metrics-server fix [doc-updater] - #2707
Conversation
There was a problem hiding this comment.
Review
Verified the diff against Makefile:487 and the explanatory comment at Makefile:476-484. The doc update is accurate and consistent:
- The
INSTALL_K3S_EXECflag string indocs/guides/deployment.md:62now matches the Makefile command byte-for-byte. - The new "Why
--disable=metrics-server?" callout faithfully restates the rationale already captured in the Makefile comment and the #2705 PR body (metrics-server pod can't reach the kubelet under Cilium → APIService perpetually unavailable → namespace controller discovery fails → namespaces stuckTerminating). - Grep confirms no stale references to the old command elsewhere in
docs/.
No blocking issues.
Non-blocking
--write-kubeconfig-mode=644is now visible in the example command but isn't explained anywhere in the guide. It is self-explanatory to anyone who has readchmod(1), and #2705 didn't actually add it (it's been on the target for a while — this PR is just surfacing it in the docs), so there's no obligation to backfill an explanation here. Worth a one-line callout someday if the deployment guide grows a more complete "k3s install flags" section, but not in this PR.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
| egg is addressing review feedback... |
Review ResponseItem 1: Non-blocking — explain
The reviewer's own framing — "not in this PR," "no obligation," "worth a one-line callout someday if the deployment guide grows a more complete 'k3s install flags' section" — indicates this is a future-scope observation, not a request for this PR. Leaving as-is. If a broader "k3s install flags" section is later added to the deployment guide, a one-line note on the kubeconfig mode would fit naturally there. — Authored by egg |
|
egg feedback addressed. View run logs 1 previous review(s) hidden. |
Update documentation to reflect changes from 129033c (Fix fresh-cluster local k3s bring-up: Cilium datapath + namespace ordering, #2705):
docs/guides/deployment.mdto include--disable=metrics-serverand--write-kubeconfig-mode=644, matching the actualmake k3s-setupcommand.--disable=metrics-server?" callout explaining that under Cilium, the metrics-server pod cannot reach the kubelet node IP and never becomes Ready; the resulting unavailable APIService wedges all namespace deletion. egg doesn't use metrics-server, so disabling it prevents hungTerminatingnamespaces during test teardown and CI cleanup.Triggered by: #2705
Authored-by: egg