--- title: "Deploy VAST Block CSI Driver" slug: "deploy-vast-block-csi-driver-27" updated: 2026-11-04T00:00:10Z published: 2026-11-04T00:00:10Z canonical: "docs.vastdata.com/deploy-vast-block-csi-driver-27" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.vastdata.com/llms.txt > Use this file to discover all available pages before exploring further. # Deploy VAST Block CSI Driver Use one of the following methods to deploy VAST Block CSI Driver: - [Helm chart-based deployment](/develop/docs/deploy-vast-block-csi-driver-27#deploy-vast-block-csi-driver-with-a-helm-chart) - [VAST CSI Operator for Kubernetes](/develop/docs/deploy-vast-block-csi-driver-27#deploy-vast-block-csi-driver-with-vast-csi-operator-for-kubernetes) - [VAST CSI Operator for OpenShift](/develop/docs/deploy-vast-block-csi-driver-27#deploy-vast-block-csi-driver-on-openshift-with-vast-csi-operator) ## VAST Block CSI Driver Requirements Ensure that your environment meets the following requirements: - A Kubernetes cluster is up and running. - A VAST cluster is up and running. - All nodes of the Kubernetes cluster are networked with the VAST cluster and can attach VAST cluster volumes via NVMe. - At least one node can communicate with the VAST cluster management virtual IP. - A host is available with a [Helm](https://helm.sh/) client installed, preferably in the VMS network. - The `nvme-cli` package is installed on Kubernetes nodes where volumes are to be attached. ### Supported Versions VAST Block CSI Driver 2.7.x requires: - Helm 3.x.x - Kubernetes 1.25 - 1.36 - VAST Cluster 5.3 or later - To [replicate block volumes](/develop/docs/replicate-block-volumes-with-vast-csi-replication-operator-2-7): 5.5.0 or later - To [specify a VAST cluster tenant](/develop/docs/about-vast-csi-driver-2-7#support-of-vast-cluster-multitenancy-for-block-storage) on which to provision storage: 5.3.3 or later ### Required Permissions VAST Block CSI Driver requires root (sysadmin) privileges. ## Deploy VAST Block CSI Driver with a Helm Chart Before you begin, ensure that your environment meets the [requirements](/develop/docs/deploy-vast-block-csi-driver-27#vast-block-csi-driver-requirements). The following procedure uses a [Helm](https://helm.sh) chart to deploy the driver. A *Helm chart* is an installation template that can be reused to install multiple instances of the software being deployed. Each instance is referred to as a *release*. Helm charts are available from *Helm repositories*. Steps to deploy VAST Block CSI Driver include: 1. [Install](/develop/docs/deploy-vast-block-csi-driver-27#install-crds-for-vast-snapshots) Custom Resource Definitions for snapshots. > **Note:** This step is required if the driver's Helm chart configuration file (`values.yaml`) has `secretName` and `Endpoint` specified as global options (on top of `values.yaml`). This step is optional only when `secretName` and `secretNamespace` are specified within one or more storage classes (or under `storageClassDefaults`). 2. (Optional) [Create](/develop/docs/deploy-vast-block-csi-driver-27#create-kubernetes-namespace-for-vast-block-csi-driver) a Kubernetes namespace for VAST Block CSI Driver. > **Note:** This step is required if you are going to deploy VAST Block CSI Driver in a Kubernetes namespace other than `default`. Otherwise, skip to step 2. 3. [Configure](/develop/docs/deploy-vast-block-csi-driver-27#configure-vast-cluster-for-vast-block-csi-driver) the VAST cluster. 4. [Create](/develop/docs/deploy-vast-block-csi-driver-27#create-kubernetes-secret-for-vast-block-csi-driver) a Kubernetes secret with VMS user credentials or API token for VAST Block CSI Driver. 5. [Add](/develop/docs/deploy-vast-block-csi-driver-27#add-helm-repository-for-vast-block-csi-driver) the Helm repository that contains the VAST Block CSI Driver chart. 6. [Create](/develop/docs/deploy-vast-block-csi-driver-27#create-helm-chart-configuration-file-for-vast-block-csi-driver) a Helm chart configuration file for VAST Block CSI Driver. 7. [Install](/develop/docs/deploy-vast-block-csi-driver-27#install-vast-block-csi-driver-helm-chart) the Helm chart for VAST Block CSI Driver. ### Install CRDs for VAST Snapshots CRDs for VAST snapshots are a prerequisite for using VAST snapshots. The CRDs are required if your deployment includes one or more snapshot classes. The driver's logic for creating snapshot classes varies depending on whether you specify the Kubernetes secret as a global or a storage class-specific option: - If the driver's Helm chart configuration file (`values.yaml`) has `secretName` and `Endpoint` specified as global options (on top of `values.yaml`), the driver follows legacy logic and creates one snapshot class named `vastdata-snapshot` to be used for all PVCs. This configuration requires that you install the CRDs for VAST snapshots during driver deployment. - When `secretName` and `secretNamespace` are specified within one or more storage classes (or under `storageClassDefaults`), the driver creates snapshot classes only when they are defined explicitly. This means that in this case, you need to install the CRDs for VAST snapshots only when you have an explicit `snapshotClass` definition in place. Run the following commands to install the CRDs for snapshots: ``` kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/v7.0.1/client/config/crd/snapshot.storage.k8s.io_volumesnapshotclasses.yaml kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/v7.0.1/client/config/crd/snapshot.storage.k8s.io_volumesnapshotcontents.yaml kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/v7.0.1/client/config/crd/snapshot.storage.k8s.io_volumesnapshots.yaml kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/v7.0.1/deploy/kubernetes/snapshot-controller/rbac-snapshot-controller.yaml kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/v7.0.1/deploy/kubernetes/snapshot-controller/setup-snapshot-controller.yaml ``` ### Create Kubernetes Namespace for VAST Block CSI Driver By default, VAST Block CSI Driver is deployed to the `default` namespace on the Kubernetes cluster. If you want to use a different Kubernetes namespace for VAST Block CSI Driver, create it prior to deployment by running the following command: ``` kubectl create ns ``` ### Configure VAST Cluster for VAST Block CSI Driver Complete the following steps to make your VAST cluster ready for integration with Kubernetes: - (Optionally) With VAST Cluster 5.3.3 or later, if you are going to [provision](/develop/docs/about-vast-csi-driver-2-7#support-of-vast-cluster-multitenancy-for-block-storage) storage on a particular VAST tenant, [create](/develop/docs/deploy-vast-block-csi-driver-27#create-tenant-for-dynamic-volume-provisioning) a tenant that will host the block volumes. - [Create](/develop/docs/deploy-vast-block-csi-driver-27#create-view-for-block-volumes) a VAST cluster view that VAST Block CSI Driver will use to provision block volumes. - [Set up](/develop/docs/deploy-vast-block-csi-driver-27#set-up-virtual-ip-pools) virtual IP pools to be used by VAST Block CSI Driver. - [Set up](/develop/docs/deploy-vast-block-csi-driver-27#set-up-vms-user) a VMS user to be used by VAST Block CSI Driver. - (Optional) [Upload](/develop/docs/deploy-vast-block-csi-driver-27#upload-casigned-ssl-certificate-to-vast-cluster) your CA-signed SSL certificate to the VAST cluster. - (Optional): [Configure](/develop/docs/deploy-vast-block-csi-driver-27#configure-qos-policy) a QoS policy to be associated with views created by VAST Block CSI Driver. #### Create Tenant for Dynamic Volume Provisioning If you run the driver with VAST Cluster 5.3.3 or later, it is recommended to set up a dedicated VAST cluster tenant for dynamic volume provisioning to allow for control plane isolation of privileges that would prevent the service account used by the driver from acting outside the scope of dynamic provisioning. For more information about support of multiple VAST tenants by the driver, see [Support of VAST Cluster Multi-Tenancy for Block Storage](/develop/docs/about-vast-block-csi-driver-2-7#support-of-vast-cluster-multitenancy-for-block-storage). To create a tenant in VAST Web UI, log in and choose **Element Store** -> **Tenants** in the main navigation menu. Click **Create Tenant** and follow the tenant creation guidelines in *VAST Cluster Administrator's Guide*. #### Create View for Block Volumes Create a view that will expose the NVMe subsystem that VAST Block CSI Driver will use to to provision block volumes. The view must have the block storage protocol enabled and the NVMe subsystem defined. With VAST Cluster 5.3.3 or later, if you've created a dedicated tenant for dynamic volume provisioning, ensure that the view belongs to the dedicated tenant. To view and manage views in VAST Web UI, log in and choose **Element Store** -> **Views** in the main navigation menu. For more information about VAST cluster views, see *VAST Cluster Administrator's Guide*. #### Set Up Virtual IP Pools VAST Block CSI Driver distributes the load among virtual IPs in one or more VAST virtual IP pools. You specify a virtual IP pool in the [storageClass](/develop/docs/provision-block-storage-with-vast-block-csi-driver-2-7#create-block-storage-classes) definition. The virtual IP pool specified for a storage class is used to process read and write operations requested by the application that is using that particular class. Ensure that the virtual IP pool set for a storage class belongs to the same VAST cluster tenant as the view that exposes the NVMe subsystem specified for that storage class. In the driver's Helm chart configuration file, the virtual IP pool can be specified by its name (`vipPool`) or FQDN (`vipPoolFQDN`). If you are going to use the FQDN, ensure that the VAST cluster has DNS configured, and the virtual IP pool has *Virtual IP Pool Domain Name* defined in its settings. To view and manage virtual IP pools in VAST Web UI, log in and choose **Network Access** -> **Virtual IP Pools** in the main navigation menu. For more information about VAST cluster virtual IP pools, see *VAST Cluster Administrator's Guide*. #### Set Up VMS User Set up a VMS user for VAST Block CSI Driver to communicate with the VAST Management Service (VMS) via VAST REST API. Before you start, decide on the following: - *Cluster Admin* or *Tenant Admin* The VMS user can be either a *Cluster Admin* or a *Tenant Admin*. - If you are going to provision block volumes on the cluster's default VAST tenant, the VMS user must be be a *Cluster Admin*. - To provision buckets on a non-default tenant, the user must be a *Tenant Admin* for that tenant. - Authenticate with username/password or API token If you are going to [use](/develop/docs/deploy-vast-block-csi-driver-27#create-secret-with-vms-api-token-recommended) VMS API tokens for authentication of the connection between the driver and the VAST cluster, ensure that the VMS user has one or more API tokens generated. To set up a VMS user for VAST Block CSI Driver: 1. Create a new role (in VAST Web UI: **Administrators** -> **Roles** -> **Create Role**) that grants the **Create**, **View**, **Edit** and **Delete** permissions in the **Logical** realm. > **Note:** Do not use the `csi` role provided with the cluster. 2. Create a new VMS manager user for VAST CSI Driver (in VAST Web UI: **Administrators** -> **Managers** -> **Create Manager**) and assign the newly created role to this user. > **Note:** Alternatively, assign the newly created role to the `admin` user provided with the cluster. With VAST Cluster 5.3.3 or later, if you are going to [provision](/develop/docs/about-vast-block-csi-driver-2-7#support-of-vast-cluster-multitenancy-for-block-storage) storage on a particular VAST tenant, set the **User type** to **Tenant Admin** and select the desired tenant from the dropdown list. This is the tenant you'll need to specify in the driver's Kubernetes secret. 3. If you want to have the user authenticated with a VMS API token instead of a password, generate the token as follows: - If the user is a *Cluster Admin*, run the `apitoken create` command of VAST CLI. - If the user is a *Tenant Admin*, with VAST Cluster 5.3.3 or later: 1. Install `vastpy` and `vastpy-cli` tools with the following command (which installs both tools): ``` pip install vastpy ``` 2. Run the following command to generate the VMS API token: ``` vastpy-cli --user \ --password '' \ --tenant-name   \ post apitokens owner= name= ``` For example: ``` vastpy-cli --user admina \ --password 'P@ssw0rd' \ --tenant-name ten-a \ post apitokens owner=admina name=new‑token9898 ``` #### Upload CA-Signed SSL Certificate to VAST Cluster If you want to use a Certificate Authority-signed SSL certificate to secure the connection to the VAST cluster, follow the SSL certificate upload procedure in the *VAST Cluster Administrator's Guide* to upload your SSL certificate to the VAST cluster. For more information about configuring SSL encryption for VAST Block CSI Driver, see [Configuring SSL Encryption for VAST Block CSI Driver](/develop/docs/deploy-vast-block-csi-driver-27#configure-ssl-encryption-for-vast-block-csi-driver). #### Configure QoS Policy You can optionally set up a Quality of Service (QoS) policy to be associated with the views that VAST Block CSI Driver creates. A QoS policy is specified per Kubernetes storage class configured for the VAST driver. > **Note:** This capability requires VAST Cluster 5.4 or later. To view and manage QoS policies via VAST Web UI, log in and choose **Element Store** -> **QoS Policies**. For more information about VAST cluster QoS policies, see *VAST Cluster Administrator's Guide*. ### Create Kubernetes Secret for VAST Block CSI Driver Create a Kubernetes [secret](https://kubernetes.io/docs/concepts/configuration/secret/) to keep [VMS user](/develop/docs/deploy-vast-block-csi-driver-27#set-up-vms-user) credentials or API token that VAST Block CSI Driver uses to communicate with the VAST cluster. You need to supply the name of the secret when [creating](/develop/docs/deploy-vast-block-csi-driver-27#create-helm-chart-configuration-file-for-vast-block-csi-driver) the driver's Helm chart configuration file. If the Kubernetes secret is specified as a global setting in the driver's Helm chart configuration file, it will be used for all storage classes defined for the driver. If it is specified within a storage class definition, it applies to the storage class only (and overrides the global secret, if it exists). You can create one or more Kubernetes secrets that can be specified individually per storage class or snapshot class. Each of these Kubernetes secrets specifies the VAST cluster to connect to and the VMS user credentials or API token, enabling you to [provision](/develop/docs/provision-block-storage-with-vast-block-csi-driver-2-7#provision-block-volumes-on-multiple-vast-clusters) volumes on multiple VAST clusters or using multiple VMS users on the same VAST cluster. > **Tip:** The secret can be used not only when there are multiple VAST clusters, but also anytime when the `secretName` and `secretNamespace` parameters in the Helm chart configuration file (`values.yaml`) are specified within a storage class or under `storageClassDefaults`. Do either of the following: - [Create](/develop/docs/deploy-vast-block-csi-driver-27#create-secret-with-vms-api-token-recommended) a secret with a VMS API token (recommended), or - [Create](/develop/docs/deploy-vast-block-csi-driver-27#create-secret-with-vms-user-credentials) a secret with VMS user credentials Using VMS API tokens is recommended over supplying VMS user credentials. #### Create Secret with VMS API Token (Recommended) > **Note:** VMS API tokens are supported with VAST Cluster 5.3 or later. To create a Kubernetes secret with the VMS user's API token: 1. Create a YAML file with the following content: ``` apiVersion: v1 kind: Secret metadata: name: type: Opaque data: endpoint: tenant: token: : : <...> ``` Where: - (Required) `name` is the name of the Kubernetes secret. - (Required) `endpoint` sets the hostname FQDN or IP address of the VMS URL of the VAST cluster where you want to provision block volumes. - (Optional) `tenant` lets you connect to a particular [VAST cluster tenant](/develop/docs/about-vast-block-csi-driver-2-7#support-of-vast-cluster-multitenancy-for-block-storage). Supplying a tenant requires that the VMS user has a user type of *Tenant Admin* for the specified tenant (in VAST Web UI: **Administrators** -> **Managers** -> open manager details -> **User type**: **Tenant Admin**). - (Required) `token` is the VMS API token of the VMS user to connect to the VAST cluster. The token must be Base64-encoded. - `<optional parameters>` are per [Optional Parameters in Kubernetes Secret](/develop/docs/deploy-vast-block-csi-driver-27#optional-parameters-in-kubernetes-secret). 2. Apply the YAML file: ``` kubectl apply -f ``` > **Note:** If you are creating the secret in a namespace that is different from the namespace used to install the driver's Helm chart, specify the secret's namespace on the command: `-n <secret's namespace>`. Alternatively, you can create a secret with the following command: ``` kubectl create secret generic \ --from-literal=endpoint='vms.example.com' \ --from-literal=tenant='' \ --from-literal=token='' \ --{from-literal|from-file}=='' --{from-literal|from-file}=='' --<...> -n ``` For example: ``` kubectl create secret generic vast-mgmt \ --from-literal=endpoint='vms.example.com' \ --from-literal=tenant='Operations' \ --from-literal=token='xxxxxxxxxххххххххххххххххххххххххххххххх' \ --from-file=ssl_cert='VastCerts/RootCA.crt' \ -n secret_namespace ``` #### Create Secret with VMS User Credentials To create a Kubernetes secret with VMS user credentials: 1. Create a YAML file with the following content: ``` apiVersion: v1 kind: Secret metadata: name: type: Opaque data: endpoint: tenant: username: password: : : <...> ``` Where: - (Required) `name` is the name of the Kubernetes secret. - (Required) `endpoint` sets the hostname FQDN or IP address of the VMS URL of the VAST cluster where you want to provision block volumes. - (Optional) `tenant` lets you connect to a particular VAST cluster tenant. Supplying a tenant requires that the VMS user has a user type of *Tenant Admin* for the specified tenant (in VAST Web UI: **Administrators** -> **Managers** -> open manager details -> **User type**: **Tenant Admin**). - (Required) `username` is the username of the VMS user to connect to the VAST cluster. The username must be Base64-encoded. - (Required) `password` is the password for the VMS user connecting to the VAST cluster. The password must be Base64-encoded. - `<optional parameters>` are per [Optional Parameters in Kubernetes Secret](/develop/docs/deploy-vast-block-csi-driver-27#optional-parameters-in-kubernetes-secret). 2. Apply the YAML file: ``` kubectl apply -f ``` > **Note:** If you are creating the secret in a namespace that is different from the namespace used to install the driver's Helm chart, specify the secret's namespace on the command: `-n <secret's namespace>`. Alternatively, you can create a secret with the following command: ``` kubectl create secret generic \ --from-literal=endpoint='vms.example.com' \ --from-literal=tenant='' \ --from-literal=username='' \ --from-literal=password='' \ --{from-literal|from-file}=='' --{from-literal|from-file}=='' --<...> -n ``` For example: ``` kubectl create secret generic vast-mgmt \ --from-literal=endpoint='vms.example.com' \ --from-literal=tenant='Operations' \ --from-literal=username='user1' \ --from-literal=password='xxxxxxxxx' \ --from-file=ssl_cert='VastCerts/RootCA.crt' \ -n secret_namespace ``` #### Optional Parameters in Kubernetes Secret - `sslCert` The `sslCert` parameter is only required if you are using [SSL encryption](/develop/docs/deploy-vast-block-csi-driver-27#configure-ssl-encryption-for-vast-block-csi-driver) with a self-signed SSL certificate. It specifies the path to the SSL certificate. YAML syntax: ``` sslCert: ``` `kubectl` syntax: ``` ssl_cert='' ``` - `passphrase` The `passphrase` parameter enables [LUKS-based host encryption](/develop/docs/deploy-vast-block-csi-driver-27#enable-host-encryption-with-vast-block-csi-driver) and sets the LUKS passphrase to be used to encrypt and decrypt the block device. YAML syntax: ``` passphrase: ``` `kubectl` syntax: ``` passphrase='' ``` ### Add Helm Repository for VAST Block CSI Driver Add the Helm repository that contains the VAST Block CSI Driver Helm chart to the list of available repositories: 1. Add the Helm repository for VAST Block CSI Driver: ``` helm repo add https://vast-data.github.io/vast-csi ``` Specify any suitable name for `repo`. This name will be used to refer to the VAST Block CSI Driver repository when running Helm commands. For example: *vastblock* 2. Verify that the repository has been added: ``` helm repo list ``` The output is similar to the following: ``` NAME URL vastblock https://vast-data.github.io/vast-csi ``` ### Create Helm Chart Configuration File for VAST Block CSI Driver The VAST Block CSI Driver's Helm chart configuration file lets you override default installation settings provided in the chart with parameters that are specific to your environment. The configuration file is a YAML file typically named `values.yaml`, although you can use any arbitrary name for it. - [Create](/develop/docs/deploy-vast-block-csi-driver-27#create-configuration-file) a configuration file. - [Verify](/develop/docs/deploy-vast-block-csi-driver-27#verify-configuration-file) the configuration file. #### Create Configuration File Create a YAML file as follows (see also the example below): > **Note:** For a detailed reference for parameters and values, see [here](https://github.com/vast-data/vast-csi/blob/v2.7/charts/vastblock/values.yaml). ``` secretName: "" verifySsl: true|false sslCertsSecretName: "" storageClassDefaults: