Skip to main content
Version: latest

Get virtual machine

GET 

/v1/spectroclusters/:uid/vms/:vmName

Get virtual machine

Request

Path Parameters

    uid stringrequired

    Cluster uid

    vmName stringrequired

    Virtual Machine name

Query Parameters

    namespace stringrequired

    Namespace name

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses

(empty)

Schema

    apiVersionstring

    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.

    kindstring

    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.

    metadata

    object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations

    object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

    property name*string
    clusterNamestring

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    creationTimestampstring

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

    Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

    deletionGracePeriodSecondsint64

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    deletionTimestampdate-timenullable

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

    Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

    finalizersstring[]

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

    generateNamestring

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

    If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

    Applied only if Name is not specified.

    generationint64

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    labels

    object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

    property name*string

    managedFields

    object[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

  • Array [

  • apiVersionstring

    APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

    fieldsTypestring

    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

    fieldsV1

    object

    FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.

    Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.

    The exact format is defined in sigs.k8s.io/structured-merge-diff

    Rawbyte[]
    managerstring

    Manager is an identifier of the workflow managing these fields.

    operationstring

    Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

    subresourcestring

    Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

    timedate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • ]

  • namestring

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    namespacestring

    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated.

    ownerReferences

    object[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

  • Array [

  • apiVersionstringrequired

    API version of the referent.

    blockOwnerDeletionboolean

    If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

    controllerboolean

    If true, this reference points to the managing controller.

    kindstringrequired

    Kind of the referent.

    namestringrequired

    Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    uidstringrequired

    UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • ]

  • resourceVersionstring

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients.

    selfLinkstring

    SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

    uidstring

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only.

    spec

    object

    required

    VirtualMachineSpec describes how the proper VirtualMachine should look like

    dataVolumeTemplates

    object[]

    dataVolumeTemplates is a list of dataVolumes that the VirtualMachineInstance template can reference. DataVolumes in this list are dynamically created for the VirtualMachine and are tied to the VirtualMachine's life-cycle.

  • Array [

  • apiVersionstring

    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.

    kindstring

    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.

    metadata

    object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations

    object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

    property name*string
    clusterNamestring

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    creationTimestampstring

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

    Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

    deletionGracePeriodSecondsint64

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    deletionTimestampdate-timenullable

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

    Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

    finalizersstring[]

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

    generateNamestring

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

    If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

    Applied only if Name is not specified.

    generationint64

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    labels

    object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

    property name*string

    managedFields

    object[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

  • Array [

  • apiVersionstring

    APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

    fieldsTypestring

    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

    fieldsV1

    object

    FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.

    Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.

    The exact format is defined in sigs.k8s.io/structured-merge-diff

    Rawbyte[]
    managerstring

    Manager is an identifier of the workflow managing these fields.

    operationstring

    Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

    subresourcestring

    Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

    timedate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • ]

  • namestring

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    namespacestring

    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated.

    ownerReferences

    object[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

  • Array [

  • apiVersionstringrequired

    API version of the referent.

    blockOwnerDeletionboolean

    If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

    controllerboolean

    If true, this reference points to the managing controller.

    kindstringrequired

    Kind of the referent.

    namestringrequired

    Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    uidstringrequired

    UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • ]

  • resourceVersionstring

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients.

    selfLinkstring

    SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

    uidstring

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only.

    spec

    object

    required

    DataVolumeSpec defines the DataVolume type specification

    checkpoints

    object[]

    Checkpoints is a list of DataVolumeCheckpoints, representing stages in a multistage import.

  • Array [

  • currentstringrequired

    Current is the identifier of the snapshot created for this checkpoint.

    previousstringrequired

    Previous is the identifier of the snapshot from the previous checkpoint.

  • ]

  • contentTypestring

    DataVolumeContentType options: "kubevirt", "archive"

    finalCheckpointboolean

    FinalCheckpoint indicates whether the current DataVolumeCheckpoint is the final checkpoint.

    preallocationboolean

    Preallocation controls whether storage for DataVolumes should be allocated in advance.

    priorityClassNamestring

    PriorityClassName for Importer, Cloner and Uploader pod

    pvc

    object

    PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

    accessModesstring[]

    AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

    dataSource

    object

    TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

    apiGroupstring

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

    kindstringrequired

    Kind is the type of resource being referenced

    namestringrequired

    Name is the name of resource being referenced

    dataSourceRef

    object

    TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

    apiGroupstring

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

    kindstringrequired

    Kind is the type of resource being referenced

    namestringrequired

    Name is the name of resource being referenced

    resources

    object

    ResourceRequirements describes the compute resource requirements.

    limits

    object

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    property name*string

    Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

    The serialization format is:

    ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E"

    No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

    When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

    Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

    Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

    Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

    Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

    This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

    requests

    object

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    property name*string

    Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

    The serialization format is:

    ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E"

    No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

    When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

    Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

    Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

    Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

    Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

    This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

    selector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions

    object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [

  • keystringrequired

    key is the label key that the selector applies to.

    operatorstringrequired

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesstring[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]

  • matchLabels

    object

    matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    property name*string
    storageClassNamestring

    Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

    volumeModestring

    volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

    volumeNamestring

    VolumeName is the binding reference to the PersistentVolume backing this claim.

    source

    object

    DataVolumeSource represents the source for our Data Volume, this can be HTTP, Imageio, S3, Registry or an existing PVC

    blankobject

    DataVolumeBlankImage provides the parameters to create a new raw blank image for the PVC

    http

    object

    DataVolumeSourceHTTP can be either an http or https endpoint, with an optional basic auth user name and password, and an optional configmap containing additional CAs

    certConfigMapstring

    CertConfigMap is a configmap reference, containing a Certificate Authority(CA) public key, and a base64 encoded pem certificate

    extraHeadersstring[]

    ExtraHeaders is a list of strings containing extra headers to include with HTTP transfer requests

    secretExtraHeadersstring[]

    SecretExtraHeaders is a list of Secret references, each containing an extra HTTP header that may include sensitive information

    secretRefstring

    SecretRef A Secret reference, the secret should contain accessKeyId (user name) base64 encoded, and secretKey (password) also base64 encoded

    urlstringrequired

    URL is the URL of the http(s) endpoint

    imageio

    object

    DataVolumeSourceImageIO provides the parameters to create a Data Volume from an imageio source

    certConfigMapstring

    CertConfigMap provides a reference to the CA cert

    diskIdstringrequired

    DiskID provides id of a disk to be imported

    secretRefstring

    SecretRef provides the secret reference needed to access the ovirt-engine

    urlstringrequired

    URL is the URL of the ovirt-engine

    pvc

    object

    DataVolumeSourcePVC provides the parameters to create a Data Volume from an existing PVC

    namestringrequired

    The name of the source PVC

    namespacestringrequired

    The namespace of the source PVC

    registry

    object

    DataVolumeSourceRegistry provides the parameters to create a Data Volume from an registry source

    certConfigMapstring

    CertConfigMap provides a reference to the Registry certs

    imageStreamstring

    ImageStream is the name of image stream for import

    pullMethodstring

    PullMethod can be either "pod" (default import), or "node" (node docker cache based import)

    secretRefstring

    SecretRef provides the secret reference needed to access the Registry source

    urlstring

    URL is the url of the registry source (starting with the scheme: docker, oci-archive)

    s3

    object

    DataVolumeSourceS3 provides the parameters to create a Data Volume from an S3 source

    certConfigMapstring

    CertConfigMap is a configmap reference, containing a Certificate Authority(CA) public key, and a base64 encoded pem certificate

    secretRefstring

    SecretRef provides the secret reference needed to access the S3 source

    urlstringrequired

    URL is the url of the S3 source

    uploadobject

    DataVolumeSourceUpload provides the parameters to create a Data Volume by uploading the source

    vddk

    object

    DataVolumeSourceVDDK provides the parameters to create a Data Volume from a Vmware source

    backingFilestring

    BackingFile is the path to the virtual hard disk to migrate from vCenter/ESXi

    initImageURLstring

    InitImageURL is an optional URL to an image containing an extracted VDDK library, overrides v2v-vmware config map

    secretRefstring

    SecretRef provides a reference to a secret containing the username and password needed to access the vCenter or ESXi host

    thumbprintstring

    Thumbprint is the certificate thumbprint of the vCenter or ESXi host

    urlstring

    URL is the URL of the vCenter or ESXi host with the VM to migrate

    uuidstring

    UUID is the UUID of the virtual machine that the backing file is attached to in vCenter/ESXi

    sourceRef

    object

    DataVolumeSourceRef defines an indirect reference to the source of data for the DataVolume

    kindstringrequired

    The kind of the source reference, currently only "DataSource" is supported

    namestringrequired

    The name of the source reference

    namespacestring

    The namespace of the source reference, defaults to the DataVolume namespace

    storage

    object

    StorageSpec defines the Storage type specification

    accessModesstring[]

    AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

    dataSource

    object

    TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

    apiGroupstring

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

    kindstringrequired

    Kind is the type of resource being referenced

    namestringrequired

    Name is the name of resource being referenced

    resources

    object

    ResourceRequirements describes the compute resource requirements.

    limits

    object

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    property name*string

    Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

    The serialization format is:

    ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E"

    No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

    When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

    Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

    Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

    Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

    Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

    This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

    requests

    object

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    property name*string

    Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

    The serialization format is:

    ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E"

    No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

    When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

    Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

    Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

    Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

    Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

    This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

    selector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions

    object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [

  • keystringrequired

    key is the label key that the selector applies to.

    operatorstringrequired

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesstring[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]

  • matchLabels

    object

    matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    property name*string
    storageClassNamestring

    Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

    volumeModestring

    volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

    volumeNamestring

    VolumeName is the binding reference to the PersistentVolume backing this claim.

  • ]

  • instancetype

    object

    InstancetypeMatcher references a instancetype that is used to fill fields in the VMI template.

    inferFromVolumestring

    InferFromVolume lists the name of a volume that should be used to infer or discover the instancetype to be used through known annotations on the underlying resource. Once applied to the InstancetypeMatcher this field is removed.

    kindstring

    Kind specifies which instancetype resource is referenced. Allowed values are: "VirtualMachineInstancetype" and "VirtualMachineClusterInstancetype". If not specified, "VirtualMachineClusterInstancetype" is used by default.

    namestring

    Name is the name of the VirtualMachineInstancetype or VirtualMachineClusterInstancetype

    revisionNamestring

    RevisionName specifies a ControllerRevision containing a specific copy of the VirtualMachineInstancetype or VirtualMachineClusterInstancetype to be used. This is initially captured the first time the instancetype is applied to the VirtualMachineInstance.

    preference

    object

    PreferenceMatcher references a set of preference that is used to fill fields in the VMI template.

    inferFromVolumestring

    InferFromVolume lists the name of a volume that should be used to infer or discover the preference to be used through known annotations on the underlying resource. Once applied to the PreferenceMatcher this field is removed.

    kindstring

    Kind specifies which preference resource is referenced. Allowed values are: "VirtualMachinePreference" and "VirtualMachineClusterPreference". If not specified, "VirtualMachineClusterPreference" is used by default.

    namestring

    Name is the name of the VirtualMachinePreference or VirtualMachineClusterPreference

    revisionNamestring

    RevisionName specifies a ControllerRevision containing a specific copy of the VirtualMachinePreference or VirtualMachineClusterPreference to be used. This is initially captured the first time the instancetype is applied to the VirtualMachineInstance.

    runStrategystring

    Running state indicates the requested running state of the VirtualMachineInstance mutually exclusive with Running

    runningboolean

    Running controls whether the associatied VirtualMachineInstance is created or not Mutually exclusive with RunStrategy

    template

    object

    required

    metadata

    object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations

    object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

    property name*string
    clusterNamestring

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    creationTimestampstring

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

    Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

    deletionGracePeriodSecondsint64

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    deletionTimestampdate-timenullable

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

    Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

    finalizersstring[]

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

    generateNamestring

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

    If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

    Applied only if Name is not specified.

    generationint64

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    labels

    object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

    property name*string

    managedFields

    object[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

  • Array [

  • apiVersionstring

    APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

    fieldsTypestring

    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

    fieldsV1

    object

    FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.

    Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.

    The exact format is defined in sigs.k8s.io/structured-merge-diff

    Rawbyte[]
    managerstring

    Manager is an identifier of the workflow managing these fields.

    operationstring

    Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

    subresourcestring

    Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

    timedate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • ]

  • namestring

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    namespacestring

    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated.

    ownerReferences

    object[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

  • Array [

  • apiVersionstringrequired

    API version of the referent.

    blockOwnerDeletionboolean

    If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

    controllerboolean

    If true, this reference points to the managing controller.

    kindstringrequired

    Kind of the referent.

    namestringrequired

    Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    uidstringrequired

    UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • ]

  • resourceVersionstring

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients.

    selfLinkstring

    SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

    uidstring

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only.

    spec

    object

    VirtualMachineInstanceSpec is a description of a VirtualMachineInstance.

    accessCredentials

    object[]

    Specifies a set of public keys to inject into the vm guest

  • Array [

  • sshPublicKey

    object

    SSHPublicKeyAccessCredential represents a source and propagation method for injecting ssh public keys into a vm guest

    propagationMethod

    object

    required

    SSHPublicKeyAccessCredentialPropagationMethod represents the method used to inject a ssh public key into the vm guest. Only one of its members may be specified.

    configDriveobject

    qemuGuestAgent

    object

    usersstring[]required

    Users represents a list of guest users that should have the ssh public keys added to their authorized_keys file.

    source

    object

    required

    SSHPublicKeyAccessCredentialSource represents where to retrieve the ssh key credentials Only one of its members may be specified.

    secret

    object

    secretNamestringrequired

    SecretName represents the name of the secret in the VMI's namespace

    userPassword

    object

    UserPasswordAccessCredential represents a source and propagation method for injecting user passwords into a vm guest Only one of its members may be specified.

    propagationMethod

    object

    required

    UserPasswordAccessCredentialPropagationMethod represents the method used to inject a user passwords into the vm guest. Only one of its members may be specified.

    qemuGuestAgentobject

    source

    object

    required

    UserPasswordAccessCredentialSource represents where to retrieve the user password credentials Only one of its members may be specified.

    secret

    object

    secretNamestringrequired

    SecretName represents the name of the secret in the VMI's namespace

  • ]

  • affinity

    object

    Affinity is a group of affinity scheduling rules.

    nodeAffinity

    object

    Node affinity is a group of node affinity scheduling rules.

    preferredDuringSchedulingIgnoredDuringExecution

    object[]

    The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.

  • Array [

  • preference

    object

    required

    A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

    matchExpressions

    object[]

    A list of node selector requirements by node's labels.

  • Array [

  • keystringrequired

    The label key that the selector applies to.

    operatorstringrequired

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    valuesstring[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]

  • matchFields

    object[]

    A list of node selector requirements by node's fields.

  • Array [

  • keystringrequired

    The label key that the selector applies to.

    operatorstringrequired

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    valuesstring[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]

  • weightint32required

    Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

  • ]

  • requiredDuringSchedulingIgnoredDuringExecution

    object

    A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

    nodeSelectorTerms

    object[]

    required

    Required. A list of node selector terms. The terms are ORed.

  • Array [

  • matchExpressions

    object[]

    A list of node selector requirements by node's labels.

  • Array [

  • keystringrequired

    The label key that the selector applies to.

    operatorstringrequired

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    valuesstring[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]

  • matchFields

    object[]

    A list of node selector requirements by node's fields.

  • Array [

  • keystringrequired

    The label key that the selector applies to.

    operatorstringrequired

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    valuesstring[]

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

  • ]

  • ]

  • podAffinity

    object

    Pod affinity is a group of inter pod affinity scheduling rules.

    preferredDuringSchedulingIgnoredDuringExecution

    object[]

    The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

  • Array [

  • podAffinityTerm

    object

    required

    Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

    labelSelector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions

    object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [

  • keystringrequired

    key is the label key that the selector applies to.

    operatorstringrequired

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesstring[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]

  • matchLabels

    object

    matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    property name*string

    namespaceSelector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions

    object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [

  • keystringrequired

    key is the label key that the selector applies to.

    operatorstringrequired

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesstring[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]

  • matchLabels

    object

    matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    property name*string
    namespacesstring[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"

    topologyKeystringrequired

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

    weightint32required

    weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

  • ]

  • requiredDuringSchedulingIgnoredDuringExecution

    object[]

    If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

  • Array [

  • labelSelector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions

    object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [

  • keystringrequired

    key is the label key that the selector applies to.

    operatorstringrequired

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesstring[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]

  • matchLabels

    object

    matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    property name*string

    namespaceSelector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions

    object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [

  • keystringrequired

    key is the label key that the selector applies to.

    operatorstringrequired

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesstring[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]

  • matchLabels

    object

    matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    property name*string
    namespacesstring[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"

    topologyKeystringrequired

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

  • ]

  • podAntiAffinity

    object

    Pod anti affinity is a group of inter pod anti affinity scheduling rules.

    preferredDuringSchedulingIgnoredDuringExecution

    object[]

    The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

  • Array [

  • podAffinityTerm

    object

    required

    Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

    labelSelector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions

    object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [

  • keystringrequired

    key is the label key that the selector applies to.

    operatorstringrequired

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesstring[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]

  • matchLabels

    object

    matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    property name*string

    namespaceSelector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions

    object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [

  • keystringrequired

    key is the label key that the selector applies to.

    operatorstringrequired

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesstring[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]

  • matchLabels

    object

    matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    property name*string
    namespacesstring[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"

    topologyKeystringrequired

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

    weightint32required

    weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

  • ]

  • requiredDuringSchedulingIgnoredDuringExecution

    object[]

    If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

  • Array [

  • labelSelector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions

    object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [

  • keystringrequired

    key is the label key that the selector applies to.

    operatorstringrequired

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesstring[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]

  • matchLabels

    object

    matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    property name*string

    namespaceSelector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions

    object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [

  • keystringrequired

    key is the label key that the selector applies to.

    operatorstringrequired

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesstring[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]

  • matchLabels

    object

    matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    property name*string
    namespacesstring[]

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"

    topologyKeystringrequired

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

  • ]

  • dnsConfig

    object

    PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

    nameserversstring[]

    A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

    options

    object[]

    A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.

  • Array [

  • namestring

    Required.

    valuestring
  • ]

  • searchesstring[]

    A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

    dnsPolicystring

    Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.

    domain

    object

    required

    chassis

    object

    Chassis specifies the chassis info passed to the domain.

    assetstring
    manufacturerstring
    serialstring
    skustring
    versionstring

    clock

    object

    Represents the clock and timers of a vmi.

    timer

    object

    Represents all available timers in a vmi.

    hpet

    object

    presentboolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

    tickPolicystring

    TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "merge", "discard".

    hyperv

    object

    presentboolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

    kvm

    object

    presentboolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

    pit

    object

    presentboolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

    tickPolicystring

    TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "discard".

    rtc

    object

    presentboolean

    Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.

    tickPolicystring

    TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup".

    trackstring

    Track the guest or the wall clock.

    timezonestring

    Timezone sets the guest clock to the specified timezone. Zone name follows the TZ environment variable format (e.g. 'America/New_York').

    utc

    object

    UTC sets the guest clock to UTC on each boot.

    offsetSecondsint32

    OffsetSeconds specifies an offset in seconds, relative to UTC. If set, guest changes to the clock will be kept during reboots and not reset.

    cpu

    object

    CPU allows specifying the CPU topology.

    coresint64

    Cores specifies the number of cores inside the vmi. Must be a value greater or equal 1.

    dedicatedCpuPlacementboolean

    DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node with enough dedicated pCPUs and pin the vCPUs to it.

    features

    object[]

    Features specifies the CPU features list inside the VMI.

  • Array [

  • namestringrequired

    Name of the CPU feature

    policystring

    Policy is the CPU feature attribute which can have the following attributes: force - The virtual CPU will claim the feature is supported regardless of it being supported by host CPU. require - Guest creation will fail unless the feature is supported by the host CPU or the hypervisor is able to emulate it. optional - The feature will be supported by virtual CPU if and only if it is supported by host CPU. disable - The feature will not be supported by virtual CPU. forbid - Guest creation will fail if the feature is supported by host CPU. Defaults to require

  • ]

  • isolateEmulatorThreadboolean

    IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place the emulator thread on it.

    modelstring

    Model specifies the CPU model inside the VMI. List of available models https://github.com/libvirt/libvirt/tree/master/src/cpu_map. It is possible to specify special cases like "host-passthrough" to get the same CPU as the node and "host-model" to get CPU closest to the node one. Defaults to host-model.

    numa

    object

    guestMappingPassthroughobject

    NUMAGuestMappingPassthrough instructs kubevirt to model numa topology which is compatible with the CPU pinning on the guest. This will result in a subset of the node numa topology being passed through, ensuring that virtual numa nodes and their memory never cross boundaries coming from the node numa mapping.

    realtime

    object

    Realtime holds the tuning knobs specific for realtime workloads.

    maskstring

    Mask defines the vcpu mask expression that defines which vcpus are used for realtime. Format matches libvirt's expressions. Example: "0-3,^1","0,2,3","2-3"

    socketsint64

    Sockets specifies the number of sockets inside the vmi. Must be a value greater or equal 1.

    threadsint64

    Threads specifies the number of threads inside the vmi. Must be a value greater or equal 1.

    devices

    object

    required

    autoattachGraphicsDeviceboolean

    Whether to attach the default graphics device or not. VNC will not be available if set to false. Defaults to true.

    autoattachInputDeviceboolean

    Whether to attach an Input Device. Defaults to false.

    autoattachMemBalloonboolean

    Whether to attach the Memory balloon device with default period. Period can be adjusted in virt-config. Defaults to true.

    autoattachPodInterfaceboolean

    Whether to attach a pod network interface. Defaults to true.

    autoattachSerialConsoleboolean

    Whether to attach the default serial console or not. Serial console access will not be available if set to false. Defaults to true.

    autoattachVSOCKboolean

    Whether to attach the VSOCK CID to the VM or not. VSOCK access will be available if set to true. Defaults to false.

    blockMultiQueueboolean

    Whether or not to enable virtio multi-queue for block devices. Defaults to false.

    clientPassthroughobject

    Represent a subset of client devices that can be accessed by VMI. At the moment only, USB devices using Usbredir's library and tooling. Another fit would be a smartcard with libcacard.

    The struct is currently empty as there is no immediate request for user-facing APIs. This structure simply turns on USB redirection of UsbClientPassthroughMaxNumberOf devices.

    disableHotplugboolean

    DisableHotplug disabled the ability to hotplug disks.

    disks

    object[]

    Disks describes disks, cdroms and luns which are connected to the vmi.

  • Array [

  • blockSize

    object

    BlockSize provides the option to change the block size presented to the VM for a disk. Only one of its members may be specified.

    custom

    object

    CustomBlockSize represents the desired logical and physical block size for a VM disk.

    logicalint32required
    physicalint32required

    matchVolume

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    bootOrderint32

    BootOrder is an integer value > 0, used to determine ordering of boot devices. Lower values take precedence. Each disk or interface that has a boot order must have a unique value. Disks without a boot order are not tried if a disk with a boot order exists.

    cachestring

    Cache specifies which kvm disk cache mode should be used. Supported values are: CacheNone, CacheWriteThrough.

    cdrom

    object

    busstring

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

    readonlyboolean

    ReadOnly. Defaults to true.

    traystring

    Tray indicates if the tray of the device is open or closed. Allowed values are "open" and "closed". Defaults to closed.

    dedicatedIOThreadboolean

    dedicatedIOThread indicates this disk should have an exclusive IO Thread. Enabling this implies useIOThreads = true. Defaults to false.

    disk

    object

    busstring

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi, usb.

    pciAddressstring

    If specified, the virtual disk will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10

    readonlyboolean

    ReadOnly. Defaults to false.

    iostring

    IO specifies which QEMU disk IO mode should be used. Supported values are: native, default, threads.

    lun

    object

    busstring

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

    readonlyboolean

    ReadOnly. Defaults to false.

    namestringrequired

    Name is the device name

    serialstring

    Serial provides the ability to specify a serial number for the disk device.

    shareableboolean

    If specified the disk is made sharable and multiple write from different VMs are permitted

    tagstring

    If specified, disk address and its tag will be provided to the guest via config drive metadata

  • ]

  • filesystems

    object[]

    Filesystems describes filesystem which is connected to the vmi.

  • Array [

  • namestringrequired

    Name is the device name

    virtiofsobjectrequired
  • ]

  • gpus

    object[]

    Whether to attach a GPU device to the vmi.

  • Array [

  • deviceNamestringrequired
    namestringrequired

    Name of the GPU device as exposed by a device plugin

    tagstring

    If specified, the virtual network interface address and its tag will be provided to the guest via config drive

    virtualGPUOptions

    object

    display

    object

    enabledboolean

    Enabled determines if a display addapter backed by a vGPU should be enabled or disabled on the guest. Defaults to true.

    ramFB

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

  • ]

  • hostDevices

    object[]

    Whether to attach a host device to the vmi.

  • Array [

  • deviceNamestringrequired

    DeviceName is the resource name of the host device exposed by a device plugin

    namestringrequired
    tagstring

    If specified, the virtual network interface address and its tag will be provided to the guest via config drive

  • ]

  • inputs

    object[]

    Inputs describe input devices

  • Array [

  • busstring

    Bus indicates the bus of input device to emulate. Supported values: virtio, usb.

    namestringrequired

    Name is the device name

    typestringrequired

    Type indicated the type of input device. Supported values: tablet.

  • ]

  • interfaces

    object[]

    Interfaces describe network interfaces which are added to the vmi.

  • Array [

  • acpiIndexint32

    If specified, the ACPI index is used to provide network interface device naming, that is stable across changes in PCI addresses assigned to the device. This value is required to be unique across all devices and be between 1 and (16*1024-1).

    bootOrderint32

    BootOrder is an integer value > 0, used to determine ordering of boot devices. Lower values take precedence. Each interface or disk that has a boot order must have a unique value. Interfaces without a boot order are not tried.

    bridgeobject

    InterfaceBridge connects to a given network via a linux bridge.

    dhcpOptions

    object

    Extra DHCP options to use in the interface.

    bootFileNamestring

    If specified will pass option 67 to interface's DHCP server

    ntpServersstring[]

    If specified will pass the configured NTP server to the VM via DHCP option 042.

    privateOptions

    object[]

    If specified will pass extra DHCP options for private use, range: 224-254

  • Array [

  • optionint32required

    Option is an Integer value from 224-254 Required.

    valuestringrequired

    Value is a String value for the Option provided Required.

  • ]

  • tftpServerNamestring

    If specified will pass option 66 to interface's DHCP server

    macAddressstring

    Interface MAC address. For example: de:ad:00:00:be:af or DE-AD-00-00-BE-AF.

    macvtapobject

    InterfaceMacvtap connects to a given network by extending the Kubernetes node's L2 networks via a macvtap interface.

    masqueradeobject

    InterfaceMasquerade connects to a given network using netfilter rules to nat the traffic.

    modelstring

    Interface model. One of: e1000, e1000e, ne2k_pci, pcnet, rtl8139, virtio. Defaults to virtio.

    namestringrequired

    Logical name of the interface as well as a reference to the associated networks. Must match the Name of a Network.

    passtobject

    InterfacePasst connects to a given network.

    pciAddressstring

    If specified, the virtual network interface will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10

    ports

    object[]

    List of ports to be forwarded to the virtual machine.

  • Array [

  • namestring

    If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

    portint32required

    Number of port to expose for the virtual machine. This must be a valid port number, 0 < x < 65536.

    protocolstring

    Protocol for port. Must be UDP or TCP. Defaults to "TCP".

  • ]

  • slirpobject

    InterfaceSlirp connects to a given network using QEMU user networking mode.

    sriovobject

    InterfaceSRIOV connects to a given network by passing-through an SR-IOV PCI device via vfio.

    tagstring

    If specified, the virtual network interface address and its tag will be provided to the guest via config drive

  • ]

  • networkInterfaceMultiqueueboolean

    If specified, virtual network interfaces configured with a virtio bus will also enable the vhost multiqueue feature for network devices. The number of queues created depends on additional factors of the VirtualMachineInstance, like the number of guest CPUs.

    rngobject

    Rng represents the random device passed from host

    sound

    object

    Represents the user's configuration to emulate sound cards in the VMI.

    modelstring

    We only support ich9 or ac97. If SoundDevice is not set: No sound card is emulated. If SoundDevice is set but Model is not: ich9

    namestringrequired

    User's defined name for this sound device

    tpmobject
    useVirtioTransitionalboolean

    Fall back to legacy virtio 0.9 support if virtio bus is selected on devices. This is helpful for old machines like CentOS6 or RHEL6 which do not understand virtio_non_transitional (virtio 1.0).

    watchdog

    object

    Named watchdog device.

    i6300esb

    object

    i6300esb watchdog device.

    actionstring

    The action to take. Valid values are poweroff, reset, shutdown. Defaults to reset.

    namestringrequired

    Name of the watchdog.

    features

    object

    acpi

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    apic

    object

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    endOfInterruptboolean

    EndOfInterrupt enables the end of interrupt notification in the guest. Defaults to false.

    hyperv

    object

    Hyperv specific features.

    evmcs

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    frequencies

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    ipi

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    reenlightenment

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    relaxed

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    reset

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    runtime

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    spinlocks

    object

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    spinlocksint64

    Retries indicates the number of retries. Must be a value greater or equal 4096. Defaults to 4096.

    synic

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    synictimer

    object

    direct

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    enabledboolean

    tlbflush

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    vapic

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    vendorid

    object

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    vendoridstring

    VendorID sets the hypervisor vendor id, visible to the vmi. String up to twelve characters.

    vpindex

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    kvm

    object

    hiddenboolean

    Hide the KVM hypervisor from standard MSR based discovery. Defaults to false

    pvspinlock

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    smm

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    firmware

    object

    bootloader

    object

    Represents the firmware blob used to assist in the domain creation process. Used for setting the QEMU BIOS file path for the libvirt domain.

    bios

    object

    If set (default), BIOS will be used.

    useSerialboolean

    If set, the BIOS output will be transmitted over serial

    efi

    object

    If set, EFI will be used instead of BIOS.

    secureBootboolean

    If set, SecureBoot will be enabled and the OVMF roms will be swapped for SecureBoot-enabled ones. Requires SMM to be enabled. Defaults to true

    kernelBoot

    object

    Represents the firmware blob used to assist in the kernel boot process. Used for setting the kernel, initrd and command line arguments

    container

    object

    If set, the VM will be booted from the defined kernel / initrd.

    imagestringrequired

    Image that contains initrd / kernel files.

    imagePullPolicystring

    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

    imagePullSecretstring

    ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.

    initrdPathstring

    the fully-qualified path to the ramdisk image in the host OS

    kernelPathstring

    The fully-qualified path to the kernel image in the host OS

    kernelArgsstring

    Arguments to be passed to the kernel at boot time

    serialstring

    The system-serial-number in SMBIOS

    uuidstring

    UUID reported by the vmi bios. Defaults to a random generated uid.

    ioThreadsPolicystring

    Controls whether or not disks will share IOThreads. Omitting IOThreadsPolicy disables use of IOThreads. One of: shared, auto

    launchSecurity

    object

    sevobject

    machine

    object

    typestring

    QEMU machine type is the actual chipset of the VirtualMachineInstance.

    memory

    object

    Memory allows specifying the VirtualMachineInstance memory features.

    gueststring

    Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

    The serialization format is:

    ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E"

    No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

    When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

    Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

    Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

    Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

    Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

    This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

    hugepages

    object

    Hugepages allow to use hugepages for the VirtualMachineInstance instead of regular memory.

    pageSizestring

    PageSize specifies the hugepage size, for x86_64 architecture valid values are 1Gi and 2Mi.

    resources

    object

    limitsobject

    Limits describes the maximum amount of compute resources allowed. Valid resource keys are "memory" and "cpu".

    overcommitGuestOverheadboolean

    Don't ask the scheduler to take the guest-management overhead into account. Instead put the overhead only into the container's memory limit. This can lead to crashes if all memory is in use on a node. Defaults to false.

    requestsobject

    Requests is a description of the initial vmi resources. Valid resource keys are "memory" and "cpu".

    evictionStrategystring

    EvictionStrategy can be set to "LiveMigrate" if the VirtualMachineInstance should be migrated instead of shut-off in case of a node drain.

    hostnamestring

    Specifies the hostname of the vmi If not specified, the hostname will be set to the name of the vmi, if dhcp or cloud-init is configured properly.

    livenessProbe

    object

    Probe describes a health check to be performed against a VirtualMachineInstance to determine whether it is alive or ready to receive traffic.

    exec

    object

    ExecAction describes a "run in container" action.

    commandstring[]

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    failureThresholdint32

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    guestAgentPingobject

    GuestAgentPing configures the guest-agent based ping probe

    httpGet

    object

    HTTPGetAction describes an action based on HTTP Get requests.

    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeaders

    object[]

    Custom headers to set in the request. HTTP allows repeated headers.

  • Array [

  • namestringrequired

    The header field name

    valuestringrequired

    The header field value

  • ]

  • pathstring

    Path to access on the HTTP server.

    port

    object

    required

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    oneOf

    string

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    initialDelaySecondsint32

    Number of seconds after the VirtualMachineInstance has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    periodSecondsint32

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    successThresholdint32

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

    tcpSocket

    object

    TCPSocketAction describes an action based on opening a socket

    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    object

    required

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    oneOf

    string

    timeoutSecondsint32

    Number of seconds after which the probe times out. For exec probes the timeout fails the probe but does not terminate the command running on the guest. This means a blocking command can result in an increasing load on the guest. A small buffer will be added to the resulting workload exec probe to compensate for delays caused by the qemu guest exec mechanism. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    networks

    object[]

    List of networks that can be attached to a vm's virtual interface.

  • Array [

  • multus

    object

    Represents the multus cni network.

    defaultboolean

    Select the default network and add it to the multus-cni.io/default-network annotation.

    networkNamestringrequired

    References to a NetworkAttachmentDefinition CRD object. Format: , /. If namespace is not specified, VMI namespace is assumed.

    namestringrequired

    Network name. Must be a DNS_LABEL and unique within the vm. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    pod

    object

    Represents the stock pod network interface.

    vmIPv6NetworkCIDRstring

    IPv6 CIDR for the vm network. Defaults to fd10:0:2::/120 if not specified.

    vmNetworkCIDRstring

    CIDR for vm network. Default 10.0.2.0/24 if not specified.

  • ]

  • nodeSelector

    object

    NodeSelector is a selector which must be true for the vmi to fit on a node. Selector which must match a node's labels for the vmi to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

    property name*string
    priorityClassNamestring

    If specified, indicates the pod's priority. If not specified, the pod priority will be default or zero if there is no default.

    readinessProbe

    object

    Probe describes a health check to be performed against a VirtualMachineInstance to determine whether it is alive or ready to receive traffic.

    exec

    object

    ExecAction describes a "run in container" action.

    commandstring[]

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    failureThresholdint32

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    guestAgentPingobject

    GuestAgentPing configures the guest-agent based ping probe

    httpGet

    object

    HTTPGetAction describes an action based on HTTP Get requests.

    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeaders

    object[]

    Custom headers to set in the request. HTTP allows repeated headers.

  • Array [

  • namestringrequired

    The header field name

    valuestringrequired

    The header field value

  • ]

  • pathstring

    Path to access on the HTTP server.

    port

    object

    required

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    oneOf

    string

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    initialDelaySecondsint32

    Number of seconds after the VirtualMachineInstance has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    periodSecondsint32

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    successThresholdint32

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

    tcpSocket

    object

    TCPSocketAction describes an action based on opening a socket

    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    object

    required

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    oneOf

    string

    timeoutSecondsint32

    Number of seconds after which the probe times out. For exec probes the timeout fails the probe but does not terminate the command running on the guest. This means a blocking command can result in an increasing load on the guest. A small buffer will be added to the resulting workload exec probe to compensate for delays caused by the qemu guest exec mechanism. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    schedulerNamestring

    If specified, the VMI will be dispatched by specified scheduler. If not specified, the VMI will be dispatched by default scheduler.

    startStrategystring

    StartStrategy can be set to "Paused" if Virtual Machine should be started in paused state.

    subdomainstring

    If specified, the fully qualified vmi hostname will be "...svc.". If not specified, the vmi will not have a domainname at all. The DNS entry will resolve to the vmi, no matter if the vmi itself can pick up a hostname.

    terminationGracePeriodSecondsint64

    Grace period observed after signalling a VirtualMachineInstance to stop after which the VirtualMachineInstance is force terminated.

    tolerations

    object[]

    If toleration is specified, obey all the toleration rules.

  • Array [

  • effectstring

    Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

    keystring

    Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

    operatorstring

    Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

    tolerationSecondsint64

    TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

    valuestring

    Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

  • ]

  • topologySpreadConstraints

    object[]

    TopologySpreadConstraints describes how a group of VMIs will be spread across a given topology domains. K8s scheduler will schedule VMI pods in a way which abides by the constraints.

  • Array [

  • labelSelector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions

    object[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

  • Array [

  • keystringrequired

    key is the label key that the selector applies to.

    operatorstringrequired

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesstring[]

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

  • ]

  • matchLabels

    object

    matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    property name*string
    maxSkewint32required

    MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

    topologyKeystringrequired

    TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.

    whenUnsatisfiablestringrequired

    WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

  • ]

  • volumes

    object[]

    List of volumes that can be mounted by disks belonging to the vmi.

  • Array [

  • cloudInitConfigDrive

    object

    Represents a cloud-init config drive user data source. More info: https://cloudinit.readthedocs.io/en/latest/topics/datasources/configdrive.html

    networkDatastring

    NetworkData contains config drive inline cloud-init networkdata.

    networkDataBase64string

    NetworkDataBase64 contains config drive cloud-init networkdata as a base64 encoded string.

    networkDataSecretRef

    object

    LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    secretRef

    object

    LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    userDatastring

    UserData contains config drive inline cloud-init userdata.

    userDataBase64string

    UserDataBase64 contains config drive cloud-init userdata as a base64 encoded string.

    cloudInitNoCloud

    object

    Represents a cloud-init nocloud user data source. More info: http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html

    networkDatastring

    NetworkData contains NoCloud inline cloud-init networkdata.

    networkDataBase64string

    NetworkDataBase64 contains NoCloud cloud-init networkdata as a base64 encoded string.

    networkDataSecretRef

    object

    LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    secretRef

    object

    LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    userDatastring

    UserData contains NoCloud inline cloud-init userdata.

    userDataBase64string

    UserDataBase64 contains NoCloud cloud-init userdata as a base64 encoded string.

    configMap

    object

    ConfigMapVolumeSource adapts a ConfigMap into a volume. More info: https://kubernetes.io/docs/concepts/storage/volumes/#configmap

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    Specify whether the ConfigMap or it's keys must be defined

    volumeLabelstring

    The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).

    containerDisk

    object

    Represents a docker image with an embedded disk.

    imagestringrequired

    Image is the name of the image with the embedded disk.

    imagePullPolicystring

    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

    imagePullSecretstring

    ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.

    pathstring

    Path defines the path to disk file in the container

    dataVolume

    object

    hotpluggableboolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

    namestringrequired

    Name of both the DataVolume and the PVC in the same namespace. After PVC population the DataVolume is garbage collected by default.

    downwardAPI

    object

    DownwardAPIVolumeSource represents a volume containing downward API info.

    fields

    object[]

    Fields is a list of downward API volume file

  • Array [

  • fieldRef

    object

    ObjectFieldSelector selects an APIVersioned field of an object.

    apiVersionstring

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

    fieldPathstringrequired

    Path of the field to select in the specified API version.

    modeint32

    Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstringrequired

    Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

    resourceFieldRef

    object

    ResourceFieldSelector represents container resources (cpu, memory) and their output format

    containerNamestring

    Container name: required for volumes, optional for env vars

    divisorstring

    Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

    The serialization format is:

    ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E"

    No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

    When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

    Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

    Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

    Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

    Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

    This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

    resourcestringrequired

    Required: resource to select

  • ]

  • volumeLabelstring

    The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).

    downwardMetricsobject

    DownwardMetricsVolumeSource adds a very small disk to VMIs which contains a limited view of host and guest metrics. The disk content is compatible with vhostmd (https://github.com/vhostmd/vhostmd) and vm-dump-metrics.

    emptyDisk

    object

    EmptyDisk represents a temporary disk which shares the vmis lifecycle.

    capacitystringrequired

    Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

    The serialization format is:

    ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E"

    No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

    When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

    Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

    Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

    Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

    Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

    This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

    ephemeral

    object

    persistentVolumeClaim

    object

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Directly attached to the vmi via qemu. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    claimNamestringrequired

    ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    hotpluggableboolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

    readOnlyboolean

    Will force the ReadOnly setting in VolumeMounts. Default false.

    hostDisk

    object

    Represents a disk created on the cluster level

    capacitystring

    Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

    The serialization format is:

    ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E"

    No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

    When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

    Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

    Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

    Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

    Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

    This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

    pathstringrequired

    The path to HostDisk image located on the cluster

    sharedboolean

    Shared indicate whether the path is shared between nodes

    typestringrequired

    Contains information if disk.img exists or should be created allowed options are 'Disk' and 'DiskOrCreate'

    memoryDump

    object

    claimNamestringrequired

    ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    hotpluggableboolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

    readOnlyboolean

    Will force the ReadOnly setting in VolumeMounts. Default false.

    namestringrequired

    Volume's name. Must be a DNS_LABEL and unique within the vmi. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    persistentVolumeClaim

    object

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Directly attached to the vmi via qemu. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    claimNamestringrequired

    ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    hotpluggableboolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

    readOnlyboolean

    Will force the ReadOnly setting in VolumeMounts. Default false.

    secret

    object

    SecretVolumeSource adapts a Secret into a volume.

    optionalboolean

    Specify whether the Secret or it's keys must be defined

    secretNamestring

    Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

    volumeLabelstring

    The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).

    serviceAccount

    object

    ServiceAccountVolumeSource adapts a ServiceAccount into a volume.

    serviceAccountNamestring

    Name of the service account in the pod's namespace to use. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

    sysprep

    object

    Represents a Sysprep volume source.

    configMap

    object

    LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    secret

    object

    LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • ]

  • status

    object

    nullable

    VirtualMachineStatus represents the status returned by the controller to describe how the VirtualMachine is doing

    conditions

    object[]

    Hold the state information of the VirtualMachine and its VirtualMachineInstance

  • Array [

  • lastProbeTimestring
    lastTransitionTimestring
    messagestring
    reasonstring
    statusstringrequired
    typestringrequired
  • ]

  • createdboolean

    Created indicates if the virtual machine is created in the cluster

    memoryDumpRequest

    object

    VirtualMachineMemoryDumpRequest represent the memory dump request phase and info

    claimNamestringrequired

    ClaimName is the name of the pvc that will contain the memory dump

    endTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    fileNamestring

    FileName represents the name of the output file

    messagestring

    Message is a detailed message about failure of the memory dump

    phasestringrequired

    Phase represents the memory dump phase

    removeboolean

    Remove represents request of dissociating the memory dump pvc

    startTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    printableStatusstring

    PrintableStatus is a human readable, high-level representation of the status of the virtual machine

    readyboolean

    Ready indicates if the virtual machine is running and ready

    restoreInProgressstring

    RestoreInProgress is the name of the VirtualMachineRestore currently executing

    snapshotInProgressstring

    SnapshotInProgress is the name of the VirtualMachineSnapshot currently executing

    startFailure

    object

    VirtualMachineStartFailure tracks VMIs which failed to transition successfully to running using the VM status

    consecutiveFailCountint32
    lastFailedVMIUIDstring
    retryAfterTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    stateChangeRequests

    object[]

    StateChangeRequests indicates a list of actions that should be taken on a VMI e.g. stop a specific VMI then start a new one.

  • Array [

  • actionstringrequired

    Indicates the type of action that is requested. e.g. Start or Stop

    data

    object

    Provides additional data in order to perform the Action

    property name*string
    uidstring

    Indicates the UUID of an existing Virtual Machine Instance that this change request applies to -- if applicable

  • ]

  • volumeRequests

    object[]

    VolumeRequests indicates a list of volumes add or remove from the VMI template and hotplug on an active running VMI.

  • Array [

  • addVolumeOptions

    object

    AddVolumeOptions is provided when dynamically hot plugging a volume and disk

    disk

    object

    required

    blockSize

    object

    BlockSize provides the option to change the block size presented to the VM for a disk. Only one of its members may be specified.

    custom

    object

    CustomBlockSize represents the desired logical and physical block size for a VM disk.

    logicalint32required
    physicalint32required

    matchVolume

    object

    Represents if a feature is enabled or disabled.

    enabledboolean

    Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.

    bootOrderint32

    BootOrder is an integer value > 0, used to determine ordering of boot devices. Lower values take precedence. Each disk or interface that has a boot order must have a unique value. Disks without a boot order are not tried if a disk with a boot order exists.

    cachestring

    Cache specifies which kvm disk cache mode should be used. Supported values are: CacheNone, CacheWriteThrough.

    cdrom

    object

    busstring

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

    readonlyboolean

    ReadOnly. Defaults to true.

    traystring

    Tray indicates if the tray of the device is open or closed. Allowed values are "open" and "closed". Defaults to closed.

    dedicatedIOThreadboolean

    dedicatedIOThread indicates this disk should have an exclusive IO Thread. Enabling this implies useIOThreads = true. Defaults to false.

    disk

    object

    busstring

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi, usb.

    pciAddressstring

    If specified, the virtual disk will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10

    readonlyboolean

    ReadOnly. Defaults to false.

    iostring

    IO specifies which QEMU disk IO mode should be used. Supported values are: native, default, threads.

    lun

    object

    busstring

    Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.

    readonlyboolean

    ReadOnly. Defaults to false.

    namestringrequired

    Name is the device name

    serialstring

    Serial provides the ability to specify a serial number for the disk device.

    shareableboolean

    If specified the disk is made sharable and multiple write from different VMs are permitted

    tagstring

    If specified, disk address and its tag will be provided to the guest via config drive metadata

    dryRunstring[]

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    namestringrequired

    Name represents the name that will be used to map the disk to the corresponding volume. This overrides any name set inside the Disk struct itself.

    volumeSource

    object

    required

    HotplugVolumeSource Represents the source of a volume to mount which are capable of being hotplugged on a live running VMI. Only one of its members may be specified.

    dataVolume

    object

    hotpluggableboolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

    namestringrequired

    Name of both the DataVolume and the PVC in the same namespace. After PVC population the DataVolume is garbage collected by default.

    persistentVolumeClaim

    object

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Directly attached to the vmi via qemu. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    claimNamestringrequired

    ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    hotpluggableboolean

    Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.

    readOnlyboolean

    Will force the ReadOnly setting in VolumeMounts. Default false.

    removeVolumeOptions

    object

    RemoveVolumeOptions is provided when dynamically hot unplugging volume and disk

    dryRunstring[]

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    namestringrequired

    Name represents the name that maps to both the disk and volume that should be removed

  • ]

  • volumeSnapshotStatuses

    object[]

    VolumeSnapshotStatuses indicates a list of statuses whether snapshotting is supported by each volume.

  • Array [

  • enabledbooleanrequired

    True if the volume supports snapshotting

    namestringrequired

    Volume name

    reasonstring

    Empty if snapshotting is enabled, contains reason otherwise

  • ]

Loading...