vynil/addons
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
unstable
addons/crd/kubevirt/apiextensions.k8s.io_v1_CustomResourceDefinition_virtualmachinesnapshotcontents.snapshot.kubevirt.io.yaml

3085 lines
273 KiB
YAML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
kubevirt.io/generation: "1"
kubevirt.io/install-strategy-identifier: c51bc47ef3eccba54f764552d24801eb8388b36e
kubevirt.io/install-strategy-registry: quay.io/kubevirt
kubevirt.io/install-strategy-version: v1.0.1
generation: 1
labels:
app.kubernetes.io/component: kubevirt
app.kubernetes.io/managed-by: virt-operator
kubevirt.io: ""
name: virtualmachinesnapshotcontents.snapshot.kubevirt.io
spec:
conversion:
strategy: None
group: snapshot.kubevirt.io
names:
categories:
- all
kind: VirtualMachineSnapshotContent
listKind: VirtualMachineSnapshotContentList
plural: virtualmachinesnapshotcontents
shortNames:
- vmsnapshotcontent
- vmsnapshotcontents
singular: virtualmachinesnapshotcontent
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .status.readyToUse
name: ReadyToUse
type: boolean
- jsonPath: .status.creationTime
name: CreationTime
type: date
- jsonPath: .status.error.message
name: Error
type: string
name: v1alpha1
schema:
openAPIV3Schema:
description: VirtualMachineSnapshotContent contains the snapshot data
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: VirtualMachineSnapshotContentSpec is the spec for a VirtualMachineSnapshotContent resource
properties:
source:
description: SourceSpec contains the appropriate spec for the resource being snapshotted
properties:
virtualMachine:
properties:
metadata:
nullable: true
type: object
x-kubernetes-preserve-unknown-fields: true
spec:
description: VirtualMachineSpec contains the VirtualMachine specification.
properties:
dataVolumeTemplates:
description: 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.
items:
nullable: true
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
nullable: true
type: object
x-kubernetes-preserve-unknown-fields: true
spec:
description: DataVolumeSpec contains the DataVolume specification.
properties:
checkpoints:
description: Checkpoints is a list of DataVolumeCheckpoints, representing stages in a multistage import.
items:
description: DataVolumeCheckpoint defines a stage in a warm migration.
properties:
current:
description: Current is the identifier of the snapshot created for this checkpoint.
type: string
previous:
description: Previous is the identifier of the snapshot from the previous checkpoint.
type: string
required:
- current
- previous
type: object
type: array
contentType:
description: 'DataVolumeContentType options: "kubevirt", "archive"'
enum:
- kubevirt
- archive
type: string
finalCheckpoint:
description: FinalCheckpoint indicates whether the current DataVolumeCheckpoint is the final checkpoint.
type: boolean
preallocation:
description: Preallocation controls whether storage for DataVolumes should be allocated in advance.
type: boolean
priorityClassName:
description: PriorityClassName for Importer, Cloner and Uploader pod
type: string
pvc:
description: PVC is the PVC specification
properties:
accessModes:
description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
description: 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.
type: string
kind:
description: Kind is the type of resource being referenced
type: string
name:
description: Name is the name of resource being referenced
type: string
required:
- kind
- name
type: object
dataSourceRef:
description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
description: 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.
type: string
kind:
description: Kind is the type of resource being referenced
type: string
name:
description: Name is the name of resource being referenced
type: string
namespace:
description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: '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/'
type: object
type: object
selector:
description: selector is a label query over volumes to consider for binding.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
storageClassName:
description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
description: volumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
source:
description: Source is the src of the data for the requested DataVolume
properties:
blank:
description: DataVolumeBlankImage provides the parameters to create a new raw blank image for the PVC
type: object
gcs:
description: DataVolumeSourceGCS provides the parameters to create a Data Volume from an GCS source
properties:
secretRef:
description: SecretRef provides the secret reference needed to access the GCS source
type: string
url:
description: URL is the url of the GCS source
type: string
required:
- url
type: object
http:
description: 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
properties:
certConfigMap:
description: CertConfigMap is a configmap reference, containing a Certificate Authority(CA) public key, and a base64 encoded pem certificate
type: string
extraHeaders:
description: ExtraHeaders is a list of strings containing extra headers to include with HTTP transfer requests
items:
type: string
type: array
secretExtraHeaders:
description: SecretExtraHeaders is a list of Secret references, each containing an extra HTTP header that may include sensitive information
items:
type: string
type: array
secretRef:
description: SecretRef A Secret reference, the secret should contain accessKeyId (user name) base64 encoded, and secretKey (password) also base64 encoded
type: string
url:
description: URL is the URL of the http(s) endpoint
type: string
required:
- url
type: object
imageio:
description: DataVolumeSourceImageIO provides the parameters to create a Data Volume from an imageio source
properties:
certConfigMap:
description: CertConfigMap provides a reference to the CA cert
type: string
diskId:
description: DiskID provides id of a disk to be imported
type: string
secretRef:
description: SecretRef provides the secret reference needed to access the ovirt-engine
type: string
url:
description: URL is the URL of the ovirt-engine
type: string
required:
- diskId
- url
type: object
pvc:
description: DataVolumeSourcePVC provides the parameters to create a Data Volume from an existing PVC
properties:
name:
description: The name of the source PVC
type: string
namespace:
description: The namespace of the source PVC
type: string
required:
- name
- namespace
type: object
registry:
description: DataVolumeSourceRegistry provides the parameters to create a Data Volume from an registry source
properties:
certConfigMap:
description: CertConfigMap provides a reference to the Registry certs
type: string
imageStream:
description: ImageStream is the name of image stream for import
type: string
pullMethod:
description: PullMethod can be either "pod" (default import), or "node" (node docker cache based import)
type: string
secretRef:
description: SecretRef provides the secret reference needed to access the Registry source
type: string
url:
description: 'URL is the url of the registry source (starting with the scheme: docker, oci-archive)'
type: string
type: object
s3:
description: DataVolumeSourceS3 provides the parameters to create a Data Volume from an S3 source
properties:
certConfigMap:
description: CertConfigMap is a configmap reference, containing a Certificate Authority(CA) public key, and a base64 encoded pem certificate
type: string
secretRef:
description: SecretRef provides the secret reference needed to access the S3 source
type: string
url:
description: URL is the url of the S3 source
type: string
required:
- url
type: object
snapshot:
description: DataVolumeSourceSnapshot provides the parameters to create a Data Volume from an existing VolumeSnapshot
properties:
name:
description: The name of the source VolumeSnapshot
type: string
namespace:
description: The namespace of the source VolumeSnapshot
type: string
required:
- name
- namespace
type: object
upload:
description: DataVolumeSourceUpload provides the parameters to create a Data Volume by uploading the source
type: object
vddk:
description: DataVolumeSourceVDDK provides the parameters to create a Data Volume from a Vmware source
properties:
backingFile:
description: BackingFile is the path to the virtual hard disk to migrate from vCenter/ESXi
type: string
initImageURL:
description: InitImageURL is an optional URL to an image containing an extracted VDDK library, overrides v2v-vmware config map
type: string
secretRef:
description: SecretRef provides a reference to a secret containing the username and password needed to access the vCenter or ESXi host
type: string
thumbprint:
description: Thumbprint is the certificate thumbprint of the vCenter or ESXi host
type: string
url:
description: URL is the URL of the vCenter or ESXi host with the VM to migrate
type: string
uuid:
description: UUID is the UUID of the virtual machine that the backing file is attached to in vCenter/ESXi
type: string
type: object
type: object
sourceRef:
description: SourceRef is an indirect reference to the source of data for the requested DataVolume
properties:
kind:
description: The kind of the source reference, currently only "DataSource" is supported
type: string
name:
description: The name of the source reference
type: string
namespace:
description: The namespace of the source reference, defaults to the DataVolume namespace
type: string
required:
- kind
- name
type: object
storage:
description: Storage is the requested storage specification
properties:
accessModes:
description: 'AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.'
properties:
apiGroup:
description: 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.
type: string
kind:
description: Kind is the type of resource being referenced
type: string
name:
description: Name is the name of resource being referenced
type: string
required:
- kind
- name
type: object
dataSourceRef:
description: 'Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
description: 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.
type: string
kind:
description: Kind is the type of resource being referenced
type: string
name:
description: Name is the name of resource being referenced
type: string
namespace:
description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
description: 'Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: '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/'
type: object
type: object
selector:
description: A label query over volumes to consider for binding.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
storageClassName:
description: 'Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
description: VolumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
type: object
status:
description: DataVolumeTemplateDummyStatus is here simply for backwards compatibility with a previous API.
nullable: true
type: object
required:
- spec
type: object
type: array
instancetype:
description: InstancetypeMatcher references a instancetype that is used to fill fields in Template
properties:
inferFromVolume:
description: 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.
type: string
kind:
description: 'Kind specifies which instancetype resource is referenced. Allowed values are: "VirtualMachineInstancetype" and "VirtualMachineClusterInstancetype". If not specified, "VirtualMachineClusterInstancetype" is used by default.'
type: string
name:
description: Name is the name of the VirtualMachineInstancetype or VirtualMachineClusterInstancetype
type: string
revisionName:
description: 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.
type: string
type: object
liveUpdateFeatures:
description: LiveUpdateFeatures references a configuration of hotpluggable resources
properties:
cpu:
description: LiveUpdateCPU holds hotplug configuration for the CPU resource. Empty struct indicates that default will be used for maxSockets. Default is specified on cluster level. Absence of the struct means opt-out from CPU hotplug functionality.
properties:
maxSockets:
description: The maximum amount of sockets that can be hot-plugged to the Virtual Machine
format: int32
type: integer
type: object
type: object
preference:
description: PreferenceMatcher references a set of preference that is used to fill fields in Template
properties:
inferFromVolume:
description: 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.
type: string
kind:
description: 'Kind specifies which preference resource is referenced. Allowed values are: "VirtualMachinePreference" and "VirtualMachineClusterPreference". If not specified, "VirtualMachineClusterPreference" is used by default.'
type: string
name:
description: Name is the name of the VirtualMachinePreference or VirtualMachineClusterPreference
type: string
revisionName:
description: 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.
type: string
type: object
runStrategy:
description: Running state indicates the requested running state of the VirtualMachineInstance mutually exclusive with Running
type: string
running:
description: Running controls whether the associatied VirtualMachineInstance is created or not Mutually exclusive with RunStrategy
type: boolean
template:
description: Template is the direct specification of VirtualMachineInstance
properties:
metadata:
nullable: true
type: object
x-kubernetes-preserve-unknown-fields: true
spec:
description: VirtualMachineInstance Spec contains the VirtualMachineInstance specification.
properties:
accessCredentials:
description: Specifies a set of public keys to inject into the vm guest
items:
description: AccessCredential represents a credential source that can be used to authorize remote access to the vm guest Only one of its members may be specified.
properties:
sshPublicKey:
description: SSHPublicKey represents the source and method of applying a ssh public key into a guest virtual machine.
properties:
propagationMethod:
description: PropagationMethod represents how the public key is injected into the vm guest.
properties:
configDrive:
description: ConfigDrivePropagation means that the ssh public keys are injected into the VM using metadata using the configDrive cloud-init provider
type: object
qemuGuestAgent:
description: QemuGuestAgentAccessCredentailPropagation means ssh public keys are dynamically injected into the vm at runtime via the qemu guest agent. This feature requires the qemu guest agent to be running within the guest.
properties:
users:
description: Users represents a list of guest users that should have the ssh public keys added to their authorized_keys file.
items:
type: string
type: array
x-kubernetes-list-type: set
required:
- users
type: object
type: object
source:
description: Source represents where the public keys are pulled from
properties:
secret:
description: Secret means that the access credential is pulled from a kubernetes secret
properties:
secretName:
description: SecretName represents the name of the secret in the VMI's namespace
type: string
required:
- secretName
type: object
type: object
required:
- propagationMethod
- source
type: object
userPassword:
description: UserPassword represents the source and method for applying a guest user's password
properties:
propagationMethod:
description: propagationMethod represents how the user passwords are injected into the vm guest.
properties:
qemuGuestAgent:
description: QemuGuestAgentAccessCredentailPropagation means passwords are dynamically injected into the vm at runtime via the qemu guest agent. This feature requires the qemu guest agent to be running within the guest.
type: object
type: object
source:
description: Source represents where the user passwords are pulled from
properties:
secret:
description: Secret means that the access credential is pulled from a kubernetes secret
properties:
secretName:
description: SecretName represents the name of the secret in the VMI's namespace
type: string
required:
- secretName
type: object
type: object
required:
- propagationMethod
- source
type: object
type: object
type: array
x-kubernetes-list-type: atomic
affinity:
description: If affinity is specifies, obey all the affinity rules
properties:
nodeAffinity:
description: Describes node affinity scheduling rules for the pod.
properties:
preferredDuringSchedulingIgnoredDuringExecution:
description: 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.
items:
description: An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
properties:
preference:
description: A node selector term, associated with the corresponding weight.
properties:
matchExpressions:
description: A list of node selector requirements by node's labels.
items:
description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: The label key that the selector applies to.
type: string
operator:
description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchFields:
description: A list of node selector requirements by node's fields.
items:
description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: The label key that the selector applies to.
type: string
operator:
description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
type: object
weight:
description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
format: int32
type: integer
required:
- preference
- weight
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
description: 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 an update), the system may or may not try to eventually evict the pod from its node.
properties:
nodeSelectorTerms:
description: Required. A list of node selector terms. The terms are ORed.
items:
description: 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.
properties:
matchExpressions:
description: A list of node selector requirements by node's labels.
items:
description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: The label key that the selector applies to.
type: string
operator:
description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchFields:
description: A list of node selector requirements by node's fields.
items:
description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: The label key that the selector applies to.
type: string
operator:
description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
type: object
type: array
required:
- nodeSelectorTerms
type: object
type: object
podAffinity:
description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
description: 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.
items:
description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
description: Required. A pod affinity term, associated with the corresponding weight.
properties:
labelSelector:
description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
namespaceSelector:
description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
namespaces:
description: 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".
items:
type: string
type: array
topologyKey:
description: 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.
type: string
required:
- topologyKey
type: object
weight:
description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
format: int32
type: integer
required:
- podAffinityTerm
- weight
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
description: 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.
items:
description: 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
properties:
labelSelector:
description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
namespaceSelector:
description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
namespaces:
description: 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".
items:
type: string
type: array
topologyKey:
description: 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.
type: string
required:
- topologyKey
type: object
type: array
type: object
podAntiAffinity:
description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
description: 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.
items:
description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
properties:
podAffinityTerm:
description: Required. A pod affinity term, associated with the corresponding weight.
properties:
labelSelector:
description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
namespaceSelector:
description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
namespaces:
description: 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".
items:
type: string
type: array
topologyKey:
description: 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.
type: string
required:
- topologyKey
type: object
weight:
description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
format: int32
type: integer
required:
- podAffinityTerm
- weight
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
description: 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.
items:
description: 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
properties:
labelSelector:
description: A label query over a set of resources, in this case pods.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
namespaceSelector:
description: A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
namespaces:
description: 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".
items:
type: string
type: array
topologyKey:
description: 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.
type: string
required:
- topologyKey
type: object
type: array
type: object
type: object
architecture:
description: Specifies the architecture of the vm guest you are attempting to run. Defaults to the compiled architecture of the KubeVirt components
type: string
dnsConfig:
description: Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
properties:
nameservers:
description: A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
items:
type: string
type: array
options:
description: 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.
items:
description: PodDNSConfigOption defines DNS resolver options of a pod.
properties:
name:
description: Required.
type: string
value:
type: string
type: object
type: array
searches:
description: 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.
items:
type: string
type: array
type: object
dnsPolicy:
description: 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'.
type: string
domain:
description: Specification of the desired behavior of the VirtualMachineInstance on the host.
properties:
chassis:
description: Chassis specifies the chassis info passed to the domain.
properties:
asset:
type: string
manufacturer:
type: string
serial:
type: string
sku:
type: string
version:
type: string
type: object
clock:
description: Clock sets the clock and timers of the vmi.
properties:
timer:
description: Timer specifies whih timers are attached to the vmi.
properties:
hpet:
description: HPET (High Precision Event Timer) - multiple timers with periodic interrupts.
properties:
present:
description: Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.
type: boolean
tickPolicy:
description: TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "merge", "discard".
type: string
type: object
hyperv:
description: Hyperv (Hypervclock) - lets guests read the host’s wall clock time (paravirtualized). For windows guests.
properties:
present:
description: Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.
type: boolean
type: object
kvm:
description: "KVM \t(KVM clock) - lets guests read the host’s wall clock time (paravirtualized). For linux guests."
properties:
present:
description: Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.
type: boolean
type: object
pit:
description: PIT (Programmable Interval Timer) - a timer with periodic interrupts.
properties:
present:
description: Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.
type: boolean
tickPolicy:
description: TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup", "discard".
type: string
type: object
rtc:
description: RTC (Real Time Clock) - a continuously running timer with periodic interrupts.
properties:
present:
description: Enabled set to false makes sure that the machine type or a preset can't add the timer. Defaults to true.
type: boolean
tickPolicy:
description: TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest. One of "delay", "catchup".
type: string
track:
description: Track the guest or the wall clock.
type: string
type: object
type: object
timezone:
description: Timezone sets the guest clock to the specified timezone. Zone name follows the TZ environment variable format (e.g. 'America/New_York').
type: string
utc:
description: UTC sets the guest clock to UTC on each boot. If an offset is specified, guest changes to the clock will be kept during reboots and are not reset.
properties:
offsetSeconds:
description: OffsetSeconds specifies an offset in seconds, relative to UTC. If set, guest changes to the clock will be kept during reboots and not reset.
type: integer
type: object
type: object
cpu:
description: CPU allow specified the detailed CPU topology inside the vmi.
properties:
cores:
description: Cores specifies the number of cores inside the vmi. Must be a value greater or equal 1.
format: int32
type: integer
dedicatedCpuPlacement:
description: DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node with enough dedicated pCPUs and pin the vCPUs to it.
type: boolean
features:
description: Features specifies the CPU features list inside the VMI.
items:
description: CPUFeature allows specifying a CPU feature.
properties:
name:
description: Name of the CPU feature
type: string
policy:
description: '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'
type: string
required:
- name
type: object
type: array
isolateEmulatorThread:
description: IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place the emulator thread on it.
type: boolean
maxSockets:
description: MaxSockets specifies the maximum amount of sockets that can be hotplugged
format: int32
type: integer
model:
description: 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.
type: string
numa:
description: NUMA allows specifying settings for the guest NUMA topology
properties:
guestMappingPassthrough:
description: GuestMappingPassthrough will create an efficient guest topology based on host CPUs exclusively assigned to a pod. The created topology ensures that memory and CPUs on the virtual numa nodes never cross boundaries of host numa nodes.
type: object
type: object
realtime:
description: Realtime instructs the virt-launcher to tune the VMI for lower latency, optional for real time workloads
properties:
mask:
description: '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"'
type: string
type: object
sockets:
description: Sockets specifies the number of sockets inside the vmi. Must be a value greater or equal 1.
format: int32
type: integer
threads:
description: Threads specifies the number of threads inside the vmi. Must be a value greater or equal 1.
format: int32
type: integer
type: object
devices:
description: Devices allows adding disks, network interfaces, and others
properties:
autoattachGraphicsDevice:
description: Whether to attach the default graphics device or not. VNC will not be available if set to false. Defaults to true.
type: boolean
autoattachInputDevice:
description: Whether to attach an Input Device. Defaults to false.
type: boolean
autoattachMemBalloon:
description: Whether to attach the Memory balloon device with default period. Period can be adjusted in virt-config. Defaults to true.
type: boolean
autoattachPodInterface:
description: Whether to attach a pod network interface. Defaults to true.
type: boolean
autoattachSerialConsole:
description: Whether to attach the default serial console or not. Serial console access will not be available if set to false. Defaults to true.
type: boolean
autoattachVSOCK:
description: Whether to attach the VSOCK CID to the VM or not. VSOCK access will be available if set to true. Defaults to false.
type: boolean
blockMultiQueue:
description: Whether or not to enable virtio multi-queue for block devices. Defaults to false.
type: boolean
clientPassthrough:
description: To configure and access client devices such as redirecting USB
type: object
disableHotplug:
description: DisableHotplug disabled the ability to hotplug disks.
type: boolean
disks:
description: Disks describes disks, cdroms and luns which are connected to the vmi.
items:
properties:
blockSize:
description: If specified, the virtual disk will be presented with the given block sizes.
properties:
custom:
description: CustomBlockSize represents the desired logical and physical block size for a VM disk.
properties:
logical:
type: integer
physical:
type: integer
required:
- logical
- physical
type: object
matchVolume:
description: Represents if a feature is enabled or disabled.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
type: object
bootOrder:
description: 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.
type: integer
cache:
description: 'Cache specifies which kvm disk cache mode should be used. Supported values are: CacheNone, CacheWriteThrough.'
type: string
cdrom:
description: Attach a volume as a cdrom to the vmi.
properties:
bus:
description: 'Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.'
type: string
readonly:
description: ReadOnly. Defaults to true.
type: boolean
tray:
description: Tray indicates if the tray of the device is open or closed. Allowed values are "open" and "closed". Defaults to closed.
type: string
type: object
dedicatedIOThread:
description: dedicatedIOThread indicates this disk should have an exclusive IO Thread. Enabling this implies useIOThreads = true. Defaults to false.
type: boolean
disk:
description: Attach a volume as a disk to the vmi.
properties:
bus:
description: 'Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi, usb.'
type: string
pciAddress:
description: 'If specified, the virtual disk will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10'
type: string
readonly:
description: ReadOnly. Defaults to false.
type: boolean
type: object
io:
description: 'IO specifies which QEMU disk IO mode should be used. Supported values are: native, default, threads.'
type: string
lun:
description: Attach a volume as a LUN to the vmi.
properties:
bus:
description: 'Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.'
type: string
readonly:
description: ReadOnly. Defaults to false.
type: boolean
reservation:
description: Reservation indicates if the disk needs to support the persistent reservation for the SCSI disk
type: boolean
type: object
name:
description: Name is the device name
type: string
serial:
description: Serial provides the ability to specify a serial number for the disk device.
type: string
shareable:
description: If specified the disk is made sharable and multiple write from different VMs are permitted
type: boolean
tag:
description: If specified, disk address and its tag will be provided to the guest via config drive metadata
type: string
required:
- name
type: object
type: array
filesystems:
description: Filesystems describes filesystem which is connected to the vmi.
items:
properties:
name:
description: Name is the device name
type: string
virtiofs:
description: Virtiofs is supported
type: object
required:
- name
- virtiofs
type: object
type: array
x-kubernetes-list-type: atomic
gpus:
description: Whether to attach a GPU device to the vmi.
items:
properties:
deviceName:
type: string
name:
description: Name of the GPU device as exposed by a device plugin
type: string
tag:
description: If specified, the virtual network interface address and its tag will be provided to the guest via config drive
type: string
virtualGPUOptions:
properties:
display:
properties:
enabled:
description: Enabled determines if a display addapter backed by a vGPU should be enabled or disabled on the guest. Defaults to true.
type: boolean
ramFB:
description: Enables a boot framebuffer, until the guest OS loads a real GPU driver Defaults to true.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
type: object
type: object
required:
- deviceName
- name
type: object
type: array
x-kubernetes-list-type: atomic
hostDevices:
description: Whether to attach a host device to the vmi.
items:
properties:
deviceName:
description: DeviceName is the resource name of the host device exposed by a device plugin
type: string
name:
type: string
tag:
description: If specified, the virtual network interface address and its tag will be provided to the guest via config drive
type: string
required:
- deviceName
- name
type: object
type: array
x-kubernetes-list-type: atomic
inputs:
description: Inputs describe input devices
items:
properties:
bus:
description: 'Bus indicates the bus of input device to emulate. Supported values: virtio, usb.'
type: string
name:
description: Name is the device name
type: string
type:
description: 'Type indicated the type of input device. Supported values: tablet.'
type: string
required:
- name
- type
type: object
type: array
interfaces:
description: Interfaces describe network interfaces which are added to the vmi.
items:
properties:
acpiIndex:
description: 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).
type: integer
bootOrder:
description: 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.
type: integer
bridge:
description: InterfaceBridge connects to a given network via a linux bridge.
type: object
dhcpOptions:
description: If specified the network interface will pass additional DHCP options to the VMI
properties:
bootFileName:
description: If specified will pass option 67 to interface's DHCP server
type: string
ntpServers:
description: If specified will pass the configured NTP server to the VM via DHCP option 042.
items:
type: string
type: array
privateOptions:
description: 'If specified will pass extra DHCP options for private use, range: 224-254'
items:
description: DHCPExtraOptions defines Extra DHCP options for a VM.
properties:
option:
description: Option is an Integer value from 224-254 Required.
type: integer
value:
description: Value is a String value for the Option provided Required.
type: string
required:
- option
- value
type: object
type: array
tftpServerName:
description: If specified will pass option 66 to interface's DHCP server
type: string
type: object
macAddress:
description: 'Interface MAC address. For example: de:ad:00:00:be:af or DE-AD-00-00-BE-AF.'
type: string
macvtap:
description: InterfaceMacvtap connects to a given network by extending the Kubernetes node's L2 networks via a macvtap interface.
type: object
masquerade:
description: InterfaceMasquerade connects to a given network using netfilter rules to nat the traffic.
type: object
model:
description: 'Interface model. One of: e1000, e1000e, ne2k_pci, pcnet, rtl8139, virtio. Defaults to virtio. TODO:(ihar) switch to enums once opengen-api supports them. See: https://github.com/kubernetes/kube-openapi/issues/51'
type: string
name:
description: Logical name of the interface as well as a reference to the associated networks. Must match the Name of a Network.
type: string
passt:
description: InterfacePasst connects to a given network.
type: object
pciAddress:
description: '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'
type: string
ports:
description: List of ports to be forwarded to the virtual machine.
items:
description: Port represents a port to expose from the virtual machine. Default protocol TCP. The port field is mandatory
properties:
name:
description: 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.
type: string
port:
description: Number of port to expose for the virtual machine. This must be a valid port number, 0 < x < 65536.
format: int32
type: integer
protocol:
description: Protocol for port. Must be UDP or TCP. Defaults to "TCP".
type: string
required:
- port
type: object
type: array
slirp:
description: InterfaceSlirp connects to a given network using QEMU user networking mode.
type: object
sriov:
description: InterfaceSRIOV connects to a given network by passing-through an SR-IOV PCI device via vfio.
type: object
state:
description: State represents the requested operational state of the interface. The (only) value supported is 'absent', expressing a request to remove the interface.
type: string
tag:
description: If specified, the virtual network interface address and its tag will be provided to the guest via config drive
type: string
required:
- name
type: object
type: array
networkInterfaceMultiqueue:
description: 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.
type: boolean
rng:
description: Whether to have random number generator from host
type: object
sound:
description: Whether to emulate a sound device.
properties:
model:
description: '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'
type: string
name:
description: User's defined name for this sound device
type: string
required:
- name
type: object
tpm:
description: Whether to emulate a TPM device.
properties:
persistent:
description: Persistent indicates the state of the TPM device should be kept accross reboots Defaults to false
type: boolean
type: object
useVirtioTransitional:
description: 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).
type: boolean
watchdog:
description: Watchdog describes a watchdog device which can be added to the vmi.
properties:
i6300esb:
description: i6300esb watchdog device.
properties:
action:
description: The action to take. Valid values are poweroff, reset, shutdown. Defaults to reset.
type: string
type: object
name:
description: Name of the watchdog.
type: string
required:
- name
type: object
type: object
features:
description: Features like acpi, apic, hyperv, smm.
properties:
acpi:
description: ACPI enables/disables ACPI inside the guest. Defaults to enabled.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
apic:
description: Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
endOfInterrupt:
description: EndOfInterrupt enables the end of interrupt notification in the guest. Defaults to false.
type: boolean
type: object
hyperv:
description: Defaults to the machine type setting.
properties:
evmcs:
description: EVMCS Speeds up L2 vmexits, but disables other virtualization features. Requires vapic. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
frequencies:
description: Frequencies improves the TSC clock source handling for Hyper-V on KVM. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
ipi:
description: IPI improves performances in overcommited environments. Requires vpindex. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
reenlightenment:
description: Reenlightenment enables the notifications on TSC frequency changes. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
relaxed:
description: Relaxed instructs the guest OS to disable watchdog timeouts. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
reset:
description: Reset enables Hyperv reboot/reset for the vmi. Requires synic. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
runtime:
description: Runtime improves the time accounting to improve scheduling in the guest. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
spinlocks:
description: Spinlocks allows to configure the spinlock retry attempts.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
spinlocks:
description: Retries indicates the number of retries. Must be a value greater or equal 4096. Defaults to 4096.
format: int32
type: integer
type: object
synic:
description: SyNIC enables the Synthetic Interrupt Controller. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
synictimer:
description: SyNICTimer enables Synthetic Interrupt Controller Timers, reducing CPU load. Defaults to the machine type setting.
properties:
direct:
description: Represents if a feature is enabled or disabled.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
enabled:
type: boolean
type: object
tlbflush:
description: TLBFlush improves performances in overcommited environments. Requires vpindex. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
vapic:
description: VAPIC improves the paravirtualized handling of interrupts. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
vendorid:
description: VendorID allows setting the hypervisor vendor id. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
vendorid:
description: VendorID sets the hypervisor vendor id, visible to the vmi. String up to twelve characters.
type: string
type: object
vpindex:
description: VPIndex enables the Virtual Processor Index to help windows identifying virtual processors. Defaults to the machine type setting.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
type: object
kvm:
description: Configure how KVM presence is exposed to the guest.
properties:
hidden:
description: Hide the KVM hypervisor from standard MSR based discovery. Defaults to false
type: boolean
type: object
pvspinlock:
description: Notify the guest that the host supports paravirtual spinlocks. For older kernels this feature should be explicitly disabled.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
smm:
description: SMM enables/disables System Management Mode. TSEG not yet implemented.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
type: object
firmware:
description: Firmware.
properties:
bootloader:
description: Settings to control the bootloader that is used.
properties:
bios:
description: If set (default), BIOS will be used.
properties:
useSerial:
description: If set, the BIOS output will be transmitted over serial
type: boolean
type: object
efi:
description: If set, EFI will be used instead of BIOS.
properties:
secureBoot:
description: 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
type: boolean
type: object
type: object
kernelBoot:
description: Settings to set the kernel for booting.
properties:
container:
description: Container defines the container that containes kernel artifacts
properties:
image:
description: Image that contains initrd / kernel files.
type: string
imagePullPolicy:
description: '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'
type: string
imagePullSecret:
description: ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.
type: string
initrdPath:
description: the fully-qualified path to the ramdisk image in the host OS
type: string
kernelPath:
description: The fully-qualified path to the kernel image in the host OS
type: string
required:
- image
type: object
kernelArgs:
description: Arguments to be passed to the kernel at boot time
type: string
type: object
serial:
description: The system-serial-number in SMBIOS
type: string
uuid:
description: UUID reported by the vmi bios. Defaults to a random generated uid.
type: string
type: object
ioThreadsPolicy:
description: 'Controls whether or not disks will share IOThreads. Omitting IOThreadsPolicy disables use of IOThreads. One of: shared, auto'
type: string
launchSecurity:
description: Launch Security setting of the vmi.
properties:
sev:
description: AMD Secure Encrypted Virtualization (SEV).
properties:
policy:
description: 'Guest policy flags as defined in AMD SEV API specification. Note: due to security reasons it is not allowed to enable guest debugging. Therefore NoDebug flag is not exposed to users and is always true.'
properties:
encryptedState:
description: SEV-ES is required. Defaults to false.
type: boolean
type: object
type: object
type: object
machine:
description: Machine type.
properties:
type:
description: QEMU machine type is the actual chipset of the VirtualMachineInstance.
type: string
type: object
memory:
description: Memory allow specifying the VMI memory features.
properties:
guest:
anyOf:
- type: integer
- type: string
description: Guest allows to specifying the amount of memory which is visible inside the Guest OS. The Guest must lie between Requests and Limits from the resources section. Defaults to the requested memory in the resources section if not specified.
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
hugepages:
description: Hugepages allow to use hugepages for the VirtualMachineInstance instead of regular memory.
properties:
pageSize:
description: PageSize specifies the hugepage size, for x86_64 architecture valid values are 1Gi and 2Mi.
type: string
type: object
type: object
resources:
description: Resources describes the Compute Resources required by this vmi.
properties:
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: Limits describes the maximum amount of compute resources allowed. Valid resource keys are "memory" and "cpu".
type: object
overcommitGuestOverhead:
description: 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.
type: boolean
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: Requests is a description of the initial vmi resources. Valid resource keys are "memory" and "cpu".
type: object
type: object
required:
- devices
type: object
evictionStrategy:
description: EvictionStrategy can be set to "LiveMigrate" if the VirtualMachineInstance should be migrated instead of shut-off in case of a node drain.
type: string
hostname:
description: 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.
type: string
livenessProbe:
description: 'Periodic probe of VirtualMachineInstance liveness. VirtualmachineInstances will be stopped if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: One and only one of the following should be specified. Exec specifies the action to take, it will be executed on the guest through the qemu-guest-agent. If the guest agent is not available, this probe will fail.
properties:
command:
description: 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.
items:
type: string
type: array
type: object
failureThreshold:
description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
guestAgentPing:
description: GuestAgentPing contacts the qemu-guest-agent for availability checks.
type: object
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request. HTTP allows repeated headers.
items:
description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
type: string
value:
description: The header field value
type: string
required:
- name
- value
type: object
type: array
path:
description: Path to access on the HTTP server.
type: string
port:
anyOf:
- type: integer
- type: string
description: 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.
x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
description: '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'
format: int32
type: integer
periodSeconds:
description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
description: 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.
format: int32
type: integer
tcpSocket:
description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
description: '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'
format: int32
type: integer
type: object
networks:
description: List of networks that can be attached to a vm's virtual interface.
items:
description: Network represents a network type and a resource that should be connected to the vm.
properties:
multus:
description: Represents the multus cni network.
properties:
default:
description: Select the default network and add it to the multus-cni.io/default-network annotation.
type: boolean
networkName:
description: 'References to a NetworkAttachmentDefinition CRD object. Format: <networkName>, <namespace>/<networkName>. If namespace is not specified, VMI namespace is assumed.'
type: string
required:
- networkName
type: object
name:
description: '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'
type: string
pod:
description: Represents the stock pod network interface.
properties:
vmIPv6NetworkCIDR:
description: IPv6 CIDR for the vm network. Defaults to fd10:0:2::/120 if not specified.
type: string
vmNetworkCIDR:
description: CIDR for vm network. Default 10.0.2.0/24 if not specified.
type: string
type: object
required:
- name
type: object
type: array
nodeSelector:
additionalProperties:
type: string
description: '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/'
type: object
priorityClassName:
description: If specified, indicates the pod's priority. If not specified, the pod priority will be default or zero if there is no default.
type: string
readinessProbe:
description: 'Periodic probe of VirtualMachineInstance service readiness. VirtualmachineInstances will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes'
properties:
exec:
description: One and only one of the following should be specified. Exec specifies the action to take, it will be executed on the guest through the qemu-guest-agent. If the guest agent is not available, this probe will fail.
properties:
command:
description: 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.
items:
type: string
type: array
type: object
failureThreshold:
description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
format: int32
type: integer
guestAgentPing:
description: GuestAgentPing contacts the qemu-guest-agent for availability checks.
type: object
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
type: string
httpHeaders:
description: Custom headers to set in the request. HTTP allows repeated headers.
items:
description: HTTPHeader describes a custom header to be used in HTTP probes
properties:
name:
description: The header field name
type: string
value:
description: The header field value
type: string
required:
- name
- value
type: object
type: array
path:
description: Path to access on the HTTP server.
type: string
port:
anyOf:
- type: integer
- type: string
description: 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.
x-kubernetes-int-or-string: true
scheme:
description: Scheme to use for connecting to the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
description: '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'
format: int32
type: integer
periodSeconds:
description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
description: 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.
format: int32
type: integer
tcpSocket:
description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
properties:
host:
description: 'Optional: Host name to connect to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
description: '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'
format: int32
type: integer
type: object
schedulerName:
description: If specified, the VMI will be dispatched by specified scheduler. If not specified, the VMI will be dispatched by default scheduler.
type: string
startStrategy:
description: StartStrategy can be set to "Paused" if Virtual Machine should be started in paused state.
type: string
subdomain:
description: If specified, the fully qualified vmi hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". 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.
type: string
terminationGracePeriodSeconds:
description: Grace period observed after signalling a VirtualMachineInstance to stop after which the VirtualMachineInstance is force terminated.
format: int64
type: integer
tolerations:
description: If toleration is specified, obey all the toleration rules.
items:
description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
properties:
effect:
description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
type: string
key:
description: 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.
type: string
operator:
description: 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.
type: string
tolerationSeconds:
description: 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.
format: int64
type: integer
value:
description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
type: string
type: object
type: array
topologySpreadConstraints:
description: 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.
items:
description: TopologySpreadConstraint specifies how to spread matching pods among the given topology.
properties:
labelSelector:
description: LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
matchLabelKeys:
description: MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.
items:
type: string
type: array
x-kubernetes-list-type: atomic
maxSkew:
description: '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. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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.'
format: int32
type: integer
minDomains:
description: "MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. \n For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. \n This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default)."
format: int32
type: integer
nodeAffinityPolicy:
description: "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. \n If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."
type: string
nodeTaintsPolicy:
description: "NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. \n If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."
type: string
topologyKey:
description: 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. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field.
type: string
whenUnsatisfiable:
description: '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.'
type: string
required:
- maxSkew
- topologyKey
- whenUnsatisfiable
type: object
type: array
x-kubernetes-list-map-keys:
- topologyKey
- whenUnsatisfiable
x-kubernetes-list-type: map
volumes:
description: List of volumes that can be mounted by disks belonging to the vmi.
items:
description: Volume represents a named volume in a vmi.
properties:
cloudInitConfigDrive:
description: 'CloudInitConfigDrive represents a cloud-init Config Drive user-data source. The Config Drive data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest. More info: https://cloudinit.readthedocs.io/en/latest/topics/datasources/configdrive.html'
properties:
networkData:
description: NetworkData contains config drive inline cloud-init networkdata.
type: string
networkDataBase64:
description: NetworkDataBase64 contains config drive cloud-init networkdata as a base64 encoded string.
type: string
networkDataSecretRef:
description: NetworkDataSecretRef references a k8s secret that contains config drive networkdata.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
secretRef:
description: UserDataSecretRef references a k8s secret that contains config drive userdata.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
userData:
description: UserData contains config drive inline cloud-init userdata.
type: string
userDataBase64:
description: UserDataBase64 contains config drive cloud-init userdata as a base64 encoded string.
type: string
type: object
cloudInitNoCloud:
description: 'CloudInitNoCloud represents a cloud-init NoCloud user-data source. The NoCloud data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest. More info: http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html'
properties:
networkData:
description: NetworkData contains NoCloud inline cloud-init networkdata.
type: string
networkDataBase64:
description: NetworkDataBase64 contains NoCloud cloud-init networkdata as a base64 encoded string.
type: string
networkDataSecretRef:
description: NetworkDataSecretRef references a k8s secret that contains NoCloud networkdata.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
secretRef:
description: UserDataSecretRef references a k8s secret that contains NoCloud userdata.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
userData:
description: UserData contains NoCloud inline cloud-init userdata.
type: string
userDataBase64:
description: UserDataBase64 contains NoCloud cloud-init userdata as a base64 encoded string.
type: string
type: object
configMap:
description: 'ConfigMapSource represents a reference to a ConfigMap in the same namespace. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/'
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
description: Specify whether the ConfigMap or it's keys must be defined
type: boolean
volumeLabel:
description: 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).
type: string
type: object
containerDisk:
description: 'ContainerDisk references a docker image, embedding a qcow or raw disk. More info: https://kubevirt.gitbooks.io/user-guide/registry-disk.html'
properties:
image:
description: Image is the name of the image with the embedded disk.
type: string
imagePullPolicy:
description: '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'
type: string
imagePullSecret:
description: ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.
type: string
path:
description: Path defines the path to disk file in the container
type: string
required:
- image
type: object
dataVolume:
description: DataVolume represents the dynamic creation a PVC for this volume as well as the process of populating that PVC with a disk image.
properties:
hotpluggable:
description: Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.
type: boolean
name:
description: Name of both the DataVolume and the PVC in the same namespace. After PVC population the DataVolume is garbage collected by default.
type: string
required:
- name
type: object
downwardAPI:
description: DownwardAPI represents downward API about the pod that should populate this volume
properties:
fields:
description: Fields is a list of downward API volume file
items:
description: DownwardAPIVolumeFile represents information to create the file containing the pod field
properties:
fieldRef:
description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
properties:
apiVersion:
description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
type: string
fieldPath:
description: Path of the field to select in the specified API version.
type: string
required:
- fieldPath
type: object
mode:
description: '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.'
format: int32
type: integer
path:
description: '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 ''..'''
type: string
resourceFieldRef:
description: 'Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.'
properties:
containerName:
description: 'Container name: required for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
description: Specifies the output format of the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
description: 'Required: resource to select'
type: string
required:
- resource
type: object
required:
- path
type: object
type: array
volumeLabel:
description: 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).
type: string
type: object
downwardMetrics:
description: DownwardMetrics 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.
type: object
emptyDisk:
description: 'EmptyDisk represents a temporary disk which shares the vmis lifecycle. More info: https://kubevirt.gitbooks.io/user-guide/disks-and-volumes.html'
properties:
capacity:
anyOf:
- type: integer
- type: string
description: Capacity of the sparse disk.
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
required:
- capacity
type: object
ephemeral:
description: Ephemeral is a special volume source that "wraps" specified source and provides copy-on-write image on top of it.
properties:
persistentVolumeClaim:
description: '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'
properties:
claimName:
description: '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'
type: string
readOnly:
description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
type: object
hostDisk:
description: HostDisk represents a disk created on the cluster level
properties:
capacity:
anyOf:
- type: integer
- type: string
description: Capacity of the sparse disk
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
path:
description: The path to HostDisk image located on the cluster
type: string
shared:
description: Shared indicate whether the path is shared between nodes
type: boolean
type:
description: Contains information if disk.img exists or should be created allowed options are 'Disk' and 'DiskOrCreate'
type: string
required:
- path
- type
type: object
memoryDump:
description: MemoryDump is attached to the virt launcher and is populated with a memory dump of the vmi
properties:
claimName:
description: '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'
type: string
hotpluggable:
description: Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.
type: boolean
readOnly:
description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
name:
description: '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'
type: string
persistentVolumeClaim:
description: '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'
properties:
claimName:
description: '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'
type: string
hotpluggable:
description: Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.
type: boolean
readOnly:
description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
secret:
description: 'SecretVolumeSource represents a reference to a secret data in the same namespace. More info: https://kubernetes.io/docs/concepts/configuration/secret/'
properties:
optional:
description: Specify whether the Secret or it's keys must be defined
type: boolean
secretName:
description: 'Name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
volumeLabel:
description: 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).
type: string
type: object
serviceAccount:
description: 'ServiceAccountVolumeSource represents a reference to a service account. There can only be one volume of this type! More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/'
properties:
serviceAccountName:
description: '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/'
type: string
type: object
sysprep:
description: Represents a Sysprep volume source.
properties:
configMap:
description: ConfigMap references a ConfigMap that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
secret:
description: Secret references a k8s Secret that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
type: object
required:
- name
type: object
type: array
required:
- domain
type: object
type: object
required:
- template
type: object
status:
description: Status holds the current state of the controller and brief information about its associated VirtualMachineInstance
properties:
conditions:
description: Hold the state information of the VirtualMachine and its VirtualMachineInstance
items:
description: VirtualMachineCondition represents the state of VirtualMachine
properties:
lastProbeTime:
format: date-time
nullable: true
type: string
lastTransitionTime:
format: date-time
nullable: true
type: string
message:
type: string
reason:
type: string
status:
type: string
type:
type: string
required:
- status
- type
type: object
type: array
created:
description: Created indicates if the virtual machine is created in the cluster
type: boolean
desiredGeneration:
description: DesiredGeneration is the generation which is desired for the VMI. This will be used in comparisons with ObservedGeneration to understand when the VMI is out of sync. This will be changed at the same time as ObservedGeneration to remove errors which could occur if Generation is updated through an Update() before ObservedGeneration in Status.
format: int64
type: integer
interfaceRequests:
description: InterfaceRequests indicates a list of interfaces added to the VMI template and hot-plugged on an active running VMI.
items:
properties:
addInterfaceOptions:
description: AddInterfaceOptions when set indicates a network interface should be added. The details within this field specify how to add the interface
properties:
name:
description: Name indicates the logical name of the interface.
type: string
networkAttachmentDefinitionName:
description: 'NetworkAttachmentDefinitionName references a NetworkAttachmentDefinition CRD object. Format: <networkAttachmentDefinitionName>, <namespace>/<networkAttachmentDefinitionName>. If namespace is not specified, VMI namespace is assumed.'
type: string
required:
- name
- networkAttachmentDefinitionName
type: object
removeInterfaceOptions:
description: RemoveInterfaceOptions when set indicates a network interface should be removed. The details within this field specify how to remove the interface
properties:
name:
description: Name indicates the logical name of the interface.
type: string
required:
- name
type: object
type: object
type: array
x-kubernetes-list-type: atomic
memoryDumpRequest:
description: MemoryDumpRequest tracks memory dump request phase and info of getting a memory dump to the given pvc
nullable: true
properties:
claimName:
description: ClaimName is the name of the pvc that will contain the memory dump
type: string
endTimestamp:
description: EndTimestamp represents the time the memory dump was completed
format: date-time
type: string
fileName:
description: FileName represents the name of the output file
type: string
message:
description: Message is a detailed message about failure of the memory dump
type: string
phase:
description: Phase represents the memory dump phase
type: string
remove:
description: Remove represents request of dissociating the memory dump pvc
type: boolean
startTimestamp:
description: StartTimestamp represents the time the memory dump started
format: date-time
type: string
required:
- claimName
- phase
type: object
observedGeneration:
description: ObservedGeneration is the generation observed by the vmi when started.
format: int64
type: integer
printableStatus:
description: PrintableStatus is a human readable, high-level representation of the status of the virtual machine
type: string
ready:
description: Ready indicates if the virtual machine is running and ready
type: boolean
restoreInProgress:
description: RestoreInProgress is the name of the VirtualMachineRestore currently executing
type: string
snapshotInProgress:
description: SnapshotInProgress is the name of the VirtualMachineSnapshot currently executing
type: string
startFailure:
description: StartFailure tracks consecutive VMI startup failures for the purposes of crash loop backoffs
nullable: true
properties:
consecutiveFailCount:
type: integer
lastFailedVMIUID:
description: UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.
type: string
retryAfterTimestamp:
format: date-time
type: string
type: object
stateChangeRequests:
description: StateChangeRequests indicates a list of actions that should be taken on a VMI e.g. stop a specific VMI then start a new one.
items:
properties:
action:
description: Indicates the type of action that is requested. e.g. Start or Stop
type: string
data:
additionalProperties:
type: string
description: Provides additional data in order to perform the Action
type: object
uid:
description: Indicates the UUID of an existing Virtual Machine Instance that this change request applies to -- if applicable
type: string
required:
- action
type: object
type: array
volumeRequests:
description: VolumeRequests indicates a list of volumes add or remove from the VMI template and hotplug on an active running VMI.
items:
properties:
addVolumeOptions:
description: AddVolumeOptions when set indicates a volume should be added. The details within this field specify how to add the volume
properties:
disk:
description: Disk represents the hotplug disk that will be plugged into the running VMI
properties:
blockSize:
description: If specified, the virtual disk will be presented with the given block sizes.
properties:
custom:
description: CustomBlockSize represents the desired logical and physical block size for a VM disk.
properties:
logical:
type: integer
physical:
type: integer
required:
- logical
- physical
type: object
matchVolume:
description: Represents if a feature is enabled or disabled.
properties:
enabled:
description: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true.
type: boolean
type: object
type: object
bootOrder:
description: 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.
type: integer
cache:
description: 'Cache specifies which kvm disk cache mode should be used. Supported values are: CacheNone, CacheWriteThrough.'
type: string
cdrom:
description: Attach a volume as a cdrom to the vmi.
properties:
bus:
description: 'Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.'
type: string
readonly:
description: ReadOnly. Defaults to true.
type: boolean
tray:
description: Tray indicates if the tray of the device is open or closed. Allowed values are "open" and "closed". Defaults to closed.
type: string
type: object
dedicatedIOThread:
description: dedicatedIOThread indicates this disk should have an exclusive IO Thread. Enabling this implies useIOThreads = true. Defaults to false.
type: boolean
disk:
description: Attach a volume as a disk to the vmi.
properties:
bus:
description: 'Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi, usb.'
type: string
pciAddress:
description: 'If specified, the virtual disk will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10'
type: string
readonly:
description: ReadOnly. Defaults to false.
type: boolean
type: object
io:
description: 'IO specifies which QEMU disk IO mode should be used. Supported values are: native, default, threads.'
type: string
lun:
description: Attach a volume as a LUN to the vmi.
properties:
bus:
description: 'Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi.'
type: string
readonly:
description: ReadOnly. Defaults to false.
type: boolean
reservation:
description: Reservation indicates if the disk needs to support the persistent reservation for the SCSI disk
type: boolean
type: object
name:
description: Name is the device name
type: string
serial:
description: Serial provides the ability to specify a serial number for the disk device.
type: string
shareable:
description: If specified the disk is made sharable and multiple write from different VMs are permitted
type: boolean
tag:
description: If specified, disk address and its tag will be provided to the guest via config drive metadata
type: string
required:
- name
type: object
dryRun:
description: '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'
items:
type: string
type: array
x-kubernetes-list-type: atomic
name:
description: 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.
type: string
volumeSource:
description: VolumeSource represents the source of the volume to map to the disk.
properties:
dataVolume:
description: DataVolume represents the dynamic creation a PVC for this volume as well as the process of populating that PVC with a disk image.
properties:
hotpluggable:
description: Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.
type: boolean
name:
description: Name of both the DataVolume and the PVC in the same namespace. After PVC population the DataVolume is garbage collected by default.
type: string
required:
- name
type: object
persistentVolumeClaim:
description: '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'
properties:
claimName:
description: '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'
type: string
hotpluggable:
description: Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.
type: boolean
readOnly:
description: readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
type: object
required:
- disk
- name
- volumeSource
type: object
removeVolumeOptions:
description: RemoveVolumeOptions when set indicates a volume should be removed. The details within this field specify how to add the volume
properties:
dryRun:
description: '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'
items:
type: string
type: array
x-kubernetes-list-type: atomic
name:
description: Name represents the name that maps to both the disk and volume that should be removed
type: string
required:
- name
type: object
type: object
type: array
x-kubernetes-list-type: atomic
volumeSnapshotStatuses:
description: VolumeSnapshotStatuses indicates a list of statuses whether snapshotting is supported by each volume.
items:
properties:
enabled:
description: True if the volume supports snapshotting
type: boolean
name:
description: Volume name
type: string
reason:
description: Empty if snapshotting is enabled, contains reason otherwise
type: string
required:
- enabled
- name
type: object
type: array
type: object
type: object
type: object
virtualMachineSnapshotName:
type: string
volumeBackups:
items:
description: VolumeBackup contains the data neeed to restore a PVC
properties:
persistentVolumeClaim:
properties:
metadata:
description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata'
type: object
x-kubernetes-preserve-unknown-fields: true
spec:
description: 'Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
accessModes:
description: 'accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
description: 'dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.'
properties:
apiGroup:
description: 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.
type: string
kind:
description: Kind is the type of resource being referenced
type: string
name:
description: Name is the name of resource being referenced
type: string
required:
- kind
- name
type: object
dataSourceRef:
description: 'dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn''t specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn''t set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.'
properties:
apiGroup:
description: 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.
type: string
kind:
description: Kind is the type of resource being referenced
type: string
name:
description: Name is the name of resource being referenced
type: string
namespace:
description: Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
type: string
required:
- kind
- name
type: object
resources:
description: 'resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
claims:
description: "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers."
items:
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
properties:
name:
description: Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
limits:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
type: object
requests:
additionalProperties:
anyOf:
- type: integer
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
description: '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/'
type: object
type: object
selector:
description: selector is a label query over volumes to consider for binding.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies to.
type: string
operator:
description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: 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.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: 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.
type: object
type: object
storageClassName:
description: 'storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
type: string
volumeName:
description: volumeName is the binding reference to the PersistentVolume backing this claim.
type: string
type: object
type: object
volumeName:
type: string
volumeSnapshotName:
type: string
required:
- persistentVolumeClaim
- volumeName
type: object
type: array
required:
- source
type: object
status:
description: VirtualMachineSnapshotContentStatus is the status for a VirtualMachineSnapshotStatus resource
properties:
creationTime:
format: date-time
nullable: true
type: string
error:
description: Error is the last error encountered during the snapshot/restore
properties:
message:
type: string
time:
format: date-time
type: string
type: object
readyToUse:
type: boolean
volumeSnapshotStatus:
items:
description: VolumeSnapshotStatus is the status of a VolumeSnapshot
properties:
creationTime:
format: date-time
nullable: true
type: string
error:
description: Error is the last error encountered during the snapshot/restore
properties:
message:
type: string
time:
format: date-time
type: string
type: object
readyToUse:
type: boolean
volumeSnapshotName:
type: string
required:
- volumeSnapshotName
type: object
type: array
type: object
required:
- spec
type: object
served: true
storage: true
Reference in New Issue View Git Blame Copy Permalink