Skip to content

Commit 85717b2

Browse files
committed
add features to README.md
1 parent 4272d62 commit 85717b2

File tree

1 file changed

+8
-30
lines changed

1 file changed

+8
-30
lines changed

README.md

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -58,44 +58,22 @@ metadata:
5858
type: Opaque
5959
```
6060
61-
## How it works
62-
This project aims to follow the Cluster API [Provider contract](https://cluster-api.sigs.k8s.io/developer/providers/contracts.html).
63-
64-
### Proxmox Cluster Controller
65-
66-
- [ ] Create controlplane load balancer
67-
68-
- [x] Create proxmox storage
69-
70-
- [ ] Delete controlplane load balancer
71-
72-
- [ ] Delete proxmox storage
73-
74-
### Proxmox Machine Controller
61+
## Fetures
7562
76-
- [x] Create virtual machine instance
63+
- No need to prepare vm templates. You can specify any vm image in `ProxmoxMachine.Spec.Image`.
7764

78-
- [x] Boot virtual machine instance with provided bootstrap secret (see: [bootstrap provider specification](https://cluster-api.sigs.k8s.io/developer/providers/bootstrap.html#bootstrap-provider-specification) for how bootstrap works)
65+
- Supports custom cloud-config (user data). CAPP uses ssh for bootstrapping nodes so it can applies custom cloud-config that can not be achieved by only Proxmox API.
7966

80-
- [ ] Register virtual machine instance with Controlplane load balancer
67+
## Compatibility
8168

82-
- [x] Delete virtual machine instance
69+
CAPP is tested with `pve-manager/7.4-3/9002ab8a (running kernel: 5.15.102-1-pve)`
8370

84-
- [ ] Un-register virtual machine instance with Controlplane load balancer
71+
## How it works
72+
This project aims to follow the Cluster API [Provider contract](https://cluster-api.sigs.k8s.io/developer/providers/contracts.html).
8573

8674
## Contributing
87-
// TODO(user): Add detailed information on how you would like others to contribute to this project
88-
89-
### Modifying the API definitions
90-
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
91-
92-
```sh
93-
make manifests
94-
```
95-
96-
**NOTE:** Run `make --help` for more information on all potential `make` targets
9775

98-
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
76+
Are you interested in contributing to cluster-api-provider-proxmox? Do not hesitate to open Github issues.
9977

10078
## License
10179

0 commit comments

Comments
 (0)