Fixing quickstart guide to make it function as expected.#78
Fixing quickstart guide to make it function as expected.#78sjwaight wants to merge 2 commits intokubefleet-dev:mainfrom
Conversation
Signed-off-by: Simon Waight <simon.waight@microsoft.com>
Signed-off-by: Simon Waight <simon.waight@microsoft.com>
|
|
||
| In this tutorial you will create two kind clusters; one of which serves as the Fleet | ||
| hub cluster, and the other the Fleet member cluster. Run the commands below to create them: | ||
| If you want to control the Kubernetes version of your kind clusters, see [kind releases](https://github.com/kubernetes-sigs/kind/releases) and set the Kuberentes version by passing the correct value to `--image` parameter. For example `--image kindest/node:v1.32.8` will create a Kubernetes cluster running 1.32.8. |
There was a problem hiding this comment.
Hi Simon! Just a nit: should we give users a recommended version? This might be a less relevant concern, but KubeFleet might not work with some of the earlier KubeFleet versions.
|
|
||
| ### Select KubeFleet version | ||
|
|
||
| Next, select the KubeFleet version to run by looking at the [KubeFleet GitHub Releases page](https://github.com/kubefleet-dev/kubefleet/releases) and picking a version - for example 0.2.2. |
There was a problem hiding this comment.
Hi Simon! Also a similar nit here: would it be better to just recommend users with a version to avoid confusion?
(Of course I understand that a downside would be that we need to update this doc all the time... or shall we just recommend the latest official release as seen on GitHub?)
michaelawyu
left a comment
michaelawyu
left a comment
There was a problem hiding this comment.
Added a few minor comments, PTAL.
| --version 0.2.2 \ | ||
| --namespace fleet-system \ | ||
| --create-namespace \ | ||
| --set logFileMaxSize=100000 |
There was a problem hiding this comment.
Not related to this PR, but we should really fix the charts to drop this requirement 😞 I will create an issue.
2 participants
This pull request updates the getting started guide for using kind clusters with KubeFleet, replacing references to "Fleet" with "KubeFleet" and modernizing the instructions for clarity and accuracy. The guide now reflects current best practices, simplifies setup steps, and improves consistency in terminology and resource names.
Relates to improvements tracked on #471 on main KubeFleet site.
Key changes include:
Rebranding and Terminology Updates:
placement.kubernetes-KubeFleet.io/v1).Setup and Installation Improvements:
Quickstart Script and Automation:
join-member-clusters.shquickstart script, making it easier to add member clusters.Resource Placement Example Updates:
worktokubefleet-sample) for consistency with KubeFleet examples. [1] [2]ClusterResourcePlacementYAML to match the new API version and naming.Cleanup and Uninstallation Instructions: