cluster-api-provider-cloud-director

README

Kubernetes Cluster API Provider Cloud Director

Overview

The Cluster API brings declarative, Kubernetes-style APIs to cluster creation, configuration and management. Cluster API Provider for Cloud Director is a concrete implementation of Cluster API for VMware Cloud Director.

Quick start

Check out our Cluster API quick start guide to create a Kubernetes cluster on VMware Cloud Director using Cluster API.

Support Policy

The version of Cluster API Provider Cloud Director and Installation that are compatible for a given CAPVCD container image are described in the following compatibility matrix:

Note: The Kubernetes versions mentioned are what we have qualified with.

CAPVCD Version	VMware Cloud Director API	VMware Cloud Director Installation	CoreCAPI/Clusterctl CLI version	Kubernetes Versions	CSI Versions	CPI Versions
1.3.0	37.2+	10.4.2+	1.5.4	1.28 1.27 1.26 1.25 1.24 1.23 1.22	1.6.0 1.5.0 1.4.1 1.4.0 1.3.2 1.3.1 1.3.0	1.6.0 1.5.0 1.4.0 1.3.0 1.2.0
1.2.0	36.0+	10.3.1+ (10.3.1 needs hot-patch to prevent VCD cell crashes in multi-cell environments)	1.4.0	1.27 1.26 1.25 1.24 1.23 1.22	1.5.0 1.4.1 1.4.0 1.3.2 1.3.1 1.3.0	1.5.0 1.4.0 1.3.0 1.2.0
1.1.1	36.0+	10.3.1+ (10.3.1 needs hot-patch to prevent VCD cell crashes in multi-cell environments)	1.4.0	1.25 1.24 1.23 1.22 1.21 1.20	1.4.1 1.4.0 1.3.2 1.3.1 1.3.0	1.4.1 1.4.0 1.3.0 1.2.0
1.1.0	36.0+	10.3.1+ (10.3.1 needs hot-patch to prevent VCD cell crashes in multi-cell environments)	1.4.0	1.25 1.24 1.23 1.22 1.21 1.20	1.4.0 1.3.2 1.3.1 1.3.0	1.4.0 1.3.0 1.2.0
1.0.2	36.0+	10.3.1+ (10.3.1 needs hot-patch to prevent VCD cell crashes in multi-cell environments)	1.1.3	1.24 1.23 1.22 1.21 1.20	1.3.1 1.3.0	1.3.0 1.2.0
1.0.1	36.0+	10.3.1+ (10.3.1 needs hot-patch to prevent VCD cell crashes in multi-cell environments)	1.1.3	1.24 1.23 1.22 1.21 1.20	1.3.1 1.3.0	1.3.0 1.2.0
1.0.0	36.0+	10.3.1+ (10.3.1 needs hot-patch to prevent VCD cell crashes in multi-cell environments)	1.1.3	1.22 1.21 1.20	1.3.1 1.3.0	1.3.0 1.2.0
0.5.1	36.0+	10.3.1+ (10.3.1 needs hot-patch to prevent VCD cell crashes in multi-cell environments)	0.4.7	1.21 1.20
0.5.0	36.0+	10.3.1+ (10.3.1 needs hot-patch to prevent VCD cell crashes in multi-cell environments)	0.4.7	1.21 1.20

CAPVCD API version - Cluster API version:

	v1alpha4 (v1.0)	v1beta1 (v1.4)	v1beta1 (v1.5)
CAPVCD v1beta2 (v1.3)		✓	✓
CAPVCD v1beta2 (v1.2)	✓	✓
CAPVCD v1beta2 (v1.1)	✓	✓
CAPVCD v1beta1 (v1.0)	✓	✓
CAPVCD v1alpha4 (v0.5.x)	✓	Not supported

TKG versions:

CAPVCD API Version	TKG version(s)
CAPVCD v1beta2 (v1.3.0)	2.5.0, 2.4.0, 2.3.1, 2.2.0
CAPVCD v1beta2 (v1.2.0)	2.4.0, 2.3.1, 2.2.0, 2.1.1
CAPVCD v1beta2 (v1.1.1)	2.2.0, 2.1.1, 1.6.1, 1.5.4, 1.4.3
CAPVCD v1beta2 (v1.1.0)	2.2.0, 2.1.1, 1.6.1, 1.5.4, 1.4.3
CAPVCD v1beta1 (v1.0.2)	1.6.1, 1.5.4, 1.4.3
CAPVCD v1beta1 (v1.0.1)	1.6.1, 1.5.4, 1.4.3
CAPVCD v1beta1 (v1.0.0)	1.5.4, 1.4.3
CAPVCD v1alpha4 (v0.5.x)	1.4.0, 1.3.1

CAPVCD needs to be upgraded to at least 1.0.2 to support workload cluster creations greater than or equal to TKG 1.6.1. This is also applicable for upgrading existing clusters (of TKG versions less than or equal to 1.5.4) to TKG versions greater than or equal to 1.6.1

Troubleshooting

Collect CAPI log bundle for Cloud Director.

Refer to enable wire logs for CAPVCD to log HTTP requests/responses between CAPVCD and Cloud Director

Contributing

The cluster-api-provider-cloud-director project team welcomes contributions from the community. Before you start working with cluster-api-provider-cloud-director, please refer to CONTRIBUTING.md.

Communicating with the maintainers

#cluster-api-cloud-director on Kubernetes slack can be used to communicate with the maintainers to learn more about cluster-api for Cloud Director or to discuss any potential issues.

License

Apache-2.0