# azuredisk-csi-driver
**Repository Path**: mirrors_kubernetes-sigs/azuredisk-csi-driver
## Basic Information
- **Project Name**: azuredisk-csi-driver
- **Description**: Azure Disk CSI Driver
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2025-10-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Azure Disk CSI driver for Kubernetes
[](https://coveralls.io/github/kubernetes-sigs/azuredisk-csi-driver?branch=master)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fkubernetes-sigs%2Fazuredisk-csi-driver?ref=badge_shield)
[](https://artifacthub.io/packages/search?repo=azuredisk-csi-driver)
### About
This driver allows Kubernetes to access [Azure Disk](https://azure.microsoft.com/en-us/services/storage/disks/) volume, csi plugin name: `disk.csi.azure.com`, supported accessModes: `ReadWriteOnce`
Disclaimer: Deploying this driver manually is not an officially supported Microsoft product. For a fully managed and supported experience on Kubernetes, use [AKS with the managed Azure disk csi driver](https://learn.microsoft.com/en-us/azure/aks/azure-disk-csi).
### Project status: GA
### Container Images & Kubernetes Compatibility
|Driver Version |Image | supported k8s version |
|----------------|-----------------------------------------------------------|-----------------------|
|`master` branch |mcr.microsoft.com/k8s/csi/azuredisk-csi:latest | 1.21+ |
|v1.33.5 |mcr.microsoft.com/oss/v2/kubernetes-csi/azuredisk-csi:v1.33.5 | 1.21+ |
|v1.32.11 |mcr.microsoft.com/oss/v2/kubernetes-csi/azuredisk-csi:v1.32.11 | 1.21+ |
|v1.31.12 |mcr.microsoft.com/oss/v2/kubernetes-csi/azuredisk-csi:v1.31.12 | 1.21+ |
### Driver parameters
Please refer to [`disk.csi.azure.com` driver parameters](./docs/driver-parameters.md)
> storage class `disk.csi.azure.com` parameters are compatible with built-in [azuredisk](https://kubernetes.io/docs/concepts/storage/volumes/#azuredisk) plugin
### Prerequisite
- The driver depends on [cloud provider config file](https://github.com/kubernetes/cloud-provider-azure/blob/master/docs/cloud-provider-config.md) (here is [config example](./deploy/example/azure.json)), config file path on different platforms:
- [AKS](https://docs.microsoft.com/en-us/azure/aks/), [capz](https://github.com/kubernetes-sigs/cluster-api-provider-azure), [aks-engine](https://github.com/Azure/aks-engine): `/etc/kubernetes/azure.json`
- [Azure RedHat OpenShift](https://docs.openshift.com/container-platform/4.11/storage/container_storage_interface/persistent-storage-csi-azure.html): `/etc/kubernetes/cloud.conf`
- specify a different config file path via configmap
create configmap "azure-cred-file" before driver starts upkubectl create configmap azure-cred-file --from-literal=path="/etc/kubernetes/cloud.conf" --from-literal=path-windows="C:\\k\\cloud.conf" -n kube-system
- edge zone support in cloud provider config
`extendedLocationType` and `extendedLocationName` should be added into cloud provider config file, available values of `extendedLocationName` are `attatlanta1`, `attdallas1`, `attnewyork1`, `attdetroit1````"extendedLocationType": "edgezone","extendedLocationName": "attatlanta1",```
- Cloud provider config can also be specified via kubernetes secret, check details [here](./docs/read-from-secret.md)
- Make sure identity used by driver has `Contributor` role on node resource group
- When install open source driver on the cluster, ensure agentpool service principal or managed service identity is assigned to the `Contributor` role on the resource group used to store managed disks.
### Install driver on a Kubernetes cluster
- install by [helm charts](./charts)
- install by [kubectl](./docs/install-azuredisk-csi-driver.md)
- install open source CSI driver on following platforms:
- [AKS](./docs/install-driver-on-aks.md)
- [Azure RedHat OpenShift](https://github.com/ezYakaEagle442/aro-pub-storage/blob/master/setup-store-CSI-driver-azure-disk.md)
- install managed CSI driver on following platforms:
- [AKS](https://learn.microsoft.com/en-us/azure/aks/csi-storage-drivers)
- [Azure RedHat OpenShift](https://docs.openshift.com/container-platform/4.11/storage/container_storage_interface/persistent-storage-csi-azure.html)
### Examples
- [Basic usage](./deploy/example/e2e_usage.md)
### Features
- [Topology (Availability Zone)](./deploy/example/topology)
- [ZRS disk support](./deploy/example/topology#zrs-disk-support)
- [Snapshot](./deploy/example/snapshot)
- [Volume Cloning](./deploy/example/cloning)
- [Volume Expansion](./deploy/example/resize)
- [Raw Block Volume](./deploy/example/rawblock)
- [Windows](./deploy/example/windows)
- [Volume Limits](./deploy/example/volumelimits)
- [fsGroupPolicy](./deploy/example/fsgroup)
- [Workload identity](./docs/workload-identity.md)
- [Advanced disk performance tuning (Preview)](./docs/perf-profiles.md)
### Troubleshooting
- [CSI driver troubleshooting guide](./docs/csi-debug.md)
### Support
- Please see our [support policy][support-policy]
### Limitations
- Please refer to [Azure Disk CSI Driver Limitations](./docs/limitations.md)
## Kubernetes Development
- Please refer to [development guide](./docs/csi-dev.md)
### View CI Results
- Check testgrid [provider-azure-azuredisk-csi-driver](https://testgrid.k8s.io/provider-azure-azuredisk-csi-driver) dashboard.
### Links
- [Kubernetes CSI Documentation](https://kubernetes-csi.github.io/docs/)
- [Container Storage Interface (CSI) Specification](https://github.com/container-storage-interface/spec)
[support-policy]: support.md