Skip to content

Latest commit

 

History

History
77 lines (61 loc) · 7.69 KB

driver-parameters.md

File metadata and controls

77 lines (61 loc) · 7.69 KB
Raw

Driver Parameters

disk.csi.azure.com driver parameters

Dynamic Provisioning

V1 Parameters

get an example

Name Meaning Available Value Mandatory Default value
skuName azure disk storage account type (alias: storageAccountType) Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS No StandardSSD_LRS
kind managed or unmanaged(blob based) disk managed (dedicated, shared are deprecated) No managed
fsType File System Type ext4, ext3, ext2, xfs, btrfs on Linux, ntfs on Windows No ext4 on Linux, ntfs on Windows
cachingMode Azure Data Disk Host Cache Setting None, ReadOnly, ReadWrite(ReadWrite caching mode is deprecated) No ReadOnly
location specify Azure location in which Azure disk will be created eastus, westus, etc. No if empty, driver will use the same location name as current k8s cluster
resourceGroup specify the resource group in which azure disk will be created existing resource group name No if empty, driver will use the same resource group name as current k8s cluster
DiskIOPSReadWrite UltraSSD disk IOPS Capability (minimum: 2 IOPS/GiB ) 100~160000 No 500
DiskMBpsReadWrite UltraSSD disk Throughput Capability(minimum: 0.032/GiB) 1~2000 No 100
LogicalSectorSize Logical sector size in bytes for Ultra disk. Supported values are 512 ad 4096. 4096 is the default. 512, 4096 No 4096
tags azure disk tags tag format: key1=val1,key2=val2 No ""
diskEncryptionSetID ResourceId of the disk encryption set to use for enabling encryption at rest format: /subscriptions/{subs-id}/resourceGroups/{rg-name}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSet-name} No ""
diskEncryptionType encryption type of the disk encryption set EncryptionAtRestWithCustomerKey(by default), EncryptionAtRestWithPlatformAndCustomerKeys No ""
writeAcceleratorEnabled Write Accelerator on Azure Disks true, false No ""
perfProfile Block device performance tuning using perfProfiles none, basic No none
networkAccessPolicy NetworkAccessPolicy property to prevent anybody from generating the SAS URI for a disk or a snapshot AllowAll, DenyAll, AllowPrivate No AllowAll
diskAccessID ARM id of the DiskAccess resource for using private endpoints on disks No ``
enableBursting enable on-demand bursting beyond the provisioned performance target of the disk. On-demand bursting only be applied to Premium disk, disk size > 512GB, Ultra & shared disk is not supported. Bursting is disabled by default. true, false No false
useragent User agent used for customer usage attribution No Generated Useragent formatted driverName/driverVersion compiler/version (OS-ARCH)
enableAsyncAttach allow multiple disk attach operations (in batch) on one node in parallel, this could speed up disk attachment while may hit Azure API throttling when there are large number of volume attachments true, false No false
subscriptionID specify Azure subscription ID in which Azure disk will be created Azure subscription ID No if not empty, resourceGroup must be provided
  • disk created by dynamic provisioning

    • disk name format (example): pvc-e132d37f-9e8f-434a-b599-15a4ab211b39

    • tags format (example):

      k8s-azure-created-by: kubernetes-azure-dd
kubernetes.io-created-for-pv-name: pvc-e132d37f-9e8f-434a-b599-15a4ab211b39
kubernetes.io-created-for-pvc-name: pvc-azuredisk
kubernetes.io-created-for-pvc-namespace: default

New or Updated Parameters for V2

In addition to the parameters supported by the V1 driver, Azure Disk CSI driver V2 adds or modifies the following parameters:

Name Meaning Available Value Mandatory Default value
perfProfile Block device performance tuning using perfProfiles none, basic, advanced No none
enableAsyncAttach The V2 driver uses a different strategy to manage Azure API throttling and ignores this parameter. N/A No N/A
maxShares The total number of shared disk mounts allowed for the disk. Setting the value to 2 or more enables attachment replicas. Supported values depend on the disk size. See Share an Azure managed disk for supported values. No 1
maxMountReplicaCount The number of replicas attachments to maintain. This value must be in the range [0..(maxShares - 1)] No If accessMode is ReadWriteMany, the default is 0. Otherwise, the default is maxShares - 1

NOTE: Setting the maxShares parameter to a value greater than 1 enables faster pod failover through attachment replicas. See the Azure CSI Driver V2 document for more details. See the failover demo for an example of how to use attachment replicas and ZRS disks for a better pod failover experience.

Static Provisioning (bring your own Azure Disk)

get an example

Name Meaning Available Value Mandatory Default value
volumeHandle Azure disk URI /subscriptions/{sub-id}/resourcegroups/{group-name}/providers/microsoft.compute/disks/{disk-id} Yes N/A
volumeAttributes.fsType File System Type ext4, ext3, ext2, xfs, btrfs on Linux, ntfs on Windows No ext4 on Linux, ntfs on Windows
volumeAttributes.partition partition num of the existing disk (only supported on Linux) 1, 2, 3 No empty(no partition)
- make sure partition format is like -part1
volumeAttributes.cachingMode disk host cache setting None, ReadOnly, ReadWrite No ReadOnly

VolumeSnapshotClass

Name Meaning Available Value Mandatory Default value
resourceGroup resource group for storing snapshot shots EXISTING RESOURCE GROUP No If not specified, snapshot will be stored in the same resource group as source Azure disk
incremental take full or incremental snapshot true, false No true
tags azure disk tags tag format: 'key1=val1,key2=val2' No ""
userAgent User agent used for customer usage attribution No Generated Useragent formatted driverName/driverVersion compiler/version (OS-ARCH)
subscriptionID specify Azure subscription ID in which Azure disk will be created Azure subscription ID No if not empty, resourceGroup must be provided, incremental must set as false