Add OpenNebula infrastructure provider to clusterctl

Author: sk4zuzu

cmd/clusterctl/client/config/providers_client.go

@@ -72,6 +72,7 @@ const (
 	K0smotronProviderName      = "k0sproject-k0smotron"
 	IonosCloudProviderName     = "ionoscloud-ionoscloud"
 	VultrProviderName          = "vultr-vultr"
+	OpenNebulaProviderName     = "opennebula"
 )
 
 // Bootstrap providers.
@@ -333,6 +334,11 @@ func (p *providersClient) defaults() []Provider {
 			url:          "https://github.com/vultr/cluster-api-provider-vultr/releases/latest/infrastructure-components.yaml",
 			providerType: clusterctlv1.InfrastructureProviderType,
 		},
+		&provider{
+			name:         OpenNebulaProviderName,
+			url:          "https://github.com/OpenNebula/cluster-api-provider-opennebula/releases/latest/infrastructure-components.yaml",
+			providerType: clusterctlv1.InfrastructureProviderType,
+		},
 
 		// Bootstrap providers
 		&provider{

cmd/clusterctl/client/config_test.go

@@ -96,6 +96,7 @@ func Test_clusterctlClient_GetProvidersConfig(t *testing.T) {
 				config.NestedProviderName,
 				config.NutanixProviderName,
 				config.OCIProviderName,
+				config.OpenNebulaProviderName,
 				config.OpenStackProviderName,
 				config.OutscaleProviderName,
 				config.PacketProviderName,
@@ -163,6 +164,7 @@ func Test_clusterctlClient_GetProvidersConfig(t *testing.T) {
 				config.NestedProviderName,
 				config.NutanixProviderName,
 				config.OCIProviderName,
+				config.OpenNebulaProviderName,
 				config.OpenStackProviderName,
 				config.OutscaleProviderName,
 				config.PacketProviderName,

cmd/clusterctl/cmd/config_repositories_test.go

@@ -144,6 +144,7 @@ my-infra-provider       InfrastructureProvider     /home/.config/cluster-api/ove
 nested                  InfrastructureProvider     https://github.com/kubernetes-sigs/cluster-api-provider-nested/releases/latest/                   infrastructure-components.yaml
 nutanix                 InfrastructureProvider     https://github.com/nutanix-cloud-native/cluster-api-provider-nutanix/releases/latest/             infrastructure-components.yaml
 oci                     InfrastructureProvider     https://github.com/oracle/cluster-api-provider-oci/releases/latest/                               infrastructure-components.yaml
+opennebula              InfrastructureProvider     https://github.com/OpenNebula/cluster-api-provider-opennebula/releases/latest/                    infrastructure-components.yaml
 openstack               InfrastructureProvider     https://github.com/kubernetes-sigs/cluster-api-provider-openstack/releases/latest/                infrastructure-components.yaml
 outscale                InfrastructureProvider     https://github.com/outscale/cluster-api-provider-outscale/releases/latest/                        infrastructure-components.yaml
 packet                  InfrastructureProvider     https://github.com/kubernetes-sigs/cluster-api-provider-packet/releases/latest/                   infrastructure-components.yaml
@@ -330,6 +331,10 @@ var expectedOutputYaml = `- File: core_components.yaml
   Name: oci
   ProviderType: InfrastructureProvider
   URL: https://github.com/oracle/cluster-api-provider-oci/releases/latest/
+- File: infrastructure-components.yaml
+  Name: opennebula
+  ProviderType: InfrastructureProvider
+  URL: https://github.com/OpenNebula/cluster-api-provider-opennebula/releases/latest/
 - File: infrastructure-components.yaml
   Name: openstack
   ProviderType: InfrastructureProvider

docs/book/src/developer/providers/contracts/clusterctl.md

@@ -332,6 +332,7 @@ providers.
 | CAPK          | cluster.x-k8s.io/provider=infrastructure-kubevirt     |
 | CAPM3         | cluster.x-k8s.io/provider=infrastructure-metal3       |
 | CAPN          | cluster.x-k8s.io/provider=infrastructure-nested       |
+| CAPONE        | cluster.x-k8s.io/provider=infrastructure-opennebula   |
 | CAPO          | cluster.x-k8s.io/provider=infrastructure-openstack    |
 | CAPOCI        | cluster.x-k8s.io/provider=infrastructure-oci          |
 | CAPP          | cluster.x-k8s.io/provider=infrastructure-packet       |

docs/book/src/reference/providers.md

@@ -51,6 +51,7 @@ updated info about which API version they are supporting.
 - [Nested](https://github.com/kubernetes-sigs/cluster-api-provider-nested)
 - [Nutanix](https://github.com/nutanix-cloud-native/cluster-api-provider-nutanix)
 - [Oracle Cloud Infrastructure (OCI)](https://github.com/oracle/cluster-api-provider-oci)
+- [OpenNebula](https://github.com/OpenNebula/cluster-api-provider-opennebula)
 - [OpenStack](https://github.com/kubernetes-sigs/cluster-api-provider-openstack)
 - [Outscale](https://github.com/outscale/cluster-api-provider-outscale)
 - [Proxmox](https://github.com/ionos-cloud/cluster-api-provider-proxmox)

docs/book/src/user/quick-start.md

@@ -281,7 +281,7 @@ Additional documentation about experimental features can be found in [Experiment
 Depending on the infrastructure provider you are planning to use, some additional prerequisites should be satisfied
 before getting started with Cluster API. See below for the expected settings for common providers.
 
-{{#tabs name:"tab-installation-infrastructure" tabs:"Akamai (Linode),AWS,Azure,CloudStack,DigitalOcean,Docker,Equinix Metal,GCP,Harvester,Hetzner,Hivelocity,Huawei,IBM Cloud,IONOS Cloud,K0smotron,KubeKey,KubeVirt,Metal3,Nutanix,OCI,OpenStack,Outscale,Proxmox,VCD,vcluster,Virtink,vSphere,Vultr"}}
+{{#tabs name:"tab-installation-infrastructure" tabs:"Akamai (Linode),AWS,Azure,CloudStack,DigitalOcean,Docker,Equinix Metal,GCP,Harvester,Hetzner,Hivelocity,Huawei,IBM Cloud,IONOS Cloud,K0smotron,KubeKey,KubeVirt,Metal3,Nutanix,OCI,OpenNebula,OpenStack,Outscale,Proxmox,VCD,vcluster,Virtink,vSphere,Vultr"}}
 {{#tab Akamai (Linode)}}
 
 ```bash
@@ -729,6 +729,16 @@ Please follow the Cluster API Provider for [Nutanix Getting Started Guide](https
 
 Please follow the Cluster API Provider for [Oracle Cloud Infrastructure (OCI) Getting Started Guide][oci-provider]
 
+{{#/tab }}
+{{#tab OpenNebula}}
+
+```bash
+# Initialize the management cluster
+clusterctl init --infrastructure opennebula
+```
+
+Please visit [OpenNebula Cluster API Provider Wiki][CAPONE Wiki].
+
 {{#/tab }}
 {{#tab OpenStack}}
 
@@ -906,7 +916,7 @@ before configuring a cluster with Cluster API. Instructions are provided for com
 Otherwise, you can look at the `clusterctl generate cluster` [command][clusterctl generate cluster] documentation for details about how to
 discover the list of variables required by a cluster templates.
 
-{{#tabs name:"tab-configuration-infrastructure" tabs:"Akamai (Linode),AWS,Azure,CloudStack,DigitalOcean,Docker,Equinix Metal,GCP,Harvester,Huawei,IBM Cloud,IONOS Cloud,K0smotron,KubeKey,KubeVirt,Metal3,Nutanix,OpenStack,Outscale,Proxmox,Tinkerbell,VCD,vcluster,Virtink,vSphere,Vultr"}}
+{{#tabs name:"tab-configuration-infrastructure" tabs:"Akamai (Linode),AWS,Azure,CloudStack,DigitalOcean,Docker,Equinix Metal,GCP,Harvester,Huawei,IBM Cloud,IONOS Cloud,K0smotron,KubeKey,KubeVirt,Metal3,Nutanix,OpenNebula,OpenStack,Outscale,Proxmox,Tinkerbell,VCD,vcluster,Virtink,vSphere,Vultr"}}
 {{#tab Akamai (Linode)}}
 
 ```bash
@@ -1292,6 +1302,35 @@ To see all required Nutanix environment variables execute:
 clusterctl generate cluster --infrastructure nutanix --list-variables capi-quickstart
 ```
 
+{{#/tab }}
+{{#tab OpenNebula}}
+
+```bash
+# OpenNebula API endpoint and credentials
+export ONE_XMLRPC='http://10.2.11.40:2633/RPC2'
+export ONE_AUTH='oneadmin:opennebula'
+
+# VM and VR templates to construct workload clusters from
+export MACHINE_TEMPLATE_NAME='capone131'
+export ROUTER_TEMPLATE_NAME='capone131-vr'
+
+# VNs to deploy workload clusters into
+export PUBLIC_NETWORK_NAME='service'
+export PRIVATE_NETWORK_NAME='private'
+
+# Name of the new workload cluster
+export CLUSTER_NAME='one'
+
+# Cloud-Provider image to deploy inside the new workload cluster
+export CCM_IMG='ghcr.io/opennebula/cloud-provider-opennebula:latest'
+
+# Initial size of the new workload cluster
+export CONTROL_PLANE_MACHINE_COUNT='1'
+export WORKER_MACHINE_COUNT='1'
+```
+
+Please visit [OpenNebula Cluster API Provider Wiki][CAPONE Wiki].
+
 {{#/tab }}
 {{#tab OpenStack}}
 
@@ -1969,3 +2008,4 @@ kind delete cluster
 [CAPI Operator quickstart]: ./quick-start-operator.md
 [Proxmox getting started guide]: https://github.com/ionos-cloud/cluster-api-provider-proxmox/blob/main/docs/Usage.md
 [Tinkerbell getting started guide]: https://github.com/tinkerbell/cluster-api-provider-tinkerbell/blob/main/docs/QUICK-START.md
+[CAPONE Wiki]: https://github.com/OpenNebula/cluster-api-provider-opennebula/wiki