disk

Description

Venue	Equivalent Concept(s)
	Elastic Block Store (EBS) Volume
	Managed Disks

A block storage device.

Venue-Specific Properties

These fields are subject to change in the future. They allow for venue- specific behavior.

AWS

venue:
    aws:
        mountpoint:  The AWS DeviceName for the disk when attaching to an
                     instance, such as "/dev/sdx1".  Note that any disks
                     without this property are automatically assigned a
                     DeviceName of "/dev/sdf" - "/dev/sdz".

Required Properties

size (size)

The size of this disk. Size is specified according to IEEE 1541-2002 standards. Actual disk size in a venue will be rounded up to meet the venue's requirements. All venues use binary (base-2) sizing.

Example(s):

• 1048576

• 1 MB

• 20gb

• 5 TiB

Optional Properties

iops (integer)

Sustained IOPS of the disk. This is the performance guarantee advertised by the venue for this disk, if known. Some disk types require this property to be specified in order to be provisioned, depending on the venue.

On AWS, if type is nvme, platinum, or ultra this will select an io1 disk type that requires iops to be specified.

On Azure, if type is nvme, platinum, or ultra this will select an Ultra SSD disk type that requires iops to be specified. The I/O size for these disk types is 256 KiB.

throughput (throughput)

Sustained transfer rate of this disk. This is the performance guarantee advertised by the venue for this disk, if known. Some disk types allow this property to be specified, depending on the venue.

On Azure, if type is nvme, platinum, or ultra this will select an Ultra SSD disk type that requires throughput to be specified.

Example(s):

• 20 MiB/s

• 500mb/s

type (string)

The type of this disk. This is a generic keyword that maps to different storage types depending on the venue. The default if not specified follows best practices set by each venue.

Disk Type Mappings per Venue

Types	AWS	Azure	GCP
cold, cheap	sc1	Standard HDD	Standard
hdd, bronze	st1	Standard HDD	Standard
ssd, silver	gp2	Standard SSD	SSD
premium, gold	gp2	Premium SSD	SSD
nvme, platinum, ultra	io1	Ultra SSD	SSD

Allowed Values:

• cold

• cheap

• hdd

• bronze

• ssd

• silver

• premium

• gold

• nvme

• platinum

• ultra

The default value if not specified is ssd.

zone (integer)

The number of the Availability Zone to put the disk in. This property may be ignored by some venues, for example on Azure. On venues where this property is important it will be filled in automatically as part of attaching the disk to a consuming resource, so we recommend that you do not normally set this property.

Common Properties

count (integer)

Indicates how many of this disk should exist. When count is specified the name of the given resource will have a hyphen and numeric suffix added automatically, unless the count variable is referenced in the blueprint object name.

depends_on (⏩ any)

This property can be used to declare a dependency from this disk to any other object in the blueprint. This is not necessary for dependencies generated normally by the schema.

folder (▶ location.folder)

The folder containing this disk. If this is not specified and there is only one folder defined, that folder is used automatically.

name (string)

The name of this disk. The name can be different than the blueprint object name. When the name property is not present we apply automatic naming strategies to make resources easier to identify in each venue's management console. When the name property is specified we will use it exactly as specified.

readonly (boolean)

Indicates whether or not this disk is read-only. If so, we verify only the existence and correctness of this disk to its specification rather than creating or modifying it.

The default value if not specified is false.

tags (dict)

The tags to place on this disk. Tags are metadata stored in (key = value, ...) form. Consumers are not allowed to use tags that begin with _tuono as those are reserved.

Discovered Properties

These properties are populated and available in the inventory following a successful apply.

durability (string)

Durability characteristics of this disk. This is expressed as the type of failure that can be tolerated without loss of availability.

none

No redundancy for failures is provided.

local

Allows the data to remain available even if a storage failure occurs within a zone. Local durability is managed by the venue automatically. The durability is synchronous, meaning the loss of a component locally will not cause data loss.

zone

Allows the data to remain available even if a zone failure occurs. This disk would be made available in another zone in the same region without loss of data. Zone durability requires a specification of multiple zones that the disk is then replicated to. This durability is synchronous, meaning the loss of a zone will not cause data loss.

region

Allows the data to remain available even if a region failure occurs. Region durability requires a specification of zones in different regions. This durability is asynchronous, meaning the loss of a region may cause data loss.

Currently any disk created uses local durability.

Allowed Values:

• none

• local

• zone

• region

ephemeral (boolean)

The contents of an ephemeral disk does not survive a power cycle. Ephemeral disks are typically used for fast, local, temporary storage.

The default value if not specified is false.

id (string)

The venue-specific identifier of this disk.

os (string)

The operating system, if any, on this disk.

Allowed Values:

• linux

• windows

Examples

Define a general purpose SSD disk:

location:
  folder:
    example-folder:
      region: example-region
  region:
    example-region:
      area: west
      country: USA
storage:
  disk:
    example-ssd:
      size: 64 GiB
      type: ssd

Define a cold storage disk:

location:
  folder:
    example-folder:
      region: example-region
  region:
    example-region:
      area: west
      country: USA
storage:
  disk:
    example-cold:
      size: 128 GiB
      type: cold

Define a disk optimized for log analysis:

location:
  folder:
    example-folder:
      region: example-region
  region:
    example-region:
      area: west
      country: USA
storage:
  disk:
    example-log-analysis:
      size: 1 TiB
      type: hdd