rancher / rancher-docs

Rancher Documentation
https://ranchermanager.docs.rancher.com/
Apache License 2.0
59 stars 204 forks source link

Enhance RKE2 Cluster Templates docs #52

Open btat opened 2 years ago

btat commented 2 years ago

The current page (https://rancher.com/docs/rancher/v2.6/en/admin-settings/cluster-templates/) is a good starting point, but it does not cover the same level of details as the RKE1 template page (https://rancher.com/docs/rancher/v2.6/en/admin-settings/rke-templates/).

Review the RKE1 version (and its subpages) and add the corresponding information for RKE2.

github-actions[bot] commented 1 year ago

This repository uses an automated workflow to automatically label issues which have not had any activity (commit/comment/label) for 90 days. This helps us manage the community issues better. If the issue is still relevant, please add a comment to the issue so the workflow can remove the label and we know it is still valid. If it is no longer relevant (or possibly fixed in the latest release), the workflow will automatically close the issue in 30 days. Thank you for your contributions.

staedter commented 1 year ago

Yes, please update the current docs and the official cluster template examples repo. We tried using them implementing a IaC-first approach using rancher on top of harvester.

And although I think most of what we want from Rancher to accomplish that, is already technically feasible. Trying implementing it ourself from scratch using the existing docs is/was a PITA.

For example there are multiple errors in the docs. Case in point: how to label and taint the new nodes. The helpful documentation is buried somewhere under server configuration. https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration

The problem with the examples is, that they put the nodepool labels inside the harvesterconfig.yaml for the nodepool image

but they need to be under the machinepool config in the cluster.yaml image

We found this out only after a lot of trial an error. Also the config from the harvesterconfig seems problematic. Because the common: field is something that throws errors when I tried to apply it with helm directly.

Furthermore the CNI is hardcoded in the examples to calico and the list goes on and on. image

At least there was the Youtube Master Class video with @bashofmann and his example repo at https://github.com/bashofmann/rancher-cluster-templates/ which made some points clearer, but this were just his demo projects and the also do not cover our harvester cloudprovider/nodedriver use case.

Some open questions I have:

I have alot more of similar questions, some of which I unsuccessfully tried to get answers to in the rancher user slack and so I am hoping that some of the answers may find its way into the updated docs. If someone wants to get in touch I could also provide even more examples where the docs were misleading/unhelpful, please feel free to reach out.

Best regards Chris