Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AshleyDumaine committed Feb 27, 2024
1 parent 85a31c3 commit 5c087a0
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 7 deletions.
5 changes: 5 additions & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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)
File renamed without changes.
35 changes: 35 additions & 0 deletions docs/src/topics/flavors/rke2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 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
* Add the following to `~/.cluster-api/clusterctl.yaml` for the k3s bootstrap/control plane providers
```yaml
providers:
- name: rke2
url: https://github.com/rancher-sandbox/cluster-api-provider-rke2/releases/v0.2.6/bootstrap-components.yaml
type: BootstrapProvider
- name: rke2
url: https://github.com/rancher-sandbox/cluster-api-provider-rke2/releases/v0.2.6/control-plane-components.yaml
type: ControlPlaneProvider
```
* Install the rke2 provider 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
```

0 comments on commit 5c087a0

Please sign in to comment.