Skip to content

Commit d77607b

Browse files
committed
update templates/README according to code changes
1 parent 8a6724a commit d77607b

File tree

2 files changed

+8
-18
lines changed

2 files changed

+8
-18
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,10 @@ clusterctl init --infrastructure=proxmox:v0.2.3 --config https://raw.githubuserc
2424
2. Create your first workload cluster
2525
```sh
2626
# export env variables
27-
export CONTROLPLANE_HOST=X.X.X.X # control-plane vip
27+
export CONTROLPLANE_HOST=X.X.X.X # control-plane vip
2828
export PROXMOX_URL=https://X.X.X.X:8006/api2/json
29-
# export PROXMOX_PASSWORD=password # (optional)
30-
# export PROXMOX_USER=user@pam # (optional)
31-
export PROXMOX_TOKENID='root@pam!api-token-id' # (optional)
32-
export PROXMOX_SECRET=aaaaaaaa-bbbb-cccc-dddd-ee12345678 # (optional)
33-
export NODE_URL=node.ssh.url:22
34-
export NODE_USER=node-ssh-user
35-
export NODE_PASSWORD=node-ssh-password
29+
export PROXMOX_PASSWORD=password
30+
export PROXMOX_USER=user@pam
3631

3732
# generate manifests (available flags: --target-namespace, --kubernetes-version, --control-plane-machine-count, --worker-machine-count)
3833
clusterctl generate cluster cappx-test --control-plane-machine-count=3 --infrastructure=proxmox:v0.2.3 --config https://raw.githubusercontent.com/sp-yduck/cluster-api-provider-proxmox/main/clusterctl.yaml > cappx-test.yaml
@@ -62,9 +57,11 @@ kubectl delete cluster cappx-test
6257

6358
## Fetures
6459

65-
- No need to prepare vm templates. You can specify any vm image in `ProxmoxMachine.Spec.Image`.
60+
- No need to prepare vm templates. You can specify any vm image in `ProxmoxMachine.Spec.Image`. CAPPX bootstrap your vm from scratch.
6661

67-
- Supports custom cloud-config (user data). CAPPX uses ssh for bootstrapping nodes so it can applies custom cloud-config that can not be achieved by only Proxmox API.
62+
- Supports qcow2 image format. CAPPX uses VNC websocket for downloading/installing node images so it can support raw image format not ISO (Proxmox API can only support ISO)
63+
64+
- Supports custom cloud-config (user data). CAPPX uses VNC websockert for bootstrapping nodes so it can applies custom cloud-config that can not be achieved by only Proxmox API.
6865

6966
### Node Images
7067

@@ -99,7 +96,7 @@ This project aims to follow the Cluster API [Provider contract](https://cluster-
9996

10097
### ProxmoxCluster
10198

102-
Because Proxmox-VE does not provide LBaaS solution, CAPPX does not follow the [typical infra-cluster logic](https://cluster-api.sigs.k8s.io/developer/providers/cluster-infrastructure.html#behavior). ProxmoxCluster controller reconciles only Proxmox storages used for instances. You need to prepare control plane load balancer by yourself if you creates HA control plane workload cluster.
99+
Because Proxmox-VE does not provide LBaaS solution, CAPPX does not follow the [typical infra-cluster logic](https://cluster-api.sigs.k8s.io/developer/providers/cluster-infrastructure.html#behavior). ProxmoxCluster controller reconciles only Proxmox storages used for instances. You need to prepare control plane load balancer by yourself if you creates HA control plane workload cluster. In the [cluster-template.yaml](./templates/cluster-template.yaml), you can find HA control plane example with [kube-vip](https://github.com/kube-vip/kube-vip).
103100

104101
### ProxmoxMachine
105102

templates/cluster-template.yaml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,6 @@ spec:
3535
endpoint: "${PROXMOX_URL}"
3636
secretRef:
3737
name: "${CLUSTER_NAME}"
38-
nodeRefs:
39-
- name: mynode
40-
secretRef:
41-
name: "${CLUSTER_NAME}"
4238
storage:
4339
name: "${CLUSTER_NAME}"
4440
path: ""
@@ -318,9 +314,6 @@ stringData:
318314
PROXMOX_USER: ${PROXMOX_USER:=""}
319315
PROXMOX_TOKENID: ${PROXMOX_TOKENID:=""}
320316
PROXMOX_SECRET: ${PROXMOX_SECRET:=""}
321-
NODE_URL: ${NODE_URL}
322-
NODE_USER: ${NODE_USER}
323-
NODE_PASSWORD: ${NODE_PASSWORD}
324317
kind: Secret
325318
metadata:
326319
name: "${CLUSTER_NAME}"

0 commit comments

Comments
 (0)