github.com/andyzhangx/azuredisk-csi-driver@v0.7.0/README.md (about)

     1  # Azure Disk CSI driver for Kubernetes
     2  [![Coverage Status](https://coveralls.io/repos/github/kubernetes-sigs/azuredisk-csi-driver/badge.svg?branch=master)](https://coveralls.io/github/kubernetes-sigs/azuredisk-csi-driver?branch=master)
     3  [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fkubernetes-sigs%2Fazuredisk-csi-driver.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fkubernetes-sigs%2Fazuredisk-csi-driver?ref=badge_shield)
     4  
     5  ### About
     6  This driver allows Kubernetes to use [azure disk](https://azure.microsoft.com/en-us/services/storage/disks/) volume, csi plugin name: `disk.csi.azure.com`
     7  
     8  ### Container Images & CSI Compatibility:
     9  |Azure Disk CSI Driver Version  | Image                                              | v1.0.0 |
    10  |-------------------------------|----------------------------------------------------|--------|
    11  |master branch                  |mcr.microsoft.com/k8s/csi/azuredisk-csi:latest      | yes    |
    12  |v0.7.0                         |mcr.microsoft.com/k8s/csi/azuredisk-csi:v0.7.0      | yes    |
    13  |v0.6.0                         |mcr.microsoft.com/k8s/csi/azuredisk-csi:v0.6.0      | yes    |
    14  |v0.5.0                         |mcr.microsoft.com/k8s/csi/azuredisk-csi:v0.5.0      | yes    |
    15  
    16  ### Kubernetes Compatibility
    17  | Azure Disk CSI Driver\Kubernetes Version | 1.14+ |
    18  |------------------------------------------|-------|
    19  | master branch                            | yes   |
    20  | v0.7.0                                   | yes   |
    21  | v0.6.0                                   | yes   |
    22  | v0.5.0                                   | yes   |
    23  
    24  ### Driver parameters
    25  Please refer to [`disk.csi.azure.com` driver parameters](./docs/driver-parameters.md)
    26   > storage class `disk.csi.azure.com` parameters are compatible with built-in [azuredisk](https://kubernetes.io/docs/concepts/storage/volumes/#azuredisk) plugin
    27  
    28  ### Prerequisite
    29   - The driver initialization depends on a [Cloud provider config file](https://github.com/kubernetes/cloud-provider-azure/blob/master/docs/cloud-provider-config.md), usually it's `/etc/kubernetes/azure.json` on all kubernetes nodes deployed by [AKS](https://docs.microsoft.com/en-us/azure/aks/) or [aks-engine](https://github.com/Azure/aks-engine), here is [azure.json example](./deploy/example/azure.json). This driver also supports [read cloud config from kuberenetes secret](./docs/read-from-secret.md).
    30   > if cluster identity is [Managed Service Identity(MSI)](https://docs.microsoft.com/en-us/azure/aks/use-managed-identity), make sure user assigned identity has `Contributor` role on node resource group
    31  
    32  ### Install azuredisk CSI driver on a Kubernetes cluster
    33  Please refer to [install azuredisk csi driver](./docs/install-azuredisk-csi-driver.md)
    34  
    35  ### Examples
    36   - [Basic usage](./deploy/example/e2e_usage.md)
    37   - [Topology(Availability Zone)](./deploy/example/topology)
    38   - [Snapshot](./deploy/example/snapshot)
    39   - [Volume Cloning](./deploy/example/cloning)
    40   - [Volume Expansion](./deploy/example/resize) 
    41   - [Raw Block Volume](./deploy/example/rawblock)
    42   - [Windows](./deploy/example/windows)
    43   - [Shared Disk](./deploy/example/sharedisk)
    44  
    45  ## Kubernetes Development
    46  Please refer to [development guide](./docs/csi-dev.md)
    47  
    48  
    49  ### Links
    50   - [Kubernetes CSI Documentation](https://kubernetes-csi.github.io/docs/)
    51   - [Analysis of the CSI Spec](https://blog.thecodeteam.com/2017/11/03/analysis-csi-spec/)
    52   - [CSI Drivers](https://github.com/kubernetes-csi/drivers)
    53   - [Container Storage Interface (CSI) Specification](https://github.com/container-storage-interface/spec)