Add clusterctl support for VMware Cloud Director as Infrastructure Provider

Author: sahithi

cmd/clusterctl/client/config/providers_client.go

@@ -35,26 +35,27 @@ const (
 
 // Infra providers.
 const (
-	AWSProviderName        = "aws"
-	AzureProviderName      = "azure"
-	BYOHProviderName       = "byoh"
-	CloudStackProviderName = "cloudstack"
-	DockerProviderName     = "docker"
-	DOProviderName         = "digitalocean"
-	GCPProviderName        = "gcp"
-	HetznerProviderName    = "hetzner"
-	IBMCloudProviderName   = "ibmcloud"
-	Metal3ProviderName     = "metal3"
-	NestedProviderName     = "nested"
-	NutanixProviderName    = "nutanix"
-	OCIProviderName        = "oci"
-	OpenStackProviderName  = "openstack"
-	PacketProviderName     = "packet"
-	SideroProviderName     = "sidero"
-	VSphereProviderName    = "vsphere"
-	MAASProviderName       = "maas"
-	KubevirtProviderName   = "kubevirt"
-	VclusterProviderName   = "vcluster"
+	AWSProviderName            = "aws"
+	AzureProviderName          = "azure"
+	BYOHProviderName           = "byoh"
+	CloudStackProviderName     = "cloudstack"
+	DockerProviderName         = "docker"
+	DOProviderName             = "digitalocean"
+	GCPProviderName            = "gcp"
+	HetznerProviderName        = "hetzner"
+	IBMCloudProviderName       = "ibmcloud"
+	Metal3ProviderName         = "metal3"
+	NestedProviderName         = "nested"
+	NutanixProviderName        = "nutanix"
+	OCIProviderName            = "oci"
+	OpenStackProviderName      = "openstack"
+	PacketProviderName         = "packet"
+	SideroProviderName         = "sidero"
+	VCloudDirectorProviderName = "vcd"
+	VSphereProviderName        = "vsphere"
+	MAASProviderName           = "maas"
+	KubevirtProviderName       = "kubevirt"
+	VclusterProviderName       = "vcluster"
 )
 
 // Bootstrap providers.
@@ -178,6 +179,11 @@ func (p *providersClient) defaults() []Provider {
 			url:          "https://github.com/siderolabs/sidero/releases/latest/infrastructure-components.yaml",
 			providerType: clusterctlv1.InfrastructureProviderType,
 		},
+		&provider{
+			name:         VCloudDirectorProviderName,
+			url:          "https://github.com/vmware/cluster-api-provider-cloud-director/releases/latest/infrastructure-components.yaml",
+			providerType: clusterctlv1.InfrastructureProviderType,
+		},
 		&provider{
 			name:         VSphereProviderName,
 			url:          "https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases/latest/infrastructure-components.yaml",

cmd/clusterctl/client/config_test.go

@@ -79,6 +79,7 @@ func Test_clusterctlClient_GetProvidersConfig(t *testing.T) {
 				config.OpenStackProviderName,
 				config.PacketProviderName,
 				config.SideroProviderName,
+				config.VCloudDirectorProviderName,
 				config.VclusterProviderName,
 				config.VSphereProviderName,
 			},
@@ -116,6 +117,7 @@ func Test_clusterctlClient_GetProvidersConfig(t *testing.T) {
 				config.OpenStackProviderName,
 				config.PacketProviderName,
 				config.SideroProviderName,
+				config.VCloudDirectorProviderName,
 				config.VclusterProviderName,
 				config.VSphereProviderName,
 			},

cmd/clusterctl/cmd/config_repositories_test.go

@@ -126,6 +126,7 @@ oci                 InfrastructureProvider   https://github.com/oracle/cluster-a
 openstack           InfrastructureProvider   https://github.com/kubernetes-sigs/cluster-api-provider-openstack/releases/latest/        infrastructure-components.yaml
 packet              InfrastructureProvider   https://github.com/kubernetes-sigs/cluster-api-provider-packet/releases/latest/           infrastructure-components.yaml
 sidero              InfrastructureProvider   https://github.com/siderolabs/sidero/releases/latest/                                     infrastructure-components.yaml
+vcd                 InfrastructureProvider   https://github.com/vmware/cluster-api-provider-cloud-director/releases/latest/            infrastructure-components.yaml
 vcluster            InfrastructureProvider   https://github.com/loft-sh/cluster-api-provider-vcluster/releases/latest/                 infrastructure-components.yaml
 vsphere             InfrastructureProvider   https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases/latest/          infrastructure-components.yaml
 `
@@ -234,6 +235,10 @@ var expectedOutputYaml = `- File: core_components.yaml
   Name: sidero
   ProviderType: InfrastructureProvider
   URL: https://github.com/siderolabs/sidero/releases/latest/
+- File: infrastructure-components.yaml
+  Name: vcd
+  ProviderType: InfrastructureProvider
+  URL: https://github.com/vmware/cluster-api-provider-cloud-director/releases/latest/
 - File: infrastructure-components.yaml
   Name: vcluster
   ProviderType: InfrastructureProvider

docs/book/src/clusterctl/provider-contract.md

@@ -254,6 +254,7 @@ providers.
 |CAPP          | cluster.x-k8s.io/provider=infrastructure-packet        |
 |CAPV          | cluster.x-k8s.io/provider=infrastructure-vsphere       |
 |CAPVC         | cluster.x-k8s.io/provider=infrastructure-vcluster      |
+|CAPVCD        | cluster.x-k8s.io/provider=infrastructure-vcd           |
 |CAPX          | cluster.x-k8s.io/provider=infrastructure-nutanix       |
 |CAPZ          | cluster.x-k8s.io/provider=infrastructure-azure         |
 

docs/book/src/reference/glossary.md

@@ -77,6 +77,9 @@ Cluster API Provider vSphere
 ### CAPVC
 Cluster API Provider vcluster
 
+### CAPVCD
+Cluster API Provider VMware Cloud Director
+
 ### CAPZ
 Cluster API Provider Azure
 

docs/book/src/reference/providers.md

@@ -34,6 +34,7 @@ updated info about which API version they are supporting.
 - [Equinix Metal (formerly Packet)](https://github.com/kubernetes-sigs/cluster-api-provider-packet)
 - [Sidero](https://github.com/siderolabs/sidero)
 - [Tencent Cloud](https://github.com/TencentCloud/cluster-api-provider-tencent)
+- [VMware Cloud Director](https://github.com/vmware/cluster-api-provider-cloud-director)  
 - [vSphere](https://github.com/kubernetes-sigs/cluster-api-provider-vsphere)
 - [Microvm](https://github.com/weaveworks-liquidmetal/cluster-api-provider-microvm)
 

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

@@ -202,7 +202,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:"AWS,Azure,CloudStack,DigitalOcean,Docker,Equinix Metal,GCP,Hetzner,IBM Cloud,Metal3,Nutanix,Kubevirt,OCI,OpenStack,vSphere"}}
+{{#tabs name:"tab-installation-infrastructure" tabs:"AWS,Azure,CloudStack,DigitalOcean,Docker,Equinix Metal,GCP,Hetzner,IBM Cloud,Metal3,Nutanix,Kubevirt,OCI,OpenStack,VCD,vSphere"}}
 {{#tab AWS}}
 
 Download the latest binary of `clusterawsadm` from the [AWS provider releases].
@@ -460,6 +460,17 @@ Please follow the Cluster API Provider for [Oracle Cloud Infrastructure (OCI) Ge
 clusterctl init --infrastructure openstack
 ```
 
+{{#/tab }}
+{{#tab VCD}}
+
+Please follow the Cluster API Provider for [Cloud Director Getting Started Guide](https://github.com/vmware/cluster-api-provider-cloud-director/blob/main/README.md)
+
+EXP_CLUSTER_RESOURCE_SET: "true"
+```bash
+# Initialize the management cluster
+clusterctl init --infrastructure vcd
+```
+
 {{#/tab }}
 {{#tab vSphere}}
 
@@ -831,6 +842,18 @@ export OPENSTACK_EXTERNAL_NETWORK_ID=<external network ID>
 
 A full configuration reference can be found in [configuration.md](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/master/docs/book/src/clusteropenstack/configuration.md).
 
+{{#/tab }}
+{{#tab VCD}}
+
+A ClusterAPI compatible image must be available in your VCD catalog. For instructions on how to build and upload a compatible image
+see [CAPVCD](https://github.com/vmware/cluster-api-provider-cloud-director)
+
+To see all required VCD environment variables execute:
+```bash
+clusterctl generate cluster --infrastructure vcd --list-variables capi-quickstart
+``
+
+
 {{#/tab }}
 {{#tab vSphere}}