Skip to content

Commit f528a1c

Browse files
committed
update how it works: README.md
1 parent 85717b2 commit f528a1c

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ cluster-api-provider-proxmox provides only infrastructure controller (`ProxmoxCl
99
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
1010
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
1111

12-
### Running on the cluster
12+
### with KubeadmControlplane/Bootstrap
1313
1. Initialize Management cluster
1414

1515
for more information : https://cluster-api.sigs.k8s.io/user/quick-start.html#initialize-the-management-cluster
@@ -71,9 +71,17 @@ CAPP is tested with `pve-manager/7.4-3/9002ab8a (running kernel: 5.15.102-1-pve)
7171
## How it works
7272
This project aims to follow the Cluster API [Provider contract](https://cluster-api.sigs.k8s.io/developer/providers/contracts.html).
7373

74+
### ProxmoxCluster
75+
76+
Because Proxmox-VE does not provide LBaaS solution, CAPP 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.
77+
78+
### ProxmoxMachine
79+
80+
ProxmoxMachine controller follows the [typical infra-machine logic](https://cluster-api.sigs.k8s.io/developer/providers/machine-infrastructure.html#behavior). To bootstrap your machine, CAPP supports only `cloud-config` type bootstrap data secret. CAPP is mainly tested with [KubeadmControlPlane](https://github.com/kubernetes-sigs/cluster-api/tree/main/controlplane/kubeadm) and [KubeadmBootstrap](https://github.com/kubernetes-sigs/cluster-api/tree/main/bootstrap/kubeadm).
81+
7482
## Contributing
7583

76-
Are you interested in contributing to cluster-api-provider-proxmox? Do not hesitate to open Github issues.
84+
Are you interested in contributing to cluster-api-provider-proxmox? Do not hesitate to open GitHub issues.
7785

7886
## License
7987

0 commit comments

Comments
 (0)