README.md

Azure File CSI Driver for Kubernetes

About

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

Container Images & Kubernetes Compatibility:

Azure File CSI Driver Version	Image	1.14+
master branch	mcr.microsoft.com/k8s/csi/azurefile-csi:latest	yes
v0.7.0	mcr.microsoft.com/k8s/csi/azurefile-csi:v0.7.0	yes
v0.6.0	mcr.microsoft.com/k8s/csi/azurefile-csi:v0.6.0	yes

Driver parameters

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

storage class file.csi.azure.com parameters are compatible with built-in azurefile plugin

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

Install azurefile CSI driver on a kubernetes cluster

Please refer to install azurefile csi driver

Examples

• Basic usage

Features

• VHD disk
• Windows
• NFS

Troubleshooting

• CSI driver troubleshooting guide

Kubernetes Development

Please refer to development guide

Links

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