Volumes

  • Article

Volume objects are rank 3 and subordinate to node and nodearray. A Volume represents an Azure Disk.

Example

Adding a [[[volume]]] section to a node will create an Azure Disk and attach it to the VM.

[cluster my-cluster]
  [[node my-node]]
    Credentials = $Credentials
    SubnetId = $SubnetId
    MachineType = $MachineType
    ImageName = $ImageName

    [[[volume my-volume]]]
      Size = 500

    [[[volume another-volume]]]
      Size = 1024
      SSD = true

    [[[volume data]]]
      VolumeId = /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/my-rg/providers/Microsoft.Compute/disks/datadisk

[cluster my-cluster]
  [[node my-node]]
    Credentials = $Credentials
    SubnetId = $SubnetId
    MachineType = $MachineType
    ImageName = $ImageName

    [[[volume my-volume]]]
      Size = 500

    [[[volume another-volume]]]
      Size = 1024
      StorageAccountType = StandardSSD_LRS

    [[[volume data]]]
      VolumeId = /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/my-rg/providers/Microsoft.Compute/disks/datadisk

Attribute values that begin with $ are referencing parameters.

Attribute Reference

Attribute Type Definition
Size String (Required) Size of disk in GB
VolumeId String Resource ID for existing Azure Disk.
SSD Boolean If true, use premium disk sku. Otherwise, use standard disk. Default: false.
Azure.Lun Integer Override the auto-assigned LUN ID.
Mount String Name of mount construct, described in configuration object
Azure.Caching String [none, readonly, readwrite] Default: none.
Persistent Boolean If false, disk will be deleted when VM is deleted. Default: false.
Disabled Boolean If true, this volume will be ignored. Default: false.
SourceUri String URI of blob to import into managed disk.
StorageAccountId String Azure resource ID of storage account containing SourceUri blob. Required if blob is in a different subscription.
SourceResourceId String Azure resource ID of source snapshot or managed disk.
Attribute Type Definition
Size String (Required) Size of disk in GB
VolumeId String Resource id for existing Azure Disk.
StorageAccountType String UltraSSD_LRS, Premium_LRS, StandardSSD_LRS, Standard_LRS (Azure Disk Types) If not set, defaults to Standard_LRS or Premium_LRS depending on VM size capabilities.
DiskIOPSReadWrite Integer Provisioned IOPS see Ultra Disks
DiskMBPSReadWrite Integer Disk throughput MB/s see Ultra Disks
Azure.Lun Integer Override the auto-assigned LUN ID.
Mount String Name of mount construct, described in configuration object
Azure.Caching String None, readonly, readwrite. Default is none.
Persistent Boolean If false, disk will be deleted with vm is deleted. Default is false.
Disabled Boolean If true, this volume will be ignored. Default is false.
SourceUri String URI of blob to import into managed disk.
StorageAccountId String Azure resource ID of storage account containing SourceUri blob. Required if blob is in a different subscription.
SourceResourceId String Azure resource ID of source snapshot or managed disk.
DiskEncryptionSetId (8.5+) String Azure resource ID of the Disk Encryption Set to enable Server-Side Encryption with CMK.
ConfidentialDiskEncryptionSetId (8.5+) String Azure resource ID of the Confidential Disk Encryption Set to enable Confidential encryption with CMK. Note: requires SecurityEncryptionType=DiskWithVMGuestState. (CycleCloud 8.5+)
SecurityEncryptionType (8.5+) String One of VMGuestStateOnly (the default) or DiskWithVMGuestState.
Azure.Encryption.Type String Deprecated, has no effect. Using a Disk Encryption Set provides CMK; otherwise, PMK is in effect.
Azure.Encryption.DiskEncryptionSetId String Deprecated. Use DiskEncryptionSetId instead, as of CycleCloud 8.5.

Boot Volume

For each node, the volume named boot exposes some advanced configuration of the OS boot volume.

  [[node scheduler]]
    [[[volume boot]]]
      Size = 100
      SSD = true
      Azure.Caching = ReadOnly

Note

This section is ignored if EphemeralOSDisk is set.

For each node, the volume named boot exposes some advanced configuration of the OS boot volume. Storage type settings for the boot disk are ignored if EphemeralOSDisk=true is specified for the node.

  [[node scheduler]]
  Zone = 1
    [[[volume boot]]]
      Size = 100
      StorageAccountType = UltraSSD_LRS
      DiskIOPSReadWrite = 38400
      DiskMBPSReadWrite = 2000

Note

UltraSSD disks can only be used with availability zones (availability sets and single VM deployments outside of zones will not have the ability to attach an ultra disk).