tosca_definitions_version: tosca_simple_yaml_1_0_0
metadata:
  template_name: CinderVolumeGlobalTypes
  template_version: 1.0.0
description: Cinder Volume TOSCA Global Types
relationship_types:
  org.openecomp.relationships.VolumeAttachesTo:
    derived_from: tosca.relationships.AttachesTo
    description: This type represents an attachment relationship for associating volume
    properties:
      volume_id:
        type: string
        description: The ID of the volume to be attached
        required: true
        status: supported
      location:
        type: string
        description: The location where the volume is exposed on the instance, mountpoint
        required: false
        status: supported
      instance_uuid:
        type: string
        description: The ID of the server to which the volume attaches
        required: true
        status: supported
    attributes:
      show:
        type: string
        description: Detailed information about resource
        status: supported
node_types:
  org.openecomp.resource.vfc.nodes.heat.cinder.Volume:
    derived_from: tosca.nodes.BlockStorage
    properties:
      availability_zone:
        type: string
        description: The availability zone in which the volume will be created
        required: false
        status: supported
      image:
        type: string
        description: If specified, the name or ID of the image to create the volume from
        required: false
        status: supported
      metadata:
        type: map
        description: Key/value pairs to associate with the volume
        required: false
        status: supported
        entry_schema:
          type: string
      volume_type:
        type: string
        description: If specified, the type of volume to use, mapping to a specific backend
        required: false
        status: supported
      description:
        type: string
        description: A description of the volume
        required: false
        status: supported
      device_type:
        type: string
        description: Device type
        required: false
        status: supported
        constraints:
        - valid_values:
          - cdrom
          - disk
      disk_bus:
        type: string
        description: 'Bus of the device: hypervisor driver chooses a suitable default
          if omitted'
        required: false
        status: supported
        constraints:
        - valid_values:
          - ide
          - lame_bus
          - scsi
          - usb
          - virtio
      backup_id:
        type: string
        description: If specified, the backup to create the volume from
        required: false
        status: supported
      source_volid:
        type: string
        description: If specified, the volume to use as source
        required: false
        status: supported
      boot_index:
        type: integer
        description: Integer used for ordering the boot disks
        required: false
        status: supported
      size:
        type: scalar-unit.size
        description: The requested storage size (default unit is MB)
        required: false
        status: supported
        constraints:
        - greater_or_equal: 1 GB
      read_only:
        type: boolean
        description: Enables or disables read-only access mode of volume
        required: false
        status: supported
      name:
        type: string
        description: A name used to distinguish the volume
        required: false
        status: supported
      scheduler_hints:
        type: map
        description: Arbitrary key-value pairs specified by the client to help the Cinder scheduler creating a volume
        required: false
        status: supported
        entry_schema:
          type: string
      swap_size:
        type: scalar-unit.size
        description: The size of the swap, in MB
        required: false
        status: supported
      delete_on_termination:
        type: boolean
        description: Indicate whether the volume should be deleted when the server is terminated
        required: false
        status: supported
      multiattach:
        type: boolean
        description: Whether allow the volume to be attached more than once
        required: false
        status: supported
    attributes:
      display_description:
        type: string
        description: Description of the volume
        status: supported
      attachments:
        type: string
        description: The list of attachments of the volume
        status: supported
        entry_schema:
          type: string
      encrypted:
        type: boolean
        description: Boolean indicating if the volume is encrypted or not
        status: supported
      show:
        type: string
        description: Detailed information about resource
        status: supported
      created_at:
        type: timestamp
        description: The timestamp indicating volume creation
        status: supported
      display_name:
        type: string
        description: Name of the volume
        status: supported
      metadata_values:
        type: map
        description: Key/value pairs associated with the volume in raw dict form
        status: supported
      bootable:
        type: boolean
        description: Boolean indicating if the volume can be booted or not
        status: supported
      status:
        type: string
        description: The current status of the volume
        status: supported