From 1f2d35c71cb4596b9fa074856e7c95e4e0e31158 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Wed, 3 Mar 2021 18:23:17 -0700 Subject: [PATCH] Revise vSphere cloud provider docs --- .../volumes-and-storage/_index.md | 6 +++++ .../cloud-providers/vsphere/_index.md | 21 +++++----------- .../cloud-providers/vsphere/in-tree/_index.md | 24 +++++++++++++++++++ .../vsphere/out-of-tree}/_index.md | 13 ++++++---- .../vsphere-volume-migration/_index.md | 7 +++--- .../node-pools/vsphere/migration/_index.md | 9 ------- .../vsphere/out-of-tree-vsphere/_index.md | 9 ------- 7 files changed, 49 insertions(+), 40 deletions(-) create mode 100644 content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/_index.md rename content/rancher/v2.5/en/{cluster-admin/volumes-and-storage/out-of-tree-vsphere => cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree}/_index.md (80%) rename content/rancher/v2.5/en/{cluster-admin/volumes-and-storage => cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree}/vsphere-volume-migration/_index.md (93%) delete mode 100644 content/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/migration/_index.md delete mode 100644 content/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/out-of-tree-vsphere/_index.md diff --git a/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/_index.md b/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/_index.md index 917806e2f1c..ad6328fbaac 100644 --- a/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/_index.md +++ b/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/_index.md @@ -66,6 +66,12 @@ In [Rancher Launched Kubernetes clusters]({{}}/rancher/v2.5/en/cluster- ### hostPath Volumes Before you create a hostPath volume, you need to set up an [extra_bind]({{}}/rke/latest/en/config-options/services/services-extras/#extra-binds/) in your cluster configuration. This will mount the path as a volume in your kubelets, which can then be used for hostPath volumes in your workloads. +### Migrating vSphere Cloud Provider from In-tree to Out-of-tree + +Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins. + +For instructions on how to migrate from the in-tree vSphere cloud provider to out-of-tree, and manage the existing VMs post migration, refer to [this page.]({{}}/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree) + ### Related Links - [Kubernetes Documentation: Storage](https://kubernetes.io/docs/concepts/storage/) diff --git a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/_index.md b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/_index.md index 157b05af7b2..8d46f780f8f 100644 --- a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/_index.md +++ b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/_index.md @@ -3,23 +3,14 @@ title: Setting up the vSphere Cloud Provider weight: 4 --- -In this section, you'll learn how to set up the vSphere cloud provider for a Rancher managed RKE Kubernetes cluster in vSphere. +In this section, you'll learn how to set up a vSphere cloud provider for a Rancher managed RKE Kubernetes cluster in vSphere. -Follow these steps while creating the vSphere cluster in Rancher: +# In-tree Cloud Provider -1. Set **Cloud Provider** option to `Custom`. +To use the in-tree vSphere cloud provider, you will need to use an RKE configuration option. For details, refer to [this page.](./in-tree) - {{< img "/img/rancher/vsphere-node-driver-cloudprovider.png" "vsphere-node-driver-cloudprovider">}} +# Out-of-tree Cloud Provider -1. Click on **Edit as YAML** -1. Insert the following structure to the pre-populated cluster YAML. This structure must be placed under `rancher_kubernetes_engine_config`. Note that the `name` *must* be set to `vsphere`. +_Available as of v2.5.6_ - ```yaml - rancher_kubernetes_engine_config: - cloud_provider: - name: vsphere - vsphereCloudProvider: - [Insert provider configuration] - ``` - -Rancher uses RKE (the Rancher Kubernetes Engine) to provision Kubernetes clusters. Refer to the [vSphere configuration reference in the RKE documentation]({{}}/rke/latest/en/config-options/cloud-providers/vsphere/config-reference/) for details about the properties of the `vsphereCloudProvider` directive. \ No newline at end of file +To set up the out-of-tree vSphere cloud provider, you will need to install Helm charts from the Rancher marketplace. For details, refer to [this page.](./out-of-tree) diff --git a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/_index.md b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/_index.md new file mode 100644 index 00000000000..931b5c3d57f --- /dev/null +++ b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/in-tree/_index.md @@ -0,0 +1,24 @@ +--- +title: How to Configure In-tree vSphere +shortTitle: In-tree Cloud Provider +weight: 10 +--- + +To set up the out-of-tree vSphere cloud provider, follow these steps while creating the vSphere cluster in Rancher: + +1. Set **Cloud Provider** option to `Custom`. + + {{< img "/img/rancher/vsphere-node-driver-cloudprovider.png" "vsphere-node-driver-cloudprovider">}} + +1. Click on **Edit as YAML** +1. Insert the following structure to the pre-populated cluster YAML. This structure must be placed under `rancher_kubernetes_engine_config`. Note that the `name` *must* be set to `vsphere`. + + ```yaml + rancher_kubernetes_engine_config: + cloud_provider: + name: vsphere + vsphereCloudProvider: + [Insert provider configuration] + ``` + +Rancher uses RKE (the Rancher Kubernetes Engine) to provision Kubernetes clusters. Refer to the [vSphere configuration reference in the RKE documentation]({{}}/rke/latest/en/config-options/cloud-providers/vsphere/config-reference/) for details about the properties of the `vsphereCloudProvider` directive. \ No newline at end of file diff --git a/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/out-of-tree-vsphere/_index.md b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/_index.md similarity index 80% rename from content/rancher/v2.5/en/cluster-admin/volumes-and-storage/out-of-tree-vsphere/_index.md rename to content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/_index.md index c3f593e6549..f2a0f7a9893 100644 --- a/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/out-of-tree-vsphere/_index.md +++ b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/_index.md @@ -1,5 +1,6 @@ --- -title: vSphere Out-of-tree Cloud Provider +title: How to Configure Out-of-tree vSphere +shortTitle: Out-of-tree Cloud Provider weight: 10 --- _Available as of v2.5.6_ @@ -10,7 +11,11 @@ This page covers how to install the CPI and CSI plugins after bringing up a clus # Prerequisites -The vSphere version must be 6.7U3 or higher. +The vSphere version must be 7.0u1 or higher. + +The Kubernetes version must be 1.19 or higher. + +Using the vSphere out-of-tree cloud provider requires Linux nodes and is not supported on Windows. # Installation @@ -25,7 +30,7 @@ The Cloud Provider Interface (CPI) should be installed first before installing t ### 2. Install the CPI plugin 1. From the **Cluster Explorer** view, go to the top left dropdown menu and click **Apps & Marketplace.** -1. Select the **vsphere-cpi** chart from the **helm3-library** catalog. Fill out the required vCenter details. +1. Select the **vsphere-cpi** chart. Fill out the required vCenter details. 1. vSphere CPI initializes all nodes with ProviderID which is needed by the vSphere CSI driver. Check if all nodes are initialized with the ProviderID before installing CSI driver with the following command: ``` @@ -35,7 +40,7 @@ The Cloud Provider Interface (CPI) should be installed first before installing t ### 3. Installing the CSI plugin 1. From the **Cluster Explorer** view, go to the top left dropdown menu and click **Apps & Marketplace.** -1. Select the **vsphere-csi** chart from the **helm3-library** catalog. Fill out the required vCenter details. +1. Select the **vsphere-csi** chart. Fill out the required vCenter details. 2. Set **Enable CSI Migration** to **false**. 3. This chart creates a StorageClass with the `csi.vsphere.vmware.com` as the provisioner. Fill out the details for the StorageClass and launch the chart. diff --git a/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/vsphere-volume-migration/_index.md b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md similarity index 93% rename from content/rancher/v2.5/en/cluster-admin/volumes-and-storage/vsphere-volume-migration/_index.md rename to content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md index e024e44a252..c98d1b81e12 100644 --- a/content/rancher/v2.5/en/cluster-admin/volumes-and-storage/vsphere-volume-migration/_index.md +++ b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/cloud-providers/vsphere/out-of-tree/vsphere-volume-migration/_index.md @@ -59,8 +59,8 @@ chmod +x taints.sh Once all nodes are tainted by the running the script, launch the Helm vSphere CPI chart. -1. Within a project, select **Apps > Launch.** -2. Select the **vsphere-cpi** chart from the **helm3-library** catalog. +1. From the **Cluster Explorer** view, go to the top left dropdown menu and click **Apps & Marketplace.** +2. Select the **vsphere-cpi** chart. 3. Fill out the required vCenter details and click **Launch**. vSphere CPI initializes all nodes with ProviderID, which is needed by the vSphere CSI driver. @@ -73,7 +73,8 @@ kubectl describe nodes | grep "ProviderID" ### 2. Install the CSI driver -1. Within a project, select **Apps > Launch** and select the **vsphere-csi** chart from the **helm3-library** catalog. +1. From the **Cluster Explorer** view, go to the top left dropdown menu and click **Apps & Marketplace.** +1. Select the **vsphere-csi** chart. 1. Fill out the required vCenter details and click **Launch**. 1. Set **Enable CSI Migration** to **true**. 1. This chart creates a StorageClass with the `csi.vsphere.vmware.com` as the provisioner. You can provide the URL of the datastore to be used for CSI volume provisioning while creating this StorageClass. The datastore URL can be found in the vSphere client by selecting the datastore and going to the Summary tab. Fill out the details for the StorageClass and click **Launch**. diff --git a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/migration/_index.md b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/migration/_index.md deleted file mode 100644 index ff491c7f33c..00000000000 --- a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/migration/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Migrating vSphere In-tree Volumes to CSI -weight: 5 ---- -_Available as of v2.5.6_ - -Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins. - -For instructions on how to migrate from the in-tree vSphere cloud provider to out-of-tree, and manage the existing VMs post migration, refer to [this page.]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/vsphere-volume-migration) \ No newline at end of file diff --git a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/out-of-tree-vsphere/_index.md b/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/out-of-tree-vsphere/_index.md deleted file mode 100644 index 9f85cd15c9e..00000000000 --- a/content/rancher/v2.5/en/cluster-provisioning/rke-clusters/node-pools/vsphere/out-of-tree-vsphere/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: vSphere Out-of-tree Cloud Provider -weight: 4 ---- -_Available as of v2.5.6_ - -Kubernetes is moving away from maintaining cloud providers in-tree. vSphere has an out-of-tree cloud provider that can be used by installing the vSphere cloud provider and cloud storage plugins. - -For instructions on how to install the CPI and CSI plugins after bringing up a cluster, refer to [this page.]({{}}/rancher/v2.5/en/cluster-admin/volumes-and-storage/out-of-tree-vsphere) \ No newline at end of file