README
Azure Disk CSI Driver for Kubernetes
About
This driver allows Kubernetes to access Azure Disk volumes.
- CSI plugin name:
disk.csi.azure.com - Supported access mode:
ReadWriteOnce - Project status: GA
[!NOTE] 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.
Container Images & Kubernetes Compatibility
| Driver Version | Image | Supported K8s Version |
|---|---|---|
| master branch | mcr.microsoft.com/k8s/csi/azuredisk-csi:latest | 1.21+ |
| v1.34.5 | mcr.microsoft.com/oss/v2/kubernetes-csi/azuredisk-csi:v1.34.5 | 1.21+ |
| v1.33.11 | mcr.microsoft.com/oss/v2/kubernetes-csi/azuredisk-csi:v1.33.11 | 1.21+ |
| v1.32.12 | mcr.microsoft.com/oss/v2/kubernetes-csi/azuredisk-csi:v1.32.12 | 1.21+ |
Driver Parameters
Please refer to disk.csi.azure.com driver parameters.
Storage class
disk.csi.azure.comparameters are compatible with the built-in azuredisk plugin.
Prerequisites
The driver depends on a cloud provider config file (config example). Config file paths on different clusters:
| Platform | Config Path |
|---|---|
| AKS, CAPZ, aks-engine | /etc/kubernetes/azure.json |
| Azure Red Hat OpenShift | /etc/kubernetes/cloud.conf |
Specify a different config file path via ConfigMap
Create the ConfigMap azure-cred-file before the driver starts up:
kubectl 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
Add extendedLocationType and extendedLocationName to the cloud provider config file. Available values for extendedLocationName: attatlanta1, attdallas1, attnewyork1, attdetroit1.
"extendedLocationType": "edgezone",
"extendedLocationName": "attatlanta1",
- Cloud provider config can also be specified via a Kubernetes Secret — see details.
- Ensure the identity used by the driver has the
Contributorrole on the node resource group.- When installing the open source driver, ensure the agentpool service principal or managed service identity is assigned the
Contributorrole on the resource group used to store managed disks.
- When installing the open source driver, ensure the agentpool service principal or managed service identity is assigned the
Installation
Install the driver on a Kubernetes cluster:
- Install by Helm charts
- Install by kubectl
Install open source CSI driver:
| Platform | Guide |
|---|---|
| AKS | Install on AKS |
| Azure Red Hat OpenShift | Install on ARO |
Install managed CSI driver:
| Platform | Guide |
|---|---|
| AKS | AKS CSI storage drivers |
| Azure Red Hat OpenShift | ARO CSI Azure Disk |
Examples
Features
- Topology (Availability Zone)
- Snapshot
- Volume Cloning
- Volume Expansion
- Modify Volume Attributes
- Raw Block Volume
- Windows
- Volume Limits
- fsGroupPolicy
- Workload identity
- Advanced disk performance tuning (Preview)
Troubleshooting
Support
Please see our support policy.
Limitations
Please refer to Azure Disk CSI Driver Limitations.
Development
Please refer to the development guide.
CI Results
Check the TestGrid provider-azure-azuredisk-csi-driver dashboard.
Links
Contributors
(top 30 of 100)
Similar repos
Languages
Go
85.9%
Shell
10.0%
Mustache
2.9%
README
Azure Disk CSI Driver for Kubernetes
About
This driver allows Kubernetes to access Azure Disk volumes.
- CSI plugin name:
disk.csi.azure.com - Supported access mode:
ReadWriteOnce - Project status: GA
[!NOTE] 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.
Container Images & Kubernetes Compatibility
| Driver Version | Image | Supported K8s Version |
|---|---|---|
| master branch | mcr.microsoft.com/k8s/csi/azuredisk-csi:latest | 1.21+ |
| v1.34.5 | mcr.microsoft.com/oss/v2/kubernetes-csi/azuredisk-csi:v1.34.5 | 1.21+ |
| v1.33.11 | mcr.microsoft.com/oss/v2/kubernetes-csi/azuredisk-csi:v1.33.11 | 1.21+ |
| v1.32.12 | mcr.microsoft.com/oss/v2/kubernetes-csi/azuredisk-csi:v1.32.12 | 1.21+ |
Driver Parameters
Please refer to disk.csi.azure.com driver parameters.
Storage class
disk.csi.azure.comparameters are compatible with the built-in azuredisk plugin.
Prerequisites
The driver depends on a cloud provider config file (config example). Config file paths on different clusters:
| Platform | Config Path |
|---|---|
| AKS, CAPZ, aks-engine | /etc/kubernetes/azure.json |
| Azure Red Hat OpenShift | /etc/kubernetes/cloud.conf |
Specify a different config file path via ConfigMap
Create the ConfigMap azure-cred-file before the driver starts up:
kubectl 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
Add extendedLocationType and extendedLocationName to the cloud provider config file. Available values for extendedLocationName: attatlanta1, attdallas1, attnewyork1, attdetroit1.
"extendedLocationType": "edgezone",
"extendedLocationName": "attatlanta1",
- Cloud provider config can also be specified via a Kubernetes Secret — see details.
- Ensure the identity used by the driver has the
Contributorrole on the node resource group.- When installing the open source driver, ensure the agentpool service principal or managed service identity is assigned the
Contributorrole on the resource group used to store managed disks.
- When installing the open source driver, ensure the agentpool service principal or managed service identity is assigned the
Installation
Install the driver on a Kubernetes cluster:
- Install by Helm charts
- Install by kubectl
Install open source CSI driver:
| Platform | Guide |
|---|---|
| AKS | Install on AKS |
| Azure Red Hat OpenShift | Install on ARO |
Install managed CSI driver:
| Platform | Guide |
|---|---|
| AKS | AKS CSI storage drivers |
| Azure Red Hat OpenShift | ARO CSI Azure Disk |
Examples
Features
- Topology (Availability Zone)
- Snapshot
- Volume Cloning
- Volume Expansion
- Modify Volume Attributes
- Raw Block Volume
- Windows
- Volume Limits
- fsGroupPolicy
- Workload identity
- Advanced disk performance tuning (Preview)
Troubleshooting
Support
Please see our support policy.
Limitations
Please refer to Azure Disk CSI Driver Limitations.
Development
Please refer to the development guide.
CI Results
Check the TestGrid provider-azure-azuredisk-csi-driver dashboard.
Links
Similar repos
Contributors
(top 30 of 100)
Languages
Go
85.9%
Shell
10.0%
Mustache
2.9%