rancher-partner-charts/charts/nutanix-csi-storage

Nutanix CSI Volume Driver Helm chart

Introduction

The Container Storage Interface (CSI) Volume Driver for Kubernetes leverages Nutanix Volumes and Nutanix Files to provide scalable and persistent storage for stateful applications.

When Files is used for persistent storage, applications on multiple pods can access the same storage, and also have the benefit of multi-pod read and write access.

Important notice

If you plan to update an existing Nutanix CSI deployement from 1.x to 2.x with this Chart, you need first deploy manually the CRD present here https://github.com/nutanix/csi-plugin/tree/master/deploy/Centos/crd.

Please note that starting with v2.2.0, Nutanix CSI driver has changed format of driver name from com.nutanix.csi to csi.nutanix.com. All deployment yamls uses this new driver name format. However, if you are upgrading the CSI driver then you should continue to use old driver name com.nutanix.csi by setting legacy parameter to true. If not existing PVC/PV will not work with the new driver name.

Nutanix CSI driver documentation

https://portal.nutanix.com/page/documents/details?targetId=CSI-Volume-Driver-v2_3:CSI-Volume-Driver-v2_3

Features list

• Nutanix CSI Driver v2.3.1
• Nutanix Volumes support
• Nutanix Files support
• Volume resize support ( beta in Kubernetes >= 1.16.0 )
• Volume clone ( beta Kubernetes >= 1.16.0 )
• Volume snapshot and Restore ( beta Kubernetes >= 1.17.0 )
• IP Address Whitelisting
• LVM Volume supporting multi vdisks volume group
• NFS dynamic share provisioning
• iSCSI Auto CHAP Authentication
• OS independence

Prerequisites

• Kubernetes 1.13 or later
• Kubernetes worker nodes must have the iSCSI package installed (Nutanix Volumes only)
• This chart have been validated on CentOS 7 and Ubuntu 18.04/20.04, but the new architecture enables easy portability to other distributions.

Installing the Chart

To install the chart with the name nutanix-csi:

helm repo add nutanix https://nutanix.github.io/helm/

helm install nutanix-csi nutanix/nutanix-csi-storage -n <namespace of your choice>

Uninstalling the Chart

To uninstall/delete the nutanix-csi deployment:

helm delete nutanix-csi -n <namespace of your choice>

Configuration

The following table lists the configurable parameters of the Nutanix-CSI chart and their default values.

Parameter	Description	Default
legacy	use old reverse notation for CSI driver name	false
volumeClass	Activate Nutanix Volumes Storage Class	true
fileClass	Activate Nutanix Files Storage Class	false
dynamicFileClass	Activate Nutanix Dynamic Files Storage Class	false
defaultStorageClass	Choose your default Storage Class (none, volume, file, dynfile)	none
prismEndPoint	Cluster Virtual IP Address	10.0.0.1
dataServiceEndPoint	Prism data service IP	10.0.0.2
username	name used for the admin role (if created)	admin
password	password for the admin role (if created)	nutanix/4u
secretName	name of the secret to use for admin role	ntnx-secret
createSecret	create secret for admin role (if false use existing)	true
storageContainer	Nutanix storage container name	default
fsType	type of file system you are using (ext4, xfs)	xfs
fileHost	NFS server IP address	10.0.0.3
filePath	path of the NFS share	share
fileServerName	name of the Nutanix FIle Server	file
nodeSelector	add nodeSelector to pods spec
tolerations	add tolerations to pods spec

Specify each parameter using the --set key=value[,key=value] argument to helm install or provide a a file whit -f value.yaml.

Example:

helm install nutanix-csi nutanix/nutanix-csi-storage --set prismEndPoint=X.X.X.X --set dataServiceEndPoint=Y.Y.Y.Y --set username=admin --set password=xxxxxxxxx --set storageContainer=container_name --set fsType=xfs --set defaultStorageClass=volume --set os=centos

or

helm install nutanix-csi nutanix/nutanix-csi-storage -f value.yaml