-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CAFV-449][1.3.z] update CLUSTERCTL.md with updated versions (#614)
* add 1.2.z and 1.3.z to clusterctl.md * update flavors list * review comments
- Loading branch information
Showing
1 changed file
with
35 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,68 @@ | ||
| # Clusterctl | ||
| # Clusterctl | ||
|
|
||
| <a name="version_interop"></a> | ||
|
|
||
| ## Version Interop | ||
|
|
||
| The compatible versions of Core CAPI / clusterctl and CAPVCD are listed in the table below: | ||
|
|
||
| | CAPVCD Version | Core CAPI/clusterctl Version | | ||
| |----------------|------------------------------| | ||
| | main | v1.4.0 | | ||
| | -------------- | ---------------------------- | | ||
| | main | v1.5.4 | | ||
| | 1.3.z | v1.5.4 | | ||
| | 1.2.z | v1.4.0 | | ||
| | 1.1.z | v1.4.0 | | ||
| | 1.0.z | v1.1.3 | | ||
|
|
||
| <a name="clusterctl_set_up"></a> | ||
|
|
||
| ## Set up | ||
| Install [clusterctl](https://cluster-api.sigs.k8s.io/user/quick-start.html#install-clusterctl) according to the [version interop table](#version-interop). | ||
|
|
||
| The below manual steps are required to enable clusterctl for CAPVCD `main`. | ||
| 1. Create a folder structure `~/infrastructure-vcd/v1.1.0/` | ||
| 2. Copy the contents of [templates directory](https://github.com/vmware/cluster-api-provider-cloud-director/tree/main/templates) to `~/infrastructure-vcd/v1.1.0/` | ||
| 3. Copy [metadata.yaml](https://github.com/vmware/cluster-api-provider-cloud-director/tree/main/metadata.yaml) to `~/infrastructure-vcd/v1.1.0/` | ||
| 4. Copy [clusterctl.yaml](https://github.com/vmware/cluster-api-provider-cloud-director/blob/main/templates/clusterctl.yaml) to `~/.cluster-api/clusterctl.yaml` | ||
| 5. Copy [infrastructure-components.yaml](https://github.com/vmware/cluster-api-provider-cloud-director/blob/main/templates/infrastructure-components.yaml) to `~/infrastructure-vcd/v1.1.0/` | ||
| 6. Update the `providers.url` in `~/.cluster-api/clusterctl.yaml` to `~/infrastructure-vcd/v1.1.0/infrastructure-components.yaml` | ||
| ```yaml | ||
| providers: | ||
| - name: "vcd" | ||
| url: "~/infrastructure-vcd/v1.1.0/infrastructure-components.yaml" | ||
| type: "InfrastructureProvider" | ||
| ``` | ||
| Install [clusterctl](https://cluster-api.sigs.k8s.io/user/quick-start.html#install-clusterctl) according to the [version interop table](#version-interop). | ||
|
|
||
| <a name="init_management_cluster"></a> | ||
|
|
||
| ## Initialize Management cluster | ||
|
|
||
| 1. Run the below command to initialize the management cluster with the Cluster API and the associated provider for VMware Cloud Director. Ensure the version interop between CAPVCD, Core CAPI, and Clusterctl are correct from the [interop version table](#version-interop) | ||
| 1. For CAPVCD `main`, use `clusterctl init --core cluster-api:v1.4.0 -b kubeadm:v1.4.0 -c kubeadm:v1.4.0 -i vcd:v1.1.0` | ||
| 1. For CAPVCD `1.3.z`, use `clusterctl init --core cluster-api:v1.5.4 -b kubeadm:v1.5.4 -c kubeadm:v1.5.4 -i vcd:v1.3.0` | ||
| 2. Apply [CRS definitions](CRS.md#apply_crs) to ensure CNI, CPI and CSI are automatically installed on the workload clusters. | ||
|
|
||
|
|
||
| <a name="generate_cluster_manifest"></a> | ||
|
|
||
| ## Generate cluster manifests for workload cluster | ||
|
|
||
| 1. Copy [clusterctl.yaml](https://github.com/vmware/cluster-api-provider-cloud-director/blob/main/templates/clusterctl.yaml) to `~/.cluster-api/clusterctl.yaml` | ||
| 2. Fill out the values for the environment variables in `~/.cluster-api/clusterctl.yaml`. | ||
| 2. Fill out the values for the environment variables in `~/.cluster-api/clusterctl.yaml`. | ||
| - One of the variables is RefreshToken. Refer to [How to create refreshToken (or) API token in Cloud Director](https://docs.vmware.com/en/VMware-Cloud-Director/10.3/VMware-Cloud-Director-Tenant-Portal-Guide/GUID-A1B3B2FA-7B2C-4EE1-9D1B-188BE703EEDE.html). | ||
| - Refer to the [script to get Kubernetes, etcd, coredns versions from TKG OVA](WORKLOAD_CLUSTER.md#tkgm_bom) to fill in few variables. Note that you may skip filling | ||
| in few of these variables if you decide to use the existing [clusterctl template flavors](#template_flavors). | ||
| 2. Generate the CAPI manifest file. | ||
| 3. Generate the CAPI manifest file. | ||
| - `clusterctl generate cluster <clusterName> -f v1.21.8-crs > <clusterName>.yaml`. | ||
| 3. Create the workload cluster by applying it on the (parent) management cluster. | ||
| 4. Create the workload cluster by applying it on the (parent) management cluster. | ||
| - `kubectl apply -f <clusterName>.yaml` | ||
| 4. [Apply CRS labels](CRS.md#apply_crs_labels) and [enable the resultant add-ons like CPI, CSI to access VCD resources](CRS.md#enable_add_ons) | ||
| 5. [Apply CRS labels](CRS.md#apply_crs_labels) and [enable the resultant add-ons like CPI, CSI to access VCD resources](CRS.md#enable_add_ons) | ||
|
|
||
| <a name="template_flavors"></a> | ||
|
|
||
| <a name="template_flavors"></a> | ||
| ## Template flavors | ||
|
|
||
| - All of the templates to generate the cluster manifests are located at `templates` directory under the root of the github repository. | ||
| - All the flavors listed support only v1beta1 API versions of CAPVCD and Core CAPI. | ||
| - Currently, we have v1.20.8, v1.21.8, v1.22.9, v1.23.10 as template flavors, and they each have their own etcd/dns versions pre-populated. | ||
| Please ensure your `~/.cluster-api/clusterctl.yaml` has `VCD_TEMPLATE_NAME` matching the correct versions of Kubernetes. | ||
| For example, if `VCD_TEMPLATE_NAME=Ubuntu 20.04 and Kubernetes v1.21.8+vmware.1` then use `v1.21.8-crs` flavor. | ||
| - It is strongly recommended to use `v1.y.z-crs` flavors to ensure CNI, CPI and CSI are automatically installed on the | ||
| - Currently supported flavors: | ||
|
|
||
| - v1.20.8 | ||
| - v1.24.10 | ||
| - v1.24.17 | ||
| - v1.25.7 | ||
| - v1.25.13 | ||
| - v1.26.8 | ||
| - v1.26.11 | ||
| - v1.27.5 | ||
| - v1.27.8 | ||
| - v1.28.4 | ||
|
|
||
| Please ensure your `~/.cluster-api/clusterctl.yaml` has `VCD_TEMPLATE_NAME` matching the correct versions of Kubernetes. | ||
| For example, if `VCD_TEMPLATE_NAME=Ubuntu 20.04 and Kubernetes v1.21.8+vmware.1` then use `v1.21.8-crs` flavor. | ||
|
|
||
| - It is strongly recommended to use `v1.y.z-crs` flavors to ensure CNI, CPI and CSI are automatically installed on the | ||
| workload clusters. CNI and CPI are required add-ons for the cluster creation to be successful. |