From 46f17caa75d52ef0bbf5de6842563cada39f0be8 Mon Sep 17 00:00:00 2001 From: Ashley Dumaine Date: Tue, 27 Feb 2024 15:27:11 -0500 Subject: [PATCH] add docs --- docs/src/SUMMARY.md | 5 ++++ .../flavors/clusterclass-kubeadm.md | 0 docs/src/{ => topics}/flavors/default.md | 0 docs/src/{ => topics}/flavors/flavors.md | 9 ++----- docs/src/{ => topics}/flavors/k3s.md | 0 docs/src/topics/flavors/rke2.md | 24 +++++++++++++++++++ 6 files changed, 31 insertions(+), 7 deletions(-) rename docs/src/{ => topics}/flavors/clusterclass-kubeadm.md (100%) rename docs/src/{ => topics}/flavors/default.md (100%) rename docs/src/{ => topics}/flavors/flavors.md (79%) rename docs/src/{ => topics}/flavors/k3s.md (100%) create mode 100644 docs/src/topics/flavors/rke2.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index ce5859d2c..744c4bfc7 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -5,6 +5,11 @@ - [Getting Started](./topics/getting-started.md) - [Troubleshooting](./topics/troubleshooting.md) - [Addons](./topics/addons.md) + - [Flavors](./topics/flavors/flavors.md) + - [Default (kubeadm)](./topics/flavors/default.md) + - [ClusterClass kubeadm](./topics/flavors/clusterclass-kubeadm.md) + - [k3s](./topics/flavors/k3s.md) + - [rke2](./topics/flavors/rke2.md) - [Development](./developers/development.md) - [Releasing](./developers/releasing.md) - [Reference](./reference/reference.md) diff --git a/docs/src/flavors/clusterclass-kubeadm.md b/docs/src/topics/flavors/clusterclass-kubeadm.md similarity index 100% rename from docs/src/flavors/clusterclass-kubeadm.md rename to docs/src/topics/flavors/clusterclass-kubeadm.md diff --git a/docs/src/flavors/default.md b/docs/src/topics/flavors/default.md similarity index 100% rename from docs/src/flavors/default.md rename to docs/src/topics/flavors/default.md diff --git a/docs/src/flavors/flavors.md b/docs/src/topics/flavors/flavors.md similarity index 79% rename from docs/src/flavors/flavors.md rename to docs/src/topics/flavors/flavors.md index 273b4c0a6..425aa00bf 100644 --- a/docs/src/flavors/flavors.md +++ b/docs/src/topics/flavors/flavors.md @@ -1,5 +1,7 @@ # Flavors +This section contains information about supported flavors in Cluster API Provider Linode + In `clusterctl` the infrastructure provider authors can provide different types of cluster templates referred to as "flavors". You can use the `--flavor` flag to specify which flavor to use for a cluster, e.g: @@ -11,10 +13,3 @@ clusterctl generate cluster test-cluster --flavor clusterclass To use the default flavor, omit the `--flavor` flag. See the [`clusterctl` flavors docs](https://cluster-api.sigs.k8s.io/clusterctl/commands/generate-cluster.html#flavors) for more information. - - -## Supported flavors - -- [Default (kubeadm)](default.md) -- [Cluster Class Kubeadm](clusterclass-kubeadm.md) -- [k3s](k3s.md) diff --git a/docs/src/flavors/k3s.md b/docs/src/topics/flavors/k3s.md similarity index 100% rename from docs/src/flavors/k3s.md rename to docs/src/topics/flavors/k3s.md diff --git a/docs/src/topics/flavors/rke2.md b/docs/src/topics/flavors/rke2.md new file mode 100644 index 000000000..309b33914 --- /dev/null +++ b/docs/src/topics/flavors/rke2.md @@ -0,0 +1,24 @@ +# RKE2 +## Specification +| Control Plane | CNI | Default OS | Installs ClusterClass | +|-----------------------------|--------|--------------|-----------------------| +| [rke2](https://docs.rke2.io/) | Cilium | Ubuntu 22.04 | No | +## Prerequisites +* [Quickstart](../topics/getting-started.md) completed +* Select an [rke2 kubernetes version](https://github.com/rancher/rke2/releases) to set for the kubernetes version + ```bash + export KUBERNETES_VERSION=v1.29.1+rke2r1 + ``` +* Installed [rke2 bootstrap provider](https://github.com/rancher-sandbox/cluster-api-provider-rke2) into your management cluster + ```shell + clusterctl init --bootstrap rke2 --control-plane rke2 + ``` +## Usage +1. Generate cluster yaml + ```bash + clusterctl generate cluster test-cluster --infrastructure linode:0.0.0 --flavor rke2 > test-rke2-cluster.yaml + ``` +2. Apply cluster yaml + ```bash + kubectl apply -f test-rke2-cluster.yaml + ```