ADD Advanced setups Guide (#30)

Author: mcbenjemaa

docs/Usage.md

@@ -155,9 +155,9 @@ We provide the following templates:
 | cilium         | templates/cluster-template-cilium.yaml          | templates/crs/cni/cilium.yaml |
 | calico         | templates/cluster-template-calico.yaml          | templates/crs/cni/calico.yaml |
 | multiple-vlans | templates/cluster-template-multiple-vlans.yaml  | -                             |
-| xl-nodes       | templates/cluster-template-xl-nodes.yaml        | -                             |
 | default        | templates/cluster-template.yaml                 | -                             |
 
+For more information about advanced clusters please check our [advanced setups docs](advanced-setups.md).
 
 #### Flavor with Cilium CNI
 Before this cluster can be deployed, `cilium` needs to be configured. As a first step we

docs/advanced-setups.md

@@ -0,0 +1,84 @@
+## Advanced Setups
+
+To get started with CAPMOX please refer to the [Getting Started](Usage.md#quick-start) section.
+
+## Multiple NICs
+
+If you want to create VMs with multiple network devices,
+You will need to create `InClusterPool` or `GlobalInClusterPool` to manage IPs.
+
+here is a `GlobalInClusterPool` example:
+
+```yaml
+apiVersion: ipam.cluster.x-k8s.io/v1alpha2
+kind: GlobalInClusterIPPool
+metadata:
+  name: shared-inclusterippool
+spec:
+  addresses: ${NODE_SECONDARY_IP_RANGES}
+  prefix: ${SECONDARY_IP_PREFIX}
+  gateway: ${SECONDARY_GATEWAY}
+```
+
+In the cluster template flavor=multiple-vlans you can define a secondary network device for the VMs.
+To do that you will need to set extra environment variables along with the required ones:
+
+```bash
+# The secondary IP ranges for Cluster nodes
+export NODE_SECONDARY_IP_RANGES="[10.10.10.100-10.10.10.150]"
+# The Subnet Mask in CIDR notation for your node secondary IP ranges
+export SECONDARY_IP_PREFIX=24
+# The secondary gateway for the machines network-config
+export SECONDARY_GATEWAY="10.10.10.254"
+# The secondary dns nameservers for the machines network-config
+export SECONDARY_DNS_SERVERS="[8.8.8.8, 8.8.4.4]"
+# The Proxmox secondary network bridge for VMs
+export SECONDARY_BRIDGE=vmbr2
+```
+
+#### Generate a Cluster
+
+```bash
+clusterctl generate cluster test-multiple-vlans  \
+  --infrastructure proxmox \
+  --kubernetes-version v1.28.3  \
+  --control-plane-machine-count=1 \
+  --worker-machine-count=2 \
+  --flavor=multiple-vlans > cluster.yaml
+```
+
+## Dual Stack
+
+Regarding dual-stack support, you can use the following environment variables to define the IPv6 ranges for the VMs:
+
+```bash
+# The IPv6 ranges for Cluster nodes
+export NODE_IPV6_RANGES="[2001:db8:1::1-2001:db8:1::10]"
+# The Subnet Mask in CIDR notation for your node IPv6 ranges
+export IPV6_PREFIX=64
+# The ipv6 gateway for the machines network-config.
+export IPV6_GATEWAY="2001:db8:1::1"
+```
+
+#### Generate a Cluster
+
+```bash
+clusterctl generate cluster test-duacl-stack  \
+  --infrastructure proxmox \
+  --kubernetes-version v1.28.3  \
+  --control-plane-machine-count=1 \
+  --worker-machine-count=2 \
+  --flavor=dual-stack > cluster.yaml
+```
+
+
+## Notes
+
+* Clusters with IPV6 IPs only is supported.
+* Multiple NICs & Dual-stack setups can be mixed together.
+* If you're looking for more customized setups, you can create your own cluster template and use it with `clusterctl generate cluster` command.
+
+## API Reference
+
+Please refer to the API reference:
+* [CAPMOX API Reference](https://doc.crds.dev/github.com/ionos-cloud/cluster-api-provider-proxmox).

templates/cluster-template-xl-nodes.yaml

@@ -123,6 +123,17 @@ spec:
       templateID: ${TEMPLATE_VMID}
       format: "qcow2"
       full: true
+      numSockets: ${NUM_SOCKETS:=2}
+      numCores: ${NUM_CORES:=4}
+      memoryMiB: ${MEMORY_MIB:=16384}
+      disks:
+        bootVolume:
+          disk: ${BOOT_VOLUME_DEVICE}
+          sizeGb: ${BOOT_VOLUME_SIZE:=100}
+      network:
+        default:
+          bridge: ${BRIDGE}
+          model: virtio
 ---
 apiVersion: cluster.x-k8s.io/v1beta1
 kind: MachineDeployment
@@ -161,6 +172,17 @@ spec:
       templateID: ${TEMPLATE_VMID}
       format: "qcow2"
       full: true
+      numSockets: ${NUM_SOCKETS:=2}
+      numCores: ${NUM_CORES:=4}
+      memoryMiB: ${MEMORY_MIB:=16384}
+      disks:
+        bootVolume:
+          disk: ${BOOT_VOLUME_DEVICE}
+          sizeGb: ${BOOT_VOLUME_SIZE:=100}
+      network:
+        default:
+          bridge: ${BRIDGE}
+          model: virtio
 ---
 apiVersion: bootstrap.cluster.x-k8s.io/v1beta1
 kind: KubeadmConfigTemplate