https://github.com/rancher-sandbox/cluster-api-provider-harvester
A Cluster API Infrastructure Provider for Harvester
https://github.com/rancher-sandbox/cluster-api-provider-harvester
cluster-api harvester infrastructure kubernetes kubevirt provider
Last synced: 6 months ago
JSON representation
A Cluster API Infrastructure Provider for Harvester
- Host: GitHub
- URL: https://github.com/rancher-sandbox/cluster-api-provider-harvester
- Owner: rancher-sandbox
- License: apache-2.0
- Created: 2023-10-03T10:12:41.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T14:57:14.000Z (over 1 year ago)
- Last Synced: 2024-04-30T11:38:52.705Z (over 1 year ago)
- Topics: cluster-api, harvester, infrastructure, kubernetes, kubevirt, provider
- Language: Go
- Homepage:
- Size: 700 KB
- Stars: 14
- Watchers: 5
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# cluster-api-provider-harvester
This project has begun as a [Hack Week 23](https://hackweek.opensuse.org/23/projects/cluster-api-provider-for-harvester) project. It is still in a very early phase. Please do not use in Production.
## What is Cluster API Provider Harvester (CAPHV)
The [Cluster API](https://cluster-api.sigs.k8s.io/) brings declarative, Kubernetes-style APIs to cluster creation, configuration and management.
Cluster API Provider Harvester is __Cluster API Infrastructure Provider__ for provisioning Kubernetes Clusters on [Harvester](https://harvesterhci.io/).
At this stage, the Provider has been tested on a single environment, with Harvester v1.2.0 using two Control Plane/Bootstrap providers: [Kubeadm](https://github.com/kubernetes-sigs/cluster-api/tree/main/controlplane/kubeadm) and [RKE2](https://github.com/rancher-sandbox/cluster-api-provider-rke2).
The [templates](https://github.com/rancher-sandbox/cluster-api-provider-harvester/tree/main/templates) folder contains examples of such configurations.
## Getting Started
Cluster API Provider Harvester is compliant with the `clusterctl` contract, which means that `clusterctl` simplifies its deployment to the CAPI Management Cluster. In this Getting Started guide, we will be using the Harvester Provider with the `RKE2` provider (also called `CAPRKE2`).
### Management Cluster
In order to use this provider, you need to have a management cluster available to you and have your current KUBECONFIG context set to talk to that cluster. If you do not have a cluster available to you, you can create a `kind` cluster. These are the steps needed to achieve that:
1. Ensure kind is installed (https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
2. Create a special `kind` configuration file if you intend to use the Docker infrastructure provider:
```bash
cat > kind-cluster-with-extramounts.yaml < # should exist in Harvester prior to applying manifest. Should have the format /
export VM_IMAGE_NAME=default/jammy-server-cloudimg-amd64.img # Should have the format / for an image that exists on Harvester
export CONTROL_PLANE_MACHINE_COUNT=3
export WORKER_MACHINE_COUNT=2
export VM_DISK_SIZE=40Gi # Put here the desired disk size
export RANCHER_TURTLES_LABEL='' # This is used if you are using Rancher CAPI Extension (Turtles) to import the cluster automatically.
export VM_NETWORK=default/untagged # change here according to your Harvester available VM Networks. Should have the format /
export HARVESTER_KUBECONFIG_B64=XXXYYY #Full Harvester's kubeconfig encoded in Base64. You can use: cat kubeconfig.yaml | base64
export CLOUD_CONFIG_KUBECONFIG_B64=ZZZZAAA # Kubeconfig generated for the Cloud Provider: https://docs.harvesterhci.io/v1.3/rancher/cloud-provider#deploying-to-the-rke2-custom-cluster-experimental
export IP_POOL_NAME=default # for the non-DHCP template, specify the IP pool for the Harvester load balancer. The IP pool must exist in Harvester prior to applying manifest
export TARGET_HARVESTER_NAMESPACE=default # the namespace on the Harvester cluster where the VMs, load balancers etc. should be created
```
NOTE: The `CLOUD_CONFIG_KUBECONFIG_B64` variable content should be the result of the script available [here](https://docs.harvesterhci.io/v1.3/rancher/cloud-provider#deploying-to-the-rke2-custom-cluster-experimental) -- meaning, the generated kubeconfig -- encoded in BASE64.
Now, we can generate the YAML using the following command:
```bash
clusterctl generate yaml --from https://github.com/rancher-sandbox/cluster-api-provider-harvester/blob/main/templates/cluster-template-rke2.yaml > harvester-rke2-clusterctl.yaml
```
After examining the resulting YAML file, you can apply it to the management cluster:
```bash
kubectl apply -f harvester-rke2-clusterctl.yaml
```
You should see the following output:
```bash
namespace/example-rk created
cluster.cluster.x-k8s.io/test-rk created
harvestercluster.infrastructure.cluster.x-k8s.io/test-rk-hv created
secret/hv-identity-secret created
rke2controlplane.controlplane.cluster.x-k8s.io/test-rk-control-plane created
rke2configtemplate.bootstrap.cluster.x-k8s.io/test-rk-worker created
machinedeployment.cluster.x-k8s.io/test-rk-workers created
harvestermachinetemplate.infrastructure.cluster.x-k8s.io/test-rk-wk-machine created
harvestermachinetemplate.infrastructure.cluster.x-k8s.io/test-rk-cp-machine created
clusterresourceset.addons.cluster.x-k8s.io/crs-harvester-ccm created
clusterresourceset.addons.cluster.x-k8s.io/crs-harvester-csi created
clusterresourceset.addons.cluster.x-k8s.io/crs-calico-chart-config created
configmap/cloud-controller-manager-addon created
configmap/harvester-csi-driver-addon created
configmap/calico-helm-config created
```
### Checking the workload cluster:
After a while you should be able to check functionality of the workload cluster using `clusterctl`:
```bash
clusterctl describe cluster -n example-rk test-rk
```
and once the cluster is provisioned, it should look similar to the following:
```
NAME READY SEVERITY REASON SINCE MESSAGE
Cluster/test-rk True 7h35m
├─ClusterInfrastructure - HarvesterCluster/test-rk-hv
├─ControlPlane - RKE2ControlPlane/test-rk-control-plane True 7h35m
│ └─3 Machines... True 7h45m See test-rk-control-plane-dmrg5, test-rk-control-plane-jkdrb, ...
└─Workers
└─MachineDeployment/test-rk-workers True 7h46m
└─2 Machines... True 7h46m See test-rk-workers-jwjdg-sz7qk, test-rk-workers-jwjdg-vxgbx
```