Skip to content

Commit 542d636

Browse files
authored
Merge pull request #27 from sp-yduck/acronyms
Acronyms
2 parents 714f8af + 307639a commit 542d636

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# cluster-api-provider-proxmox (CAPP)
1+
# cluster-api-provider-proxmox (CAPPX)
22

33
cluster-api-provider-proxmox is a Cluster API [infrastructure provider](https://cluster-api.sigs.k8s.io/developer/providers/cluster-infrastructure.html) implementation for [Proxmox VE](https://pve.proxmox.com/wiki/Main_Page).
44

@@ -41,7 +41,7 @@ make create-workload-cluster
4141

4242
3. Access your first workload cluster !!
4343

44-
Usually it takes 2~5 mins to complete bootstrap the nodes.
44+
Usually it takes 2~10 mins to complete bootstrapping the nodes.
4545
```sh
4646
# get workload cluster's kubeconfig
4747
clusterctl get kubeconfig cappx-test > kubeconfig.yaml
@@ -59,34 +59,34 @@ make delete-workload-cluster
5959

6060
- No need to prepare vm templates. You can specify any vm image in `ProxmoxMachine.Spec.Image`.
6161

62-
- 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.
62+
- 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.
6363

6464
## Compatibility
6565

6666
### Proxmox-VE REST API
6767

68-
CAPP is tested with `pve-manager/7.4-3/9002ab8a (running kernel: 5.15.102-1-pve)`.
68+
CAPPX is tested with `pve-manager/7.4-3/9002ab8a (running kernel: 5.15.102-1-pve)`.
6969

7070
### Cluster API
7171

7272
| | Cluster API v1alpha4 | Cluster API v1beta1 |
7373
| --------------------- | :------------------: | :-----------------: |
74-
| CAPP v1beta1 `(v0.x)` | ? ||
74+
| CAPPX v1beta1 `(v0.x)` | ? ||
7575

7676
### ControlPlane & Bootstrap provider
7777

78-
CAPP is 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).
78+
CAPPX is 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).
7979

8080
## How it works
8181
This project aims to follow the Cluster API [Provider contract](https://cluster-api.sigs.k8s.io/developer/providers/contracts.html).
8282

8383
### ProxmoxCluster
8484

85-
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.
85+
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.
8686

8787
### ProxmoxMachine
8888

89-
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).
89+
ProxmoxMachine controller follows the [typical infra-machine logic](https://cluster-api.sigs.k8s.io/developer/providers/machine-infrastructure.html#behavior). To bootstrap your machine, CAPPX supports only `cloud-config` type bootstrap data secret. CAPPX 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).
9090

9191
## Contributing
9292

cloud/scope/cluster.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ func NewClusterScope(ctx context.Context, params ClusterScopeParams) (*ClusterSc
5353
}
5454

5555
if params.ProxmoxServices.Remote == nil {
56-
// current CAPP is compatible with only single node proxmox cluster
56+
// current CAPPX is compatible with only single node proxmox cluster
5757
remote, err := newRemoteClient(ctx, params.ProxmoxCluster.Spec.NodeRefs[0].SecretRef, params.Client)
5858
if err != nil {
5959
return nil, errors.Errorf("failed to create remote client: %v", err)

cloud/services/compute/instance/image.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ func SetCloudImage(ctx context.Context, vmid int, storage infrav1.Storage, image
4343

4444
url := image.URL
4545
fileName := path.Base(url)
46-
rawImageDirPath := fmt.Sprintf("%s/images", etcCAPP)
46+
rawImageDirPath := fmt.Sprintf("%s/images", etcCAPPX)
4747
rawImageFilePath := fmt.Sprintf("%s/%s", rawImageDirPath, fileName)
4848

4949
// workaround

cloud/services/compute/instance/reconcile.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import (
1818
)
1919

2020
const (
21-
etcCAPP = "/etc/capp"
21+
etcCAPPX = "/etc/cappx"
2222
)
2323

2424
// reconcile normal

logos/k-get-proxmoxcluster.PNG

-3.98 KB
Binary file not shown.

logos/k-get-proxmoxmachine.PNG

-7.32 KB
Binary file not shown.

0 commit comments

Comments
 (0)