Install an appropriate version of the vSphere Container Storage Plug-in in your native Kubernetes environment. After you install the plug-in, you can verify whether the installation is successful.

To deploy your Kubernetes cluster with topology, see Topology-Aware Volume Provisioning.
Note:

As a part of Kubernetes project image registry migration, the images of the vSphere Container Storage Plug-in are now hosted on the community-owned registry.k8s.io registry. These images are no longer available on the previous gcr.io/cloud-provider-vsphere/csi/release registry.

If your clusters or manifests have any dependencies on old image registry, make sure to update them with the new registry.k8s.io endpoint. Update your manifests to point to the following:

Release 3.3
v3.3.1 images
  • registry.k8s.io/csi-vsphere/driver:v3.3.1
  • registry.k8s.io/csi-vsphere/syncer:v3.3.1
v3.3.0 images
  • registry.k8s.io/csi-vsphere/driver:v3.3.0
  • registry.k8s.io/csi-vsphere/syncer:v3.3.0
Release 3.2
v3.2.0 images
  • registry.k8s.io/csi-vsphere/driver:v3.2.0
  • registry.k8s.io/csi-vsphere/syncer:v3.2.0
Release 3.1
v3.1.2 images
  • registry.k8s.io/csi-vsphere/driver:v3.1.2
  • registry.k8s.io/csi-vsphere/syncer:v3.1.2

Prerequisites

Check which Kubernetes version corresponds to a specific version of the vSphere Container Storage Plug-in. See Compatibility Matrices for vSphere Container Storage Plug-in. For information about features that different versions of the vSphere Container Storage Plug-in support, see Supported Kubernetes Functionality.

Procedure

  1. Deploy the vSphere Container Storage Plug-in.
    $ kubectl apply -f https://raw.githubusercontent.com/kubernetes-sigs/vsphere-csi-driver/v3.0.0/manifests/vanilla/vsphere-csi-driver.yaml
    Note: To be able to take advantage of the latest bug fixes and feature updates, make sure to use the most recent version of the vSphere Container Storage Plug-in. For versions and updates, see Release Notes on the VMware vSphere Container Storage Plug-in Documentation page.
    If you deploy the vSphere Container Storage Plug-in in a single control plane setup, you can edit the following field to change the number of replicas to one.
    If the driver is already deployed, use the kubectl edit command to reduce the number of replicas.
    kind: Deployment
    apiVersion: apps/v1
    metadata:
      name: vsphere-csi-controller
      namespace: vmware-system-csi
    spec:
      replicas: number_of_replicas
  2. Verify that the vSphere Container Storage Plug-in has been successfully deployed.
    1. Verify that vsphere-csi-controller instances run on the control plane node and vsphere-csi-node instances run on worker nodes of the cluster.
      $ kubectl get deployment --namespace=vmware-system-csi
      NAME                          READY   AGE
      vsphere-csi-controller        1/1     2m58s
      $ kubectl get daemonsets vsphere-csi-node --namespace=vmware-system-csi
      NAME               DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
      vsphere-csi-node   4         4         4       4            4           <none>          3m51s
    2. Verify that the vSphere Container Storage Plug-in has been registered with Kubernetes.
      $ kubectl describe csidrivers
        Name:         csi.vsphere.vmware.com
        Namespace:
        Labels:       <none>
        Annotations:  <none>
        API Version:  storage.k8s.io/v1
        Kind:         CSIDriver
        Metadata:
          Creation Timestamp:  2020-04-14T20:46:07Z
          Resource Version:    2382881
          Self Link:           /apis/storage.k8s.io/v1beta1/csidrivers/csi.vsphere.vmware.com
          UID:                 19afbecd-bc2f-4806-860f-b29e20df3074
        Spec:
          Attach Required:    true
          Pod Info On Mount:  false
          Volume Lifecycle Modes:
            Persistent
        Events:  <none>
    3. Verify that the CSINodes have been created.
      $ kubectl get CSINode
      NAME                 CREATED AT
      <k8s-worker1-name>   2020-04-14T12:30:29Z
      <k8s-worker2-name>   2020-04-14T12:30:38Z
      <k8s-worker3-name>   2020-04-14T12:30:21Z
      <k8s-worker4-name>   2020-04-14T12:30:26Z

Results

When the installation is complete, a configmap with the name "internal-feature-states.csi.vsphere.vmware.com in the vmware-system-csi namespace is installed in the Kubernetes cluster. This configmap is for internal use only and should not be modified. Any modifications to this configmap file is not supported.