Skip to content

Commit

Permalink
[docs] Add docs for new flavors (#344)
Browse files Browse the repository at this point in the history 
* Add docs for supported flavor matrix
  • Loading branch information
@amold1
amold1 committed May 29, 2024
1 parent 26fc5a7 commit 6357899
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 20 deletions.
8 changes: 4 additions & 4 deletions docs/src/topics/flavors/cluster-autoscaler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Autoscaler](https://www.github.com/kubernetes/autoscaler/tree/master/cluster-aut

## Specification

| Control Plane | CNI | Default OS | Installs ClusterClass | IPv4 | IPv6 |
|---------------|--------|--------------|-----------------------|------|------|
| Kubeadm | Cilium | Ubuntu 22.04 | No | Yes | No |
| Supported Control Plane | CNI | Default OS | Installs ClusterClass | IPv4 | IPv6 |
|-------------------------|--------|--------------|-----------------------|------|------|
| kubeadm, k3s, rke2 | Cilium | Ubuntu 22.04 | No | Yes | Yes |

## Prerequisites

Expand All @@ -34,7 +34,7 @@ Autoscaler](https://www.github.com/kubernetes/autoscaler/tree/master/cluster-aut
clusterctl generate cluster test-cluster \
--kubernetes-version v1.29.1 \
--infrastructure linode-linode \
--flavor cluster-autoscaler > test-cluster.yaml
--flavor <controlplane>-cluster-autoscaler > test-cluster.yaml
```

3. Apply cluster yaml
Expand Down
9 changes: 5 additions & 4 deletions docs/src/topics/flavors/dual-stack.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Dual-Stack
## Specification
| Control Plane | CNI | Default OS | Installs ClusterClass | IPv4 | IPv6 |
|---------------|--------|--------------|-----------------------|------|------|
| Kubeadm | Cilium | Ubuntu 22.04 | No | Yes | Yes |
| Supported Control Plane | CNI | Default OS | Installs ClusterClass | IPv4 | IPv6 |
|-------------------------|--------|--------------|-----------------------|------|------|
| kubeadm, k3s | Cilium | Ubuntu 22.04 | No | Yes | Yes |

## Prerequisites
[Quickstart](../getting-started.md) completed
## Usage
Expand All @@ -11,7 +12,7 @@
clusterctl generate cluster test-cluster \
--kubernetes-version v1.29.1 \
--infrastructure linode-linode \
--flavor dual-stack > test-cluster.yaml
--flavor <controlplane>-dual-stack > test-cluster.yaml
```
2. Apply cluster yaml
```bash
Expand Down
8 changes: 4 additions & 4 deletions docs/src/topics/flavors/etcd-backup-restore.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# etcd-backup-restore

## Specification
| Control Plane | CNI | Default OS | Installs ClusterClass | Installs etcd backup | IPv4 | IPv6 |
|---------------|--------|--------------|-----------------------|----------------------|------|------|
| Kubeadm | Cilium | Ubuntu 22.04 | No | Yes | Yes | No |
| Supported Control Plane | CNI | Default OS | Installs ClusterClass | IPv4 | IPv6 |
|-------------------------|--------|--------------|-----------------------|------|------|
| kubeadm, k3s, rke2 | Cilium | Ubuntu 22.04 | No | Yes | Yes |

## Prerequisites
[Quickstart](../getting-started.md) completed
Expand All @@ -13,7 +13,7 @@
clusterctl generate cluster test-cluster \
--kubernetes-version v1.29.1 \
--infrastructure linode-linode \
--flavor etcd-backup-restore > test-cluster.yaml
--flavor <controlplane>-etcd-backup-restore > test-cluster.yaml
```
2. Apply cluster yaml
```bash
Expand Down
8 changes: 4 additions & 4 deletions docs/src/topics/flavors/etcd-disk.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ the `quota-backend-bytes` to `8589934592` (8 GiB) per recommendation from
[the etcd documentation](https://etcd.io/docs/latest/dev-guide/limit/#storage-size-limit).

## Specification
| Control Plane | CNI | Default OS | Installs ClusterClass | IPv4 | IPv6 |
|---------------|--------|--------------|-----------------------|------|------|
| Kubeadm | Cilium | Ubuntu 22.04 | No | Yes | No |
| Supported Control Plane | CNI | Default OS | Installs ClusterClass | IPv4 | IPv6 |
|-------------------------|--------|--------------|-----------------------|------|------|
| kubeadm, rke2 | Cilium | Ubuntu 22.04 | No | Yes | Yes |

## Prerequisites
[Quickstart](../getting-started.md) completed
Expand All @@ -19,7 +19,7 @@ the `quota-backend-bytes` to `8589934592` (8 GiB) per recommendation from
clusterctl generate cluster test-cluster \
--kubernetes-version v1.29.1 \
--infrastructure linode-linode \
--flavor etcd-disk > test-cluster.yaml
--flavor <controlplane>-etcd-disk > test-cluster.yaml
```
2. Apply cluster yaml
```bash
Expand Down
43 changes: 43 additions & 0 deletions docs/src/topics/flavors/flavors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,46 @@ clusterctl generate cluster test-cluster --flavor clusterclass-kubeadm
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.
<br/><br/>
<br/><br/>

## Supported CAPL flavors

| Control Plane | Flavor | Notes |
|----------------|----------------------------|------------------------------------------------------|
| kubeadm | default | Installs Linode infra resources, kubeadm resources, |
| | | CNI, CSI driver, CCM and clusterresourceset |
| | kubeadm-cluster-autoscalar | Installs default along with the cluster autoscalar |
| | | add-on |
| | kubeadm-etcd-disk | Installs default along with the disk configuration |
| | | for etcd disk |
| | kubeadm-etcd-backup-restore| Installs default along with etcd-backup-restore addon|
| | kubeadm-vpcless | Installs default without a VPC |
| | kubeadm-dualstack | Installs vpcless and enables IPv6 along with IPv4 |
| | kubeadm-self-healing | Installs default along with the machine-health-check |
| | | add-on |
| | kubeadm-full | Installs all non-vpcless based flavors combinations |
| | kubeadm-fullvpcless | Installs all vpcless based flavors combinations |
| k3s | k3s | Installs Linode infra resources, k3s resources and |
| | | cilium network policies |
| | k3s-cluster-autoscalar | Installs default along with the cluster autoscalar |
| | | add-on |
| | k3s-etcd-backup-restore | Installs default along with etcd-backup-restore addon|
| | k3s-vpcless | Installs default without a VPC |
| | k3s-dualstack | Installs vpcless and enables IPv6 along with IPv4 |
| | k3s-self-healing | Installs default along with the machine-health-check |
| | | add-on |
| | k3s-full | Installs all non-vpcless based flavors combinations |
| | k3s-fullvpcless | Installs all vpcless based flavors combinations |
| rke2 | rke2 | Installs Linode infra resources, rke2 resources, |
| | | cilium and cilium network policies |
| | rke2-cluster-autoscalar | Installs default along with the cluster autoscalar |
| | | add-on |
| | rke2-etcd-disk | Installs default along with the disk configuration |
| | | for etcd disk |
| | rke2-etcd-backup-restore | Installs default along with etcd-backup-restore addon|
| | rke2-vpcless | Installs default without a VPC |
| | rke2-self-healing | Installs default along with the machine-health-check |
| | | add-on |
| | rke2-full | Installs all non-vpcless based flavors combinations |
| | rke2-fullvpcless | Installs all vpcless based flavors combinations |
9 changes: 5 additions & 4 deletions docs/src/topics/flavors/vpcless.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ This flavor supports provisioning k8s clusters outside of VPC. It uses kubeadm f
setting up control plane and uses cilium with VXLAN for pod networking.

## Specification
| Control Plane | CNI | Default OS | Installs ClusterClass | IPv4 | IPv6 |
|---------------|--------|--------------|-----------------------|------|------|
| Kubeadm | Cilium | Ubuntu 22.04 | No | Yes | No |
| Supported Control Plane | CNI | Default OS | Installs ClusterClass | IPv4 | IPv6 |
|-------------------------|--------|--------------|-----------------------|------|------|
| kubeadm, k3s, rke2 | Cilium | Ubuntu 22.04 | No | Yes | No |

## Prerequisites
[Quickstart](../getting-started.md) completed

Expand All @@ -20,7 +21,7 @@ supported in this flavor and it uses VXLAN for pod to pod communication.
```bash
clusterctl generate cluster test-cluster \
--infrastructure linode-linode \
--flavor vpcless > test-cluster.yaml
--flavor <controlplane>-vpcless > test-cluster.yaml
```
2. Apply cluster yaml
```bash
Expand Down

0 comments on commit 6357899

Please sign in to comment.