azuredisk-csi-driver

README

Azure Disk CSI driver for Kubernetes

About

This driver allows Kubernetes to use Azure Disk volume, csi plugin name: disk.csi.azure.com

Project status: GA

Container Images & Kubernetes Compatibility

Driver Version	Image	supported k8s version
master branch	mcr.microsoft.com/k8s/csi/azuredisk-csi:latest	1.18+
v1.5.1	mcr.microsoft.com/k8s/csi/azuredisk-csi:v1.5.1	1.18+
v1.4.0	mcr.microsoft.com/k8s/csi/azuredisk-csi:v1.4.0	1.18+
v1.2.0	mcr.microsoft.com/k8s/csi/azuredisk-csi:v1.2.0	1.17+

Driver parameters

Please refer to disk.csi.azure.com driver parameters

storage class disk.csi.azure.com parameters are compatible with built-in azuredisk plugin

Set up CSI driver on AKS cluster (only for AKS users)

follow guide here

Prerequisite

• The driver depends on cloud provider config file, usually it's /etc/kubernetes/azure.json on all kubernetes nodes deployed by AKS or aks-engine, here is azure.json example.

To specify a different cloud provider config file, create azure-cred-file configmap before driver installation, e.g. for OpenShift, it's /etc/kubernetes/cloud.conf (make sure config file path is in the volumeMounts.mountPath)

kubectl create configmap azure-cred-file --from-literal=path="/etc/kubernetes/cloud.conf" --from-literal=path-windows="C:\\k\\cloud.conf" -n kube-system

• This driver also supports read cloud config from kuberenetes secret.
• If cluster identity is Managed Service Identity(MSI), make sure user assigned identity has Contributor role on node resource group
• Set up CSI driver on Azure RedHat OpenShift(ARO)

Install driver on a Kubernetes cluster

• install via kubectl on public Azure (please use helm for Azure Stack, RedHat/CentOS)
• install via helm charts on public Azure, Azure Stack, RedHat/CentOS

Examples

• Basic usage

Features

• Topology(Availability Zone)
  • ZRS disk support(Preview)
• Snapshot
• Volume Cloning
• Volume Expansion
• Raw Block Volume
• Windows
• Shared Disk
• Volume Limits
• fsGroupPolicy

Troubleshooting

• CSI driver troubleshooting guide

Support

• Please see our support policy

Limitations

• Please refer to Azure Disk CSI Driver Limitations

Kubernetes Development

• Please refer to development guide

View CI Results

• Check testgrid provider-azure-azuredisk-csi-driver dashboard.

Links

• Kubernetes CSI Documentation
• CSI Drivers
• Container Storage Interface (CSI) Specification