-
-
Notifications
You must be signed in to change notification settings - Fork 5
docs: add cluster update command to README usage section #2154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add cluster update command to README usage section #2154
Conversation
- Add ksail cluster update command to main usage workflow - Explain when to use it (after modifying ksail.yaml) - Ensures consistency with .github/copilot-instructions.md - References feature introduced in v5.30.0 (#2041)
✅
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Updates the project’s primary quickstart workflow in README.md to include the ksail cluster update lifecycle command, closing a documentation gap for users who rely on the README as their main entry point.
Changes:
- Added a new usage step documenting
ksail cluster updatefor applying configuration changes after editingksail.yaml. - Renumbered the subsequent “Connect to the cluster with K9s” step accordingly.

Summary
Adds the
ksail cluster updatecommand to the main usage workflow in README.md.What Changed
ksail cluster updatecommand in the usage sectionWhy
The
cluster updatecommand was introduced in v5.30.0 (#2041) and documented in.github/copilot-instructions.md(#2140), but was missing from the README.md usage section. This creates a documentation gap for users who rely on the README as their primary reference.Documentation Consistency
After this change:
.github/copilot-instructions.md- hascluster updateREADME.md- now hascluster updateTesting
Related
ksail cluster updatecommand with config diff detection and node scaling #2041