README.md

azurefile CSI driver for Kubernetes

About

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

Project Status

Status: Beta

Container Images & CSI Compatibility:

Azure File CSI Driver Version	Image	v1.0.0
master branch	mcr.microsoft.com/k8s/csi/azurefile-csi:latest	yes
v0.3.0	mcr.microsoft.com/k8s/csi/azurefile-csi:v0.3.0	yes
v0.2.0	mcr.microsoft.com/k8s/csi/azurefile-csi:v0.2.0	yes

Kubernetes Compatibility

Azure File CSI Driver\Kubernetes Version	1.13+
master branch	yes
v0.3.0	yes
v0.2.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 initialization depends on a Cloud provider config file, usually it's /etc/kubernetes/azure.json on all kubernetes nodes deployed by AKS or aks-engine, here is an azure.json example

if cluster is based on Managed Service Identity(MSI), make sure all agent nodes have Contributor role for current resource group

Install azurefile CSI driver on a kubernetes cluster

Please refer to install azurefile csi driver

Examples

• Basic usage
• Snapshot

Kubernetes Development

Please refer to development guide

Links

• Kubernetes CSI Documentation
• Analysis of the CSI Spec
• CSI Drivers
• Container Storage Interface (CSI) Specification