Skip to content

Commit 2e22122

Browse files
committed
Add Proxmox provider quickstart
1 parent 9bea739 commit 2e22122

File tree

1 file changed

+65
-1
lines changed

1 file changed

+65
-1
lines changed

docs/book/src/user/quick-start.md

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -740,6 +740,38 @@ clusterctl init --infrastructure vsphere
740740
For more information about prerequisites, credentials management, or permissions for vSphere, see the [vSphere
741741
project][vSphere getting started guide].
742742
743+
{{#/tab }}
744+
{{#tab Proxmox}}
745+
746+
First, we need to add the Proxmox infrastructure provider and the IPAM provider to your clusterctl config file `~/.cluster-api/clusterctl.yaml`:
747+
```yaml
748+
providers:
749+
- name: in-cluster
750+
url: https://github.com/kubernetes-sigs/cluster-api-ipam-provider-in-cluster/releases/latest/ipam-components.yaml
751+
type: IPAMProvider
752+
- name: proxmox
753+
url: https://github.com/ionos-cloud/cluster-api-provider-proxmox/releases/latest/infrastructure-components.yaml
754+
type: InfrastructureProvider
755+
```
756+
757+
```bash
758+
# The host for the Proxmox cluster
759+
export PROXMOX_URL="https://pve.example:8006"
760+
# The Proxmox token ID to access the remote Proxmox endpoint
761+
export PROXMOX_TOKEN='root@pam!capi'
762+
# The secret associated with the token ID
763+
# You may want to set this in `$XDG_CONFIG_HOME/cluster-api/clusterctl.yaml` so your password is not in
764+
# bash history
765+
export PROXMOX_SECRET="1234-1234-1234-1234"
766+
767+
768+
# Finally, initialize the management cluster
769+
clusterctl init --infrastructure proxmox --ipam in-cluster
770+
```
771+
772+
For more information about the CAPI provider for Proxmox, see the [Proxmox
773+
project][Proxmox getting started guide].
774+
743775
{{#/tab }}
744776
{{#/tabs }}
745777
@@ -1207,6 +1239,37 @@ export CONTROL_PLANE_ENDPOINT_IP="1.2.3.4"
12071239
12081240
For more information about prerequisites, credentials management, or permissions for vSphere, see the [vSphere getting started guide].
12091241
1242+
{{#/tab }}
1243+
{{#tab Proxmox}}
1244+
1245+
A ClusterAPI compatible image must be available in your Proxmox cluster. For instructions on how to build a compatible VM template
1246+
see [image-builder](https://image-builder.sigs.k8s.io/capi/capi.html).
1247+
1248+
```bash
1249+
# The node that hosts the VM template to be used to provision VMs
1250+
export PROXMOX_SOURCENODE="pve"
1251+
# The template VM ID used for cloning VMs
1252+
export TEMPLATE_VMID=100
1253+
# The ssh authorized keys used to ssh to the machines.
1254+
export VM_SSH_KEYS="ssh-ed25519 ..., ssh-ed25519 ..."
1255+
# The IP address used for the control plane endpoint
1256+
export CONTROL_PLANE_ENDPOINT_IP=10.10.10.4
1257+
# The IP ranges for Cluster nodes
1258+
export NODE_IP_RANGES="[10.10.10.5-10.10.10.50, 10.10.10.55-10.10.10.70]"
1259+
# The gateway for the machines network-config.
1260+
export GATEWAY="10.10.10.1"
1261+
# Subnet Mask in CIDR notation for your node IP ranges
1262+
export IP_PREFIX=24
1263+
# The Proxmox network device for VMs
1264+
export BRIDGE="vmbr1"
1265+
# The dns nameservers for the machines network-config.
1266+
export DNS_SERVERS="[8.8.8.8,8.8.4.4]"
1267+
# The Proxmox nodes used for VM deployments
1268+
export ALLOWED_NODES="[pve1,pve2,pve3]"
1269+
```
1270+
1271+
For more information about prerequisites and advanced setups for Proxmox, see the [Proxmox getting started guide].
1272+
12101273
{{#/tab }}
12111274
{{#/tabs }}
12121275
@@ -1623,4 +1686,5 @@ kind delete cluster
16231686
[provider components]: ../reference/glossary.md#provider-components
16241687
[vSphere getting started guide]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/blob/master/docs/getting_started.md
16251688
[workload cluster]: ../reference/glossary.md#workload-cluster
1626-
[CAPI Operator quickstart]: ./quick-start-operator.md
1689+
[CAPI Operator quickstart]: ./quick-start-operator.md
1690+
[Proxmox getting started guide]: https://github.com/ionos-cloud/cluster-api-provider-proxmox/blob/main/docs/Usage.md

0 commit comments

Comments
 (0)