Custom Resources

ClusterVirtualImage

Scope: Cluster
Version: v1alpha2

Example:

apiVersion: virtualization.deckhouse.io/v1alpha2
kind: ClusterVirtualImage
metadata:
  name: example-image
spec:
  dataSource:
    http:
      url: https://example.com/images/disk.img
    type: HTTP

• apiVersion

  string

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
• kind

  string

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
• metadata

  object
• spec

  object
  • spec.dataSource

    object

    Required value

    Origin of the image.
    • spec.dataSource.containerImage

      object

      Use an image stored in external container registry. Only registries with enabled TLS protocol are supported. To provide a custom Certificate Authority (CA) chain, use the caBundle field.
      • spec.dataSource.containerImage.caBundle

        string

        CA chain in Base64 format to verify the container registry.

        Example:

        caBundle: YWFhCg==
        

      • spec.dataSource.containerImage.image

        string

        Required value

        Path to the image in the container registry.

        Pattern: ^(?P<name>(?:(?P<domain>(?:(?:localhost|[\w-]+(?:\.[\w-]+)+)(?::\d+)?)|[\w]+:\d+)/)?(?P<image>[a-z0-9_.-]+(?:/[a-z0-9_.-]+)*))(?::(?P<tag>[\w][\w.-]{0,127}))?(?:@(?P<digest>[A-Za-z][A-Za-z0-9]*(?:[+.-_][A-Za-z][A-Za-z0-9]*)*:[0-9a-fA-F]{32,}))?$

        Example:

        image: registry.example.com/images/slackware:15
        

      • spec.dataSource.containerImage.imagePullSecret

        object
        • spec.dataSource.containerImage.imagePullSecret.name

          string

          Name of the secret keeping container registry credentials.
        • spec.dataSource.containerImage.imagePullSecret.namespace

          string

          Namespace where imagePullSecret is located.
    • spec.dataSource.http

      object

      Fill the image with data from an external URL. The following schemas are supported:

      • HTTP
      • HTTPS

      For HTTPS schema, there is an option to skip the TLS verification.

      • spec.dataSource.http.caBundle

        string

        CA chain in Base64 format to verify the URL.

        Example:

        caBundle: YWFhCg==
        

      • spec.dataSource.http.checksum

        object

        Checksum to verify integrity and consistency of the downloaded file. The file must match all specified checksums.
        • spec.dataSource.http.checksum.md5

          string

          Length: 32..32

          Pattern: ^[0-9a-fA-F]{32}$

          Example:

          md5: f3b59bed9f91e32fac1210184fcff6f5
          

        • spec.dataSource.http.checksum.sha256

          string

          Length: 64..64

          Pattern: ^[0-9a-fA-F]{64}$

          Example:

          sha256: 78be890d71dde316c412da2ce8332ba47b9ce7a29d573801d2777e01aa20b9b5
          

      • spec.dataSource.http.url

        string

        Required value

        URL of the file for creating an image. The following file formats are supported:

        • qcow2
        • vmdk
        • vdi
        • iso
        • raw The file can be compressed into an archive in one of the following formats:
        • gz
        • xz

        Pattern: ^http[s]?:\/\/(?:[a-zA-Z]|[0-9]|[$-_@.&+]|[!*\(\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+$

        Example:

        url: https://mirror.example.com/images/slackware-15.qcow.gz
        

    • spec.dataSource.objectRef

      object

      Use an existing VirtualImage, ClusterVirtualImage, VirtualDisk or VirtualDiskSnapshot resource to create an image.
      • spec.dataSource.objectRef.kind

        string

        Required value

        Kind of the existing VirtualImage, ClusterVirtualImage, VirtualDisk or VirtualDiskSnapshot resource.

        Allowed values: ClusterVirtualImage, VirtualImage, VirtualDisk, VirtualDiskSnapshot

      • spec.dataSource.objectRef.name

        string

        Required value

        Name of the existing VirtualImage, ClusterVirtualImage, VirtualDisk or VirtualDiskSnapshot resource.

        Minimal length: 1

      • spec.dataSource.objectRef.namespace

        string

        Namespace where the VirtualImage, VirtualDisk or VirtualDiskSnapshot resource is located.
    • spec.dataSource.type

      string

      Required value

      The following image sources are available for creating an image:

      • HTTP: From a file published on an HTTP/HTTPS service at a given URL.
      • ContainerImage: From another image stored in a container registry.
      • ObjectRef: From an existing resource.
      • Upload: From data uploaded by the user via a special interface.

      Allowed values: HTTP, ContainerImage, ObjectRef, Upload

• status

  object
  • status.cdrom

    boolean

    Defines whether the image is in a format that needs to be mounted as a CD-ROM drive, such as iso and so on.
  • status.conditions

    array of objects

    The latest available observations of an object’s current state.
    • status.conditions.lastTransitionTime

      string

      lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
    • status.conditions.message

      string

      message is a human readable message indicating details about the transition. This may be an empty string.

      Maximum length: 32768

    • status.conditions.observedGeneration

      integer

      observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

      Allowed values: 0 <= X

    • status.conditions.reason

      string

      reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

      Length: 1..1024

      Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

    • status.conditions.status

      string

      status of the condition, one of True, False, Unknown.

      Allowed values: True, False, Unknown

    • status.conditions.type

      string

      type of condition in CamelCase or in foo.example.com/CamelCase.

      Maximum length: 316

      Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

  • status.downloadSpeed

    object

    Image download speed from an external source. Appears only during the Provisioning phase.
    • status.downloadSpeed.avg

      string

      Average download speed.

      Example:

      avg: 1 Mbps
      

    • status.downloadSpeed.avgBytes

      string

      Average download speed in bytes per second.

      Example:

      avgBytes: 1012345
      

    • status.downloadSpeed.current

      string

      Current download speed.

      Example:

      current: 5 Mbps
      

    • status.downloadSpeed.currentBytes

      string

      Current download speed in bytes per second.

      Example:

      currentBytes: 5123456
      

  • status.format

    string

    Discovered image format.
  • status.imageUploadURLs

    object
    • status.imageUploadURLs.external

      string

      Command to upload the image using Ingress from outside the cluster.
    • status.imageUploadURLs.inCluster

      string

      Command to upload the image using Service within the cluster.
  • status.observedGeneration

    integer

    Resource generation last processed by the controller.
  • status.phase

    string

    Current status of the ClusterVirtualImage resource:

    • Pending: The resource has been created and is on a waiting queue.
    • Provisioning: The resource is being created: copying, downloading, or building of the image is in progress.
    • WaitForUserUpload: Waiting for the user to upload the image. The endpoint to upload the image is specified in .status.uploadCommand.
    • Ready: The resource has been created and is ready to use.
    • Failed: There was an error when creating the resource.
    • Terminating: The resource is being deleted.
    • ImageLost: The image is missing in DVCR. The resource cannot be used.

    Allowed values: Pending, Provisioning, WaitForUserUpload, Ready, Failed, Terminating, ImageLost

  • status.progress

    string

    Progress of copying an image from the source to DVCR. Appears only during the `Provisioning’ phase.
  • status.size

    object

    Discovered image size data.
    • status.size.stored

      string

      Image size in human-readable format.

      Example:

      stored: 199M
      

    • status.size.storedBytes

      string

      Image size in bytes.

      Example:

      storedBytes: 199001234
      

    • status.size.unpacked

      string

      Unpacked image size in human-readable format.

      Example:

      unpacked: 1G
      

    • status.size.unpackedBytes

      string

      Unpacked image size in bytes.

      Example:

      unpackedBytes: 1000000234
      

  • status.sourceUID

    string

    UID of the source (VirtualImage, ClusterVirtualImage, VirtualDisk or VirtualDiskSnapshot) used when creating the cluster virtual image.
  • status.target

    object
    • status.target.registryURL

      string

      Created image in DVCR.

      Example:

      registryURL: dvcr.<dvcr-namespace>.svc/cvi/<image-name>:latest
      

  • status.uploadCommand

    string

    Deprecated. Use imageUploadURLs instead.
  • status.usedInNamespaces

    array of strings

    Displays the list of namespaces where the image is currently used.

NodeUSBDevice

Scope: Cluster
Version: v1alpha2

Example:

apiVersion: virtualization.deckhouse.io/v1alpha2
kind: NodeUSBDevice
metadata:
  name: example-usb
spec:
  assignedNamespace: workloads

• apiVersion

  string

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
• kind

  string

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
• metadata

  object
• spec

  object
  • spec.assignedNamespace

    string

    AssignedNamespace in which the device usage is allowed. By default, created with an empty value “”. When set, a corresponding USBDevice resource is created in this namespace.

    Default: ‘’

• status

  object
  • status.attributes

    object

    All device attributes obtained through DRA for the device.
    • status.attributes.bcd

      string

      BCD (Binary Coded Decimal) device version.
    • status.attributes.bus

      string

      USB bus number.
    • status.attributes.deviceNumber

      string

      USB device number on the bus.
    • status.attributes.devicePath

      string

      Device path in the filesystem.
    • status.attributes.major

      integer

      Major device number.
    • status.attributes.manufacturer

      string

      Device manufacturer name.
    • status.attributes.minor

      integer

      Minor device number.
    • status.attributes.name

      string

      Device name.
    • status.attributes.nodeName

      string

      Node name where the device is located.
    • status.attributes.product

      string

      Device product name.
    • status.attributes.productID

      string

      USB product ID in hexadecimal format.
    • status.attributes.serial

      string

      Device serial number.
    • status.attributes.speed

      integer

      Device speed.
    • status.attributes.vendorID

      string

      USB vendor ID in hexadecimal format.
  • status.conditions

    array of objects

    The latest available observations of an object’s current state.
    • status.conditions.lastTransitionTime

      string

      lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
    • status.conditions.message

      string

      message is a human readable message indicating details about the transition. This may be an empty string.

      Maximum length: 32768

    • status.conditions.observedGeneration

      integer

      observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

      Allowed values: 0 <= X

    • status.conditions.reason

      string

      reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

      Length: 1..1024

      Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

    • status.conditions.status

      string

      status of the condition, one of True, False, Unknown.

      Allowed values: True, False, Unknown

    • status.conditions.type

      string

      type of condition in CamelCase or in foo.example.com/CamelCase.

      Maximum length: 316

      Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

  • status.nodeName

    string

    Name of the node where the USB device is located.
  • status.observedGeneration

    integer

    Resource generation last processed by the controller.

USBDevice

Scope: Namespaced
Version: v1alpha2

Example:

apiVersion: virtualization.deckhouse.io/v1alpha2
kind: USBDevice
metadata:
  name: example-usb

• apiVersion

  string

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
• kind

  string

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
• metadata

  object
• status

  object

  Observed state of USBDevice.
  • status.attributes

    object

    All device attributes obtained through DRA for the device.
    • status.attributes.bcd

      string

      BCD (Binary Coded Decimal) device version.
    • status.attributes.bus

      string

      USB bus number.
    • status.attributes.deviceNumber

      string

      USB device number on the bus.
    • status.attributes.devicePath

      string

      Device path in the filesystem.
    • status.attributes.major

      integer

      Major device number.
    • status.attributes.manufacturer

      string

      Device manufacturer name.
    • status.attributes.minor

      integer

      Minor device number.
    • status.attributes.name

      string

      Device name.
    • status.attributes.nodeName

      string

      Node name where the device is located.
    • status.attributes.product

      string

      Device product name.
    • status.attributes.productID

      string

      USB product ID in hexadecimal format.
    • status.attributes.serial

      string

      Device serial number.
    • status.attributes.speed

      integer

      Device speed.
    • status.attributes.vendorID

      string

      USB vendor ID in hexadecimal format.
  • status.conditions

    array of objects

    Latest available observations of an object’s current state.
    • status.conditions.lastTransitionTime

      string

      lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
    • status.conditions.message

      string

      message is a human readable message indicating details about the transition. This may be an empty string.

      Maximum length: 32768

    • status.conditions.observedGeneration

      integer

      observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

      Allowed values: 0 <= X

    • status.conditions.reason

      string

      reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

      Length: 1..1024

      Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

    • status.conditions.status

      string

      status of the condition, one of True, False, Unknown.

      Allowed values: True, False, Unknown

    • status.conditions.type

      string

      type of condition in CamelCase or in foo.example.com/CamelCase.

      Maximum length: 316

      Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

  • status.nodeName

    string

    Name of the node where the USB device is located.
  • status.observedGeneration

    integer

    Resource generation last processed by the controller.

VirtualDisk

Scope: Namespaced
Version: v1alpha2

Example:

apiVersion: virtualization.deckhouse.io/v1alpha2
kind: VirtualDisk
metadata:
  name: example-disk
spec:
  dataSource:
    objectRef:
      kind: VirtualImage
      name: example-image
    type: ObjectRef
  persistentVolumeClaim:
    size: 10Gi
    storageClassName: standard

• apiVersion

  string

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
• kind

  string

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
• metadata

  object
• spec

  object
  • spec.dataSource

    object
    • spec.dataSource.containerImage

      object

      Use an image stored in an external container registry. Only registries with enabled TLS are supported. To provide a custom Certificate Authority (CA) chain, use the caBundle field.
      • spec.dataSource.containerImage.caBundle

        string

        CA chain in Base64 format to verify the container registry.

        Example:

        caBundle: YWFhCg==
        

      • spec.dataSource.containerImage.image

        string

        Required value

        Path to the image in the container registry.

        Pattern: ^(?P<name>(?:(?P<domain>(?:(?:localhost|[\w-]+(?:\.[\w-]+)+)(?::\d+)?)|[\w]+:\d+)/)?(?P<image>[a-z0-9_.-]+(?:/[a-z0-9_.-]+)*))(?::(?P<tag>[\w][\w.-]{0,127}))?(?:@(?P<digest>[A-Za-z][A-Za-z0-9]*(?:[+.-_][A-Za-z][A-Za-z0-9]*)*:[0-9a-fA-F]{32,}))?$

        Example:

        image: registry.example.com/images/slackware:15
        

      • spec.dataSource.containerImage.imagePullSecret

        object
        • spec.dataSource.containerImage.imagePullSecret.name

          string

          Name of the secret keeping container registry credentials, which must be located in the same namespace.
    • spec.dataSource.http

      object

      Fill the image with data from an external URL. The following schemas are supported:

      • HTTP
      • HTTPS

      For HTTPS schema, there is an option to skip the TLS verification.

      • spec.dataSource.http.caBundle

        string

        CA chain in Base64 format to verify the URL.

        Example:

        caBundle: YWFhCg==
        

      • spec.dataSource.http.checksum

        object

        Checksum to verify integrity and consistency of the downloaded file. The file must match all specified checksums.
        • spec.dataSource.http.checksum.md5

          string

          Length: 32..32

          Pattern: ^[0-9a-fA-F]{32}$

          Example:

          md5: f3b59bed9f91e32fac1210184fcff6f5
          

        • spec.dataSource.http.checksum.sha256

          string

          Length: 64..64

          Pattern: ^[0-9a-fA-F]{64}$

          Example:

          sha256: 78be890d71dde316c412da2ce8332ba47b9ce7a29d573801d2777e01aa20b9b5
          

      • spec.dataSource.http.url

        string

        Required value

        URL of the file for creating an image. The following file formats are supported:

        • qcow2
        • vmdk
        • vdi
        • iso
        • raw The file can be compressed into an archive in one of the following formats:
        • gz
        • xz

        Pattern: ^http[s]?:\/\/(?:[a-zA-Z]|[0-9]|[$-_@.&+]|[!*\(\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+$

        Example:

        url: https://mirror.example.com/images/slackware-15.qcow.gz
        

    • spec.dataSource.objectRef

      object

      Use an existing VirtualImage, ClusterVirtualImage, or VirtualDiskSnapshot resource to create a disk.
      • spec.dataSource.objectRef.kind

        string

        Required value

        Kind of the existing VirtualImage, ClusterVirtualImage, or VirtualDiskSnapshot resource.

        Allowed values: ClusterVirtualImage, VirtualImage, VirtualDiskSnapshot

      • spec.dataSource.objectRef.name

        string

        Required value

        Name of the existing VirtualImage, ClusterVirtualImage, or VirtualDiskSnapshot resource.

        Minimal length: 1

    • spec.dataSource.type

      string

      The following image sources are available for creating an image:

      • HTTP: From a file published on an HTTP/HTTPS service at a given URL.
      • ContainerImage: From another image stored in a container registry.
      • ObjectRef: From an existing resource.
      • Upload: From data uploaded by the user via a special interface.

      Allowed values: HTTP, ContainerImage, ObjectRef, Upload

  • spec.persistentVolumeClaim

    object

    Settings for creating PVCs to store the disk.
    • spec.persistentVolumeClaim.size

      integer or string

      Desired size for PVC to store the disk. If the disk is created from an image, the size must be at least as large as the original unpacked image.

      This parameter can be omitted if the .spec.dataSource section is filled out. In this case, the controller will determine the disk size automatically, based on the size of the extracted image from the source specified in .spec.dataSource.

      Pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

    • spec.persistentVolumeClaim.storageClassName

      string

      StorageClass name required by the claim. For details on using StorageClass for PVC, refer to https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1.

      When creating disks, the user can specify the required StorageClass. If not specified, the default StorageClass will be used.

      The disk features and virtual machine behavior depend on the selected StorageClass.

      The VolumeBindingMode parameter in the StorageClass affects the disk creation process. The following values are allowed:

      • Immediate: The disk will be created and becomes available for use immediately after creation.
      • WaitForFirstConsumer: The disk will be created when first used on the node where the virtual machine will be started.

      StorageClass supports multiple storage settings:

      • Creating a block device (Block) or file system (FileSystem).
      • Multiple access (ReadWriteMany) or single access (ReadWriteOnce). The ReadWriteMany disks support multiple access, which enables a “live” migration of virtual machines. In contrast, the ReadWriteOnce disks, which can be accessed from only one node, don’t have this feature.

      For known storage types, Deckhouse automatically determines the most efficient settings when creating disks (by priority, in descending order):

      1. Block + ReadWriteMany
      2. FileSystem + ReadWriteMany
      3. Block + ReadWriteOnce
      4. FileSystem + ReadWriteOnce
• status

  object
  • status.attachedToVirtualMachines

    array of objects

    List of VirtualMachines that use the disk.

    Example:

    attachedToVirtualMachines:
    - name: VM100
    

    • status.attachedToVirtualMachines.mounted

      boolean

      Flag indicating that VirtualDisk is currently being used by this attached VirtualMachine.
    • status.attachedToVirtualMachines.name

      string

      Name of attached VirtualMachine.
  • status.capacity

    string

    Requested PVC capacity in human-readable format.

    Example:

    capacity: 50G
    

  • status.conditions

    array of objects

    The latest available observations of an object’s current state.
    • status.conditions.lastTransitionTime

      string

      lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
    • status.conditions.message

      string

      message is a human readable message indicating details about the transition. This may be an empty string.

      Maximum length: 32768

    • status.conditions.observedGeneration

      integer

      observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

      Allowed values: 0 <= X

    • status.conditions.reason

      string

      reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

      Length: 1..1024

      Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

    • status.conditions.status

      string

      status of the condition, one of True, False, Unknown.

      Allowed values: True, False, Unknown

    • status.conditions.type

      string

      type of condition in CamelCase or in foo.example.com/CamelCase.

      Maximum length: 316

      Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

  • status.downloadSpeed

    object

    Image download speed from an external source. Appears only during the Provisioning phase.
    • status.downloadSpeed.avg

      string

      Average download speed.

      Example:

      avg: 1 Mbps
      

    • status.downloadSpeed.avgBytes

      string

      Average download speed in bytes per second.

      Example:

      avgBytes: 1012345
      

    • status.downloadSpeed.current

      string

      Current download speed.

      Example:

      current: 5 Mbps
      

    • status.downloadSpeed.currentBytes

      string

      Current download speed in bytes per second.

      Example:

      currentBytes: 5123456
      

  • status.imageUploadURLs

    object
    • status.imageUploadURLs.external

      string

      Command to upload the image using Ingress from outside the cluster.
    • status.imageUploadURLs.inCluster

      string

      Command to upload the image using Service within the cluster.
  • status.migrationState

    object

    Migration information.
    • status.migrationState.endTimestamp

      string
    • status.migrationState.message

      string
    • status.migrationState.result

      string

      VirtualDiskMigrationResult is the result of the VirtualDisk migration.

      Allowed values: Succeeded, Failed

    • status.migrationState.sourcePVC

      string

      Source PersistentVolumeClaim name.
    • status.migrationState.startTimestamp

      string
    • status.migrationState.targetPVC

      string

      Target PersistentVolumeClaim name.
  • status.observedGeneration

    integer

    Resource generation last processed by the controller.
  • status.phase

    string

    Current status of the VirtualDisk resource:

    • Pending: The resource has been created and is on a waiting queue.
    • Provisioning: The resource is being created: copying, downloading, loading data to the PVC, or extending the PVC.
    • WaitForUserUpload: Waiting for the user to upload the image. The endpoint to upload the image is specified in .status.uploadCommand.
    • WaitForFirstConsumer: Waiting for the virtual machine using the disk to be assigned to the node.
    • Ready: The resource has been created and is ready to use.
    • Resizing: The process of resource resizing is in progress.
    • Failed: There was an error when creating the resource.
    • PVCLost: The child PVC of the resource is missing. The resource cannot be used.
    • Exporting: The child PV of the resource is in the process of exporting.
    • Terminating: The resource is being deleted.
    • Migrating: The resource is being migrating.

    Allowed values: Pending, Provisioning, WaitForUserUpload, WaitForFirstConsumer, Ready, Resizing, Failed, PVCLost, Exporting, Terminating, Migrating

  • status.progress

    string

    Progress of copying an image from a source to PVC. Appears only during the `Provisioning’ phase.
  • status.sourceUID

    string

    UID is a type that holds unique ID values, including UUIDs. Because we don’t ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.
  • status.stats

    object

    VirtualDisk statistics.
    • status.stats.creationDuration

      object

      Waiting time for the virtual disk creation.
      • status.stats.creationDuration.dvcrProvisioning

        string

        Duration of the loading into DVCR.
      • status.stats.creationDuration.totalProvisioning

        string

        Duration of the resource creation from the moment dependencies are ready until the resource transitions to the Ready state.
      • status.stats.creationDuration.waitingForDependencies

        string

        Waiting time for dependent resources.
      • status.stats.creationDuration.waitingForFirstConsumer

        string

        Waiting time in the WaitForFirstConsumer phase.
  • status.storageClassName

    string

    Name of the StorageClass used by the PersistentVolumeClaim if Kubernetes storage type is used.
  • status.target

    object
    • status.target.persistentVolumeClaimName

      string

      Created PersistentVolumeClaim name for the Kubernetes storage.
  • status.uploadCommand

    string

    Deprecated. Use ImageUploadURLs instead.

VirtualDiskSnapshot

Scope: Namespaced
Version: v1alpha2

• spec

  object
  • spec.requiredConsistency

    boolean

    Create a snapshot of a connected virtual machine’s disk only if it is possible to freeze the machine through the agent.

    If set to True, a virtual disk snapshot will be created when at least one of the following conditions is met:

    • The virtual disk is not connected to any virtual machine.
    • The virtual disk is connected to a powered-off virtual machine.
    • The virtual disk is connected to a virtual machine with an agent, and the freeze operation was successful.

    Default: true

  • spec.virtualDiskName

    string

    Required value

    Virtual disk name the snapshot is created for.

    Minimal length: 1

• status

  object
  • status.conditions

    array of objects

    Last confirmed status of the resource.
    • status.conditions.lastTransitionTime

      string

      Last time the condition transitioned from one status to another.
    • status.conditions.message

      string

      Human-readable message with details about the last transition.

      Maximum length: 32768

    • status.conditions.observedGeneration

      integer

      .metadata.generation the condition was based upon. For instance, if .metadata.generation is currently 12 but .status.conditions[x].observedGeneration is 9, the condition is considered outdated.

      Allowed values: 0 <= X

    • status.conditions.reason

      string

      Brief reason for the condition’s last transition.

      Length: 1..1024

      Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

    • status.conditions.status

      string

      Condition status. Possible values: True, False, or Unknown.

      Allowed values: True, False, Unknown

    • status.conditions.type

      string

      Condition type.

      Maximum length: 316

      Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

  • status.consistent

    boolean

    Virtual disk snapshot is consistent.
  • status.observedGeneration

    integer

    Resource generation last processed by the controller.
  • status.phase

    string

    Current status of the VirtualDiskSnapshot resource:

    • Pending: The resource has been created and is on a waiting queue.
    • InProgress: The virtual disk snapshot is being created.
    • Ready: The virtual disk snapshot has been created successfully and is now available to use.
    • Failed: There was an error when creating the virtual disk snapshot.
    • Terminating: The resource is being deleted.

    Allowed values: Pending, InProgress, Ready, Failed, Terminating

  • status.volumeSnapshotName

    string

    Name of the created VolumeSnapshot resource.

VirtualImage

Scope: Namespaced
Version: v1alpha2

Example:

apiVersion: virtualization.deckhouse.io/v1alpha2
kind: VirtualImage
metadata:
  name: example-image
spec:
  dataSource:
    http:
      url: https://example.com/images/disk.img
    type: HTTP
  storage: ContainerRegistry

• apiVersion

  string

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
• kind

  string

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
• metadata

  object
• spec

  object
  • spec.dataSource

    object

    Required value
    • spec.dataSource.containerImage

      object

      Use an image stored in an external container registry. Only registries with enabled TLS protocol are supported. To provide a custom Certificate Authority (CA) chain, use the caBundle field.
      • spec.dataSource.containerImage.caBundle

        string

        CA chain in Base64 format to verify the container registry.

        Example:

        caBundle: YWFhCg==
        

      • spec.dataSource.containerImage.image

        string

        Required value

        Path to the image in the container registry.

        Pattern: ^(?P<name>(?:(?P<domain>(?:(?:localhost|[\w-]+(?:\.[\w-]+)+)(?::\d+)?)|[\w]+:\d+)/)?(?P<image>[a-z0-9_.-]+(?:/[a-z0-9_.-]+)*))(?::(?P<tag>[\w][\w.-]{0,127}))?(?:@(?P<digest>[A-Za-z][A-Za-z0-9]*(?:[+.-_][A-Za-z][A-Za-z0-9]*)*:[0-9a-fA-F]{32,}))?$

        Example:

        image: registry.example.com/images/slackware:15
        

      • spec.dataSource.containerImage.imagePullSecret

        object
        • spec.dataSource.containerImage.imagePullSecret.name

          string

          Name of the secret keeping container registry credentials, which must be located in the same namespace.
    • spec.dataSource.http

      object

      Fill the image with data from an external URL. The following schemas are supported:

      • HTTP
      • HTTPS

      For HTTPS schema, there is an option to skip the TLS verification.

      • spec.dataSource.http.caBundle

        string

        CA chain in Base64 format to verify the URL.

        Example:

        caBundle: YWFhCg==
        

      • spec.dataSource.http.checksum

        object

        Checksum to verify integrity and consistency of the downloaded file. The file must match all specified checksums.
        • spec.dataSource.http.checksum.md5

          string

          Length: 32..32

          Pattern: ^[0-9a-fA-F]{32}$

          Example:

          md5: f3b59bed9f91e32fac1210184fcff6f5
          

        • spec.dataSource.http.checksum.sha256

          string

          Length: 64..64

          Pattern: ^[0-9a-fA-F]{64}$

          Example:

          sha256: 78be890d71dde316c412da2ce8332ba47b9ce7a29d573801d2777e01aa20b9b5
          

      • spec.dataSource.http.url

        string

        Required value

        URL of the file for creating an image. The following file formats are supported:

        • qcow2
        • vmdk
        • vdi
        • iso
        • raw The file can be compressed into an archive in one of the following formats:
        • gz
        • xz

        Pattern: ^http[s]?:\/\/(?:[a-zA-Z]|[0-9]|[$-_@.&+]|[!*\(\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+$

        Example:

        url: https://mirror.example.com/images/slackware-15.qcow.gz
        

    • spec.dataSource.objectRef

      object

      Use an existing VirtualImage, ClusterVirtualImage, VirtualDisk or VirtualDiskSnapshot resource to create an image.
      • spec.dataSource.objectRef.kind

        string

        Required value

        Kind of an existing VirtualImage, ClusterVirtualImage, VirtualDisk or VirtualDiskSnapshot resource.

        Allowed values: ClusterVirtualImage, VirtualImage, VirtualDisk, VirtualDiskSnapshot

      • spec.dataSource.objectRef.name

        string

        Required value

        Name of an existing VirtualImage, ClusterVirtualImage, VirtualDisk or VirtualDiskSnapshot resource.

        Minimal length: 1

    • spec.dataSource.type

      string

      The following image sources are available for creating an image:

      • HTTP: From a file published on an HTTP/HTTPS service at a given URL.
      • ContainerImage: From another image stored in a container registry.
      • ObjectRef: From an existing resource.
      • Upload: From data uploaded by the user via a special interface.

      Allowed values: HTTP, ContainerImage, ObjectRef, Upload

  • spec.persistentVolumeClaim

    object

    Settings for creating PVCs to store an image with the storage type PersistentVolumeClaim.
    • spec.persistentVolumeClaim.storageClassName

      string

      Name of the StorageClass required by the claim. For details on using StorageClass for PVC, refer to — https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1.

      When creating an image with the PersistentVolumeClaim storage type, the user can specify the required StorageClass. If not specified, the default StorageClass will be used.

  • spec.storage

    string

    Required value

    Storage type to keep the image for the current virtualization setup.

    • ContainerRegistry: Use the DVCR container registry. In this case, images are downloaded to a container and then to DVCR (shipped with the virtualization module).
    • PersistentVolumeClaim: Use a PVC.
    • Kubernetes: A deprecated storage type. Not recommended for use and may be removed in future versions. Use PersistentVolumeClaim instead.

    Default: ContainerRegistry

    Allowed values: ContainerRegistry, Kubernetes, PersistentVolumeClaim

• status

  object
  • status.cdrom

    boolean

    Whether the image is in a format that needs to be mounted as a CD-ROM drive, such as iso and so on.
  • status.conditions

    array of objects

    The latest available observations of an object’s current state.
    • status.conditions.lastTransitionTime

      string

      lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
    • status.conditions.message

      string

      message is a human readable message indicating details about the transition. This may be an empty string.

      Maximum length: 32768

    • status.conditions.observedGeneration

      integer

      observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

      Allowed values: 0 <= X

    • status.conditions.reason

      string

      reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

      Length: 1..1024

      Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

    • status.conditions.status

      string

      status of the condition, one of True, False, Unknown.

      Allowed values: True, False, Unknown

    • status.conditions.type

      string

      type of condition in CamelCase or in foo.example.com/CamelCase.

      Maximum length: 316

      Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

  • status.downloadSpeed

    object

    Image download speed from an external source. Appears only during the Provisioning phase.
    • status.downloadSpeed.avg

      string

      Average download speed.

      Example:

      avg: 1 Mbps
      

    • status.downloadSpeed.avgBytes

      string

      Average download speed in bytes per second.

      Example:

      avgBytes: 1012345
      

    • status.downloadSpeed.current

      string

      Current download speed.

      Example:

      current: 5 Mbps
      

    • status.downloadSpeed.currentBytes

      string

      Current download speed in bytes per second.

      Example:

      currentBytes: 5123456
      

  • status.format

    string

    Discovered image format.
  • status.imageUploadURLs

    object
    • status.imageUploadURLs.external

      string

      Command to upload the image using Ingress from outside the cluster.
    • status.imageUploadURLs.inCluster

      string

      Command to upload the image using Service within the cluster.
  • status.observedGeneration

    integer

    Resource generation last processed by the controller.
  • status.phase

    string

    Current status of the ClusterVirtualImage resource:

    • Pending: The resource has been created and is on a waiting queue.
    • Provisioning: The resource is being created: copying, downloading, or building the image.
    • WaitForUserUpload: Waiting for the user to upload the image. The endpoint to upload the image is specified in .status.uploadCommand.
    • Ready: The resource has been created and is ready to use.
    • Failed: There was an error when creating the resource.
    • Terminating: The resource is being deleted.
    • ImageLost: The image is missing in DVCR. The resource cannot be used.
    • PVCLost: The child PVC of the resource is missing. The resource cannot be used.

    Allowed values: Pending, Provisioning, WaitForUserUpload, Ready, Failed, Terminating, ImageLost, PVCLost

  • status.progress

    string

    Progress of copying an image from a source to DVCR.
  • status.size

    object

    Discovered image size data.
    • status.size.stored

      string

      Image size in human-readable format.

      Example:

      stored: 199M
      

    • status.size.storedBytes

      string

      Image size in bytes.

      Example:

      storedBytes: 199001234
      

    • status.size.unpacked

      string

      Unpacked image size in human-readable format.

      Example:

      unpacked: 1G
      

    • status.size.unpackedBytes

      string

      Unpacked image size in bytes.

      Example:

      unpackedBytes: 1000000234
      

  • status.sourceUID

    string

    UID of the source (VirtualImage, ClusterVirtualImage, VirtualDisk or VirtualDiskSnapshot) used when creating the virtual image.
  • status.storageClassName

    string

    Name of the StorageClass used by the PersistentVolumeClaim if Kubernetes storage type is used.
  • status.target

    object
    • status.target.persistentVolumeClaimName

      string

      Created PersistentVolumeClaim name for the PersistentVolumeClaim storage.
    • status.target.registryURL

      string

      Created image in DVCR.

      Example:

      registryURL: dvcr.<dvcr-namespace>.svc/vi/<image-namespace>/<image-name>:latest
      

  • status.uploadCommand

    string

    Deprecated. Use imageUploadURLs instead.

VirtualMachineBlockDeviceAttachment

Scope: Namespaced
Version: v1alpha2

Example:

apiVersion: virtualization.deckhouse.io/v1alpha2
kind: VirtualMachineBlockDeviceAttachment
metadata:
  name: attach-example-data-disk
spec:
  blockDeviceRef:
    kind: VirtualDisk
    name: example-data-disk
  virtualMachineName: example-vm

• apiVersion

  string

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
• kind

  string

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
• metadata

  object
• spec

  object
  • spec.blockDeviceRef

    object

    Required value

    Block device that will be connected to the VM as a hot-plug disk.
    • spec.blockDeviceRef.kind

      string

      Block device type. Available options:

      • VirtualDisk: Use VirtualDisk as the disk. This type is always mounted in RW mode.
      • VirtualImage: Use VirtualImage as the disk. This type is always mounted in RO mode.
      • ClusterVirtualImage: Use ClusterVirtualImage as the disk. This type is always mounted in RO mode.

      Allowed values: VirtualDisk, VirtualImage, ClusterVirtualImage

    • spec.blockDeviceRef.name

      string

      Name of the block device to attach.

      Minimal length: 1

  • spec.virtualMachineName

    string

    Required value

    Virtual machine name the disk or image should be attached to.

    Minimal length: 1

• status

  object
  • status.conditions

    array of objects

    Contains details of the current API resource state.
    • status.conditions.lastTransitionTime

      string

      lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
    • status.conditions.message

      string

      message is a human readable message indicating details about the transition. This may be an empty string.

      Maximum length: 32768

    • status.conditions.observedGeneration

      integer

      observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

      Allowed values: 0 <= X

    • status.conditions.reason

      string

      reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

      Length: 1..1024

      Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

    • status.conditions.status

      string

      status of the condition, one of True, False, Unknown.

      Allowed values: True, False, Unknown

    • status.conditions.type

      string

      type of condition in CamelCase or in foo.example.com/CamelCase.

      Maximum length: 316

      Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

  • status.observedGeneration

    integer

    Resource generation last processed by the controller.
  • status.phase

    string

    BlockDeviceAttachmentPhase defines the current status of the resource:

    • Pending: The resource has been created and is on a waiting queue.
    • InProgress: The disk is being attached to the VM.
    • Attached: The disk has been attached to the VM.
    • Failed: There was an error when attaching the disk.
    • Terminating: The resource is being deleted.

    Allowed values: Pending, InProgress, Attached, Failed, Terminating

  • status.virtualMachineName

    string

    Name of the virtual machine the disk is attached to.

VirtualMachineClass

Scope: Cluster

apiVersion: virtualization.deckhouse.io/v1alpha3
kind: VirtualMachineClass
metadata:
  name: example-class
spec:
  cpu:
    type: Host

apiVersion: virtualization.deckhouse.io/v1alpha2
kind: VirtualMachineClass
metadata:
  name: example-class
spec:
  cpu:
    type: Host