add dual-stack flavor doc, formatting

linode · Apr 5, 2024 · 5fea2bf · 5fea2bf
1 parent a2240c7
commit 5fea2bf
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 20 deletions.
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -7,6 +7,7 @@
     - [Addons](./topics/addons.md)
     - [Flavors](./topics/flavors/flavors.md)
       - [Default (kubeadm)](./topics/flavors/default.md)
+      - [Dual-stack (kubeadm)](./topics/flavors/dual-stack.md)
       - [ClusterClass kubeadm](./topics/flavors/clusterclass-kubeadm.md)
       - [k3s](./topics/flavors/k3s.md)
       - [rke2](./topics/flavors/rke2.md)

diff --git a/docs/src/topics/flavors/clusterclass-kubeadm.md b/docs/src/topics/flavors/clusterclass-kubeadm.md
@@ -1,15 +1,17 @@
 # Kubeadm ClusterClass
 ## Specification
-| Control Plane | CNI    | Default OS   | Installs ClusterClass |
-|---------------|--------|--------------|-----------------------|
-| Kubeadm       | Cilium | Ubuntu 22.04 | Yes                   | 
+| Control Plane | CNI    | Default OS   | Installs ClusterClass | IPv4 | IPv6 |
+|---------------|--------|--------------|-----------------------|------|------|
+| Kubeadm       | Cilium | Ubuntu 22.04 | Yes                   | Yes  | No   |
 ## Prerequisites
 [Quickstart](../getting-started.md) completed
 ## Usage
 ### Create clusterClass and first cluster
 1. Generate the ClusterClass and cluster manifests
     ```bash
-    clusterctl generate cluster test-cluster --infrastructure linode:0.0.0  --flavor clusterclass-kubeadm > test-cluster.yaml
+    clusterctl generate cluster test-cluster \
+        --infrastructure linode:0.0.0 \
+        --flavor clusterclass-kubeadm > test-cluster.yaml
     ```
 2. Apply cluster manifests
     ```bash
@@ -18,7 +20,8 @@
 ### (Optional) Create a second cluster using the existing ClusterClass
 1.  Generate cluster manifests
       ```bash
-      clusterctl generate cluster test-cluster-2 --flavor clusterclass-kubeadm > test-cluster-2.yaml
+      clusterctl generate cluster test-cluster-2 \
+          --flavor clusterclass-kubeadm > test-cluster-2.yaml
       ```
       ```yaml
       apiVersion: cluster.x-k8s.io/v1beta1

diff --git a/docs/src/topics/flavors/default.md b/docs/src/topics/flavors/default.md
@@ -1,14 +1,15 @@
 # Default
 ## Specification
-| Control Plane | CNI    | Default OS   | Installs ClusterClass |
-|---------------|--------|--------------|-----------------------|
-| Kubeadm       | Cilium | Ubuntu 22.04 | No                    |
+| Control Plane | CNI    | Default OS   | Installs ClusterClass | IPv4 | IPv6 |
+|---------------|--------|--------------|-----------------------|------|------|
+| Kubeadm       | Cilium | Ubuntu 22.04 | No                    | Yes  | No   |
 ## Prerequisites
 [Quickstart](../getting-started.md) completed
 ## Usage
 1. Generate cluster yaml
     ```bash
-    clusterctl generate cluster test-cluster --infrastructure linode:0.0.0 > test-cluster.yaml
+    clusterctl generate cluster test-cluster \
+        --infrastructure linode:0.0.0 > test-cluster.yaml
     ```
 2. Apply cluster yaml
     ```bash

diff --git a/docs/src/topics/flavors/dual-stack.md b/docs/src/topics/flavors/dual-stack.md
@@ -0,0 +1,18 @@
+# Dual-Stack
+## Specification
+| Control Plane | CNI    | Default OS   | Installs ClusterClass | IPv4 | IPv6 |
+|---------------|--------|--------------|-----------------------|------|------|
+| Kubeadm       | Cilium | Ubuntu 22.04 | No                    | Yes  | Yes  |
+## Prerequisites
+[Quickstart](../topics/getting-started.md) completed
+## Usage
+1. Generate cluster yaml
+    ```bash
+    clusterctl generate cluster test-cluster \
+        --infrastructure linode:0.0.0 \
+        --flavor dual-stack > test-cluster.yaml
+    ```
+2. Apply cluster yaml
+    ```bash
+    kubectl apply -f test-cluster.yaml
+    ```
diff --git a/docs/src/topics/flavors/etcd-backup-restore.md b/docs/src/topics/flavors/etcd-backup-restore.md
@@ -1,9 +1,9 @@
 # etcd-backup-restore
 
 ## Specification
-| Control Plane | CNI    | Default OS   | Installs ClusterClass | Installs etcd backup |
-|---------------|--------|--------------|-----------------------|----------------------|
-| Kubeadm       | Cilium | Ubuntu 22.04 | No                    | Yes                  |
+| Control Plane | CNI    | Default OS   | Installs ClusterClass | Installs etcd backup | IPv4 | IPv6 |
+|---------------|--------|--------------|-----------------------|----------------------|------|------|
+| Kubeadm       | Cilium | Ubuntu 22.04 | No                    | Yes                  | Yes  | No   |
 
 ## Prerequisites
 [Quickstart](../topics/getting-started.md) completed

diff --git a/docs/src/topics/flavors/k3s.md b/docs/src/topics/flavors/k3s.md
@@ -1,8 +1,8 @@
 # K3s
 ## Specification
-| Control Plane               | CNI    | Default OS   | Installs ClusterClass |
-|-----------------------------|--------|--------------|-----------------------|
-| [k3s](https://docs.k3s.io/) | Cilium | Ubuntu 22.04 | No                    |
+| Control Plane               | CNI    | Default OS   | Installs ClusterClass | IPv4 | IPv6 |
+|-----------------------------|--------|--------------|-----------------------|------|------|
+| [k3s](https://docs.k3s.io/) | Cilium | Ubuntu 22.04 | No                    | Yes  | No   |
 ## Prerequisites
 * [Quickstart](../getting-started.md) completed
 * Select a [k3s kubernetes version](https://github.com/k3s-io/k3s/releases) to set for the kubernetes version
@@ -28,7 +28,9 @@
 ## Usage
 1. Generate cluster yaml
     ```bash
-    clusterctl generate cluster test-cluster --infrastructure linode:0.0.0 --flavor k3s > test-k3s-cluster.yaml
+    clusterctl generate cluster test-cluster \
+        --infrastructure linode:0.0.0 \
+        --flavor k3s > test-k3s-cluster.yaml
     ```
 2. Apply cluster yaml
     ```bash

diff --git a/docs/src/topics/flavors/rke2.md b/docs/src/topics/flavors/rke2.md
@@ -1,8 +1,8 @@
 # RKE2
 ## Specification
-| Control Plane               | CNI    | Default OS   | Installs ClusterClass |
-|-----------------------------|--------|--------------|-----------------------|
-| [rke2](https://docs.rke2.io/) | Cilium | Ubuntu 22.04 | No                    |
+| Control Plane                 | CNI    | Default OS   | Installs ClusterClass | IPv4 | IPv6 |
+|-------------------------------|--------|--------------|-----------------------|------|------|
+| [rke2](https://docs.rke2.io/) | Cilium | Ubuntu 22.04 | No                    | Yes  | No   |
 ## Prerequisites
 * [Quickstart](../getting-started.md) completed
 * Select an [rke2 kubernetes version](https://github.com/rancher/rke2/releases) to set for the kubernetes version
@@ -16,7 +16,9 @@
 ## Usage
 1. Generate cluster yaml
     ```bash
-    clusterctl generate cluster test-cluster --infrastructure linode:0.0.0 --flavor rke2 > test-rke2-cluster.yaml
+    clusterctl generate cluster test-cluster \
+        --infrastructure linode:0.0.0 \
+        --flavor rke2 > test-rke2-cluster.yaml
     ```
 2. Apply cluster yaml
     ```bash