--- title: "GET /apis/kubevirt.io/v1/virtualmachineinstances" method: GET path: "/apis/kubevirt.io/v1/virtualmachineinstances" --- # GET /apis/kubevirt.io/v1/virtualmachineinstances `GET /apis/kubevirt.io/v1/virtualmachineinstances` ## Request - The document declares no server URL. - Auth: none declared Get a list of all VirtualMachineInstance objects. ## Response `200` OK - V1VirtualMachineInstanceList: VirtualMachineInstanceList is a list of VirtualMachines - `apiVersion` string: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - `items` V1VirtualMachineInstance[], required - `apiVersion` string: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - `kind` string: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `metadata` IoK8sApimachineryPkgApisMetaV1ObjectMeta: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `annotations` object: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations - `creationTimestamp` string, nullable: CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - `deletionGracePeriodSeconds` integer: Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. - `deletionTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `finalizers` string[]: Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. - `generateName` string: GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency - `generation` integer: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. - `labels` object: Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels - `managedFields` IoK8sApimachineryPkgApisMetaV1ManagedFieldsEntry[]: ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. - `apiVersion` string: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. - `fieldsType` string: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" - `fieldsV1` IoK8sApimachineryPkgApisMetaV1FieldsV1: FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff - `manager` string: Manager is an identifier of the workflow managing these fields. - `operation` string: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. - `subresource` string: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. - `time` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `name` string: Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names - `namespace` string: Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces - `ownerReferences` IoK8sApimachineryPkgApisMetaV1OwnerReference[]: List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. - `apiVersion` string, required: API version of the referent. - `blockOwnerDeletion` boolean: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. - `controller` boolean: If true, this reference points to the managing controller. - `kind` string, required: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `name` string, required: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names - `uid` string, required: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids - `resourceVersion` string: An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - `selfLink` string: Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. - `uid` string: UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids - `spec` V1VirtualMachineInstanceSpec, required: VirtualMachineInstanceSpec is a description of a VirtualMachineInstance. - `accessCredentials` V1AccessCredential[]: Specifies a set of public keys to inject into the vm guest - `sshPublicKey` V1SSHPublicKeyAccessCredential: SSHPublicKeyAccessCredential represents a source and propagation method for injecting ssh public keys into a vm guest - `propagationMethod` V1SSHPublicKeyAccessCredentialPropagationMethod, required: SSHPublicKeyAccessCredentialPropagationMethod represents the method used to inject a ssh public key into the vm guest. Only one of its members may be specified. - `configDrive` V1ConfigDriveSSHPublicKeyAccessCredentialPropagation - `noCloud` V1NoCloudSSHPublicKeyAccessCredentialPropagation - `qemuGuestAgent` V1QemuGuestAgentSSHPublicKeyAccessCredentialPropagation - … - `source` V1SSHPublicKeyAccessCredentialSource, required: SSHPublicKeyAccessCredentialSource represents where to retrieve the ssh key credentials Only one of its members may be specified. - `secret` V1AccessCredentialSecretSource - … - `userPassword` V1UserPasswordAccessCredential: UserPasswordAccessCredential represents a source and propagation method for injecting user passwords into a vm guest Only one of its members may be specified. - `propagationMethod` V1UserPasswordAccessCredentialPropagationMethod, required: UserPasswordAccessCredentialPropagationMethod represents the method used to inject a user passwords into the vm guest. Only one of its members may be specified. - `qemuGuestAgent` V1QemuGuestAgentUserPasswordAccessCredentialPropagation - `source` V1UserPasswordAccessCredentialSource, required: UserPasswordAccessCredentialSource represents where to retrieve the user password credentials Only one of its members may be specified. - `secret` V1AccessCredentialSecretSource - … - `affinity` IoK8sApiCoreV1Affinity: Affinity is a group of affinity scheduling rules. - `nodeAffinity` IoK8sApiCoreV1NodeAffinity: Node affinity is a group of node affinity scheduling rules. - `preferredDuringSchedulingIgnoredDuringExecution` IoK8sApiCoreV1PreferredSchedulingTerm[]: 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. - `preference` IoK8sApiCoreV1NodeSelectorTerm, required: A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. - … - `weight` integer, required: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. - `requiredDuringSchedulingIgnoredDuringExecution` IoK8sApiCoreV1NodeSelector: A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. - `nodeSelectorTerms` IoK8sApiCoreV1NodeSelectorTerm[], required: Required. A list of node selector terms. The terms are ORed. - … - `podAffinity` IoK8sApiCoreV1PodAffinity: Pod affinity is a group of inter pod affinity scheduling rules. - `preferredDuringSchedulingIgnoredDuringExecution` IoK8sApiCoreV1WeightedPodAffinityTerm[]: 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. - `podAffinityTerm` IoK8sApiCoreV1PodAffinityTerm, required: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running - … - `weight` integer, required: weight associated with matching the corresponding podAffinityTerm, in the range 1-100. - `requiredDuringSchedulingIgnoredDuringExecution` IoK8sApiCoreV1PodAffinityTerm[]: 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. - `labelSelector` IoK8sApimachineryPkgApisMetaV1LabelSelector: A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. - … - `matchLabelKeys` string[]: MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - `mismatchLabelKeys` string[]: MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - `namespaceSelector` IoK8sApimachineryPkgApisMetaV1LabelSelector: A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. - … - `namespaces` string[]: 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". - `topologyKey` string, required: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. - `podAntiAffinity` IoK8sApiCoreV1PodAntiAffinity: Pod anti affinity is a group of inter pod anti affinity scheduling rules. - `preferredDuringSchedulingIgnoredDuringExecution` IoK8sApiCoreV1WeightedPodAffinityTerm[]: 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 subtracting "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. - `podAffinityTerm` IoK8sApiCoreV1PodAffinityTerm, required: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running - … - `weight` integer, required: weight associated with matching the corresponding podAffinityTerm, in the range 1-100. - `requiredDuringSchedulingIgnoredDuringExecution` IoK8sApiCoreV1PodAffinityTerm[]: 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. - `labelSelector` IoK8sApimachineryPkgApisMetaV1LabelSelector: A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. - … - `matchLabelKeys` string[]: MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - `mismatchLabelKeys` string[]: MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - `namespaceSelector` IoK8sApimachineryPkgApisMetaV1LabelSelector: A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. - … - `namespaces` string[]: 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". - `topologyKey` string, required: 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. - `architecture` string: Specifies the architecture of the vm guest you are attempting to run. Defaults to the compiled architecture of the KubeVirt components - `dnsConfig` IoK8sApiCoreV1PodDNSConfig: PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. - `nameservers` string[]: A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. - `options` IoK8sApiCoreV1PodDNSConfigOption[]: 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. - `name` string: Name is this DNS resolver option's name. Required. - `value` string: Value is this DNS resolver option's value. - `searches` string[]: 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. - `dnsPolicy` 'ClusterFirst' | 'ClusterFirstWithHostNet' | 'Default' | 'None': 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'. Possible enum values: - `"ClusterFirst"` indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings. - `"ClusterFirstWithHostNet"` indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings. - `"Default"` indicates that the pod should use the default (as determined by kubelet) DNS settings. - `"None"` indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig. - `domain` V1DomainSpec, required - `chassis` V1Chassis: Chassis specifies the chassis info passed to the domain. - `asset` string - `manufacturer` string - `serial` string - `sku` string - `version` string - `clock` V1Clock: Represents the clock and timers of a vmi. - `timer` V1Timer: Represents all available timers in a vmi. - `hpet` V1HPETTimer - … - `hyperv` V1HypervTimer - … - `kvm` V1KVMTimer - … - `pit` V1PITTimer - … - `rtc` V1RTCTimer - … - `timezone` string: Timezone sets the guest clock to the specified timezone. Zone name follows the TZ environment variable format (e.g. 'America/New_York'). - `utc` V1ClockOffsetUTC: UTC sets the guest clock to UTC on each boot. - `offsetSeconds` integer: OffsetSeconds specifies an offset in seconds, relative to UTC. If set, guest changes to the clock will be kept during reboots and not reset. - `cpu` V1CPU: CPU allows specifying the CPU topology. - `cores` integer: Cores specifies the number of cores inside the vmi. Must be a value greater or equal 1. - `dedicatedCpuPlacement` boolean: DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node with enough dedicated pCPUs and pin the vCPUs to it. - `features` V1CPUFeature[]: Features specifies the CPU features list inside the VMI. - `name` string, required: Name of the CPU feature - `policy` string: 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 - `isolateEmulatorThread` boolean: IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place the emulator thread on it. - `maxSockets` integer: MaxSockets specifies the maximum amount of sockets that can be hotplugged - `model` string: Model specifies the CPU model inside the VMI. List of available models https://github.com/libvirt/libvirt/tree/master/src/cpu_map. It is possible to specify special cases like "host-passthrough" to get the same CPU as the node and "host-model" to get CPU closest to the node one. Defaults to host-model. - `numa` V1NUMA - `guestMappingPassthrough` V1NUMAGuestMappingPassthrough: NUMAGuestMappingPassthrough instructs kubevirt to model numa topology which is compatible with the CPU pinning on the guest. This will result in a subset of the node numa topology being passed through, ensuring that virtual numa nodes and their memory never cross boundaries coming from the node numa mapping. - `realtime` V1Realtime: Realtime holds the tuning knobs specific for realtime workloads. - `mask` string: 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" - `sockets` integer: Sockets specifies the number of sockets inside the vmi. Must be a value greater or equal 1. - `threads` integer: Threads specifies the number of threads inside the vmi. Must be a value greater or equal 1. - `devices` V1Devices, required - `autoattachGraphicsDevice` boolean: Whether to attach the default graphics device or not. VNC will not be available if set to false. Defaults to true. - `autoattachInputDevice` boolean: Whether to attach an Input Device. Defaults to false. - `autoattachMemBalloon` boolean: Whether to attach the Memory balloon device with default period. Period can be adjusted in virt-config. Defaults to true. - `autoattachPodInterface` boolean: Whether to attach a pod network interface. Defaults to true. - `autoattachSerialConsole` boolean: Whether to attach the default virtio-serial console or not. Serial console access will not be available if set to false. Defaults to true. - `autoattachVSOCK` boolean: Whether to attach the VSOCK CID to the VM or not. VSOCK access will be available if set to true. Defaults to false. - `blockMultiQueue` boolean: Whether or not to enable virtio multi-queue for block devices. Defaults to false. - `clientPassthrough` V1ClientPassthroughDevices: Represent a subset of client devices that can be accessed by VMI. At the moment only, USB devices using Usbredir's library and tooling. Another fit would be a smartcard with libcacard. The struct is currently empty as there is no immediate request for user-facing APIs. This structure simply turns on USB redirection of UsbClientPassthroughMaxNumberOf devices. - `disableHotplug` boolean: DisableHotplug disabled the ability to hotplug disks. - `disks` V1Disk[]: Disks describes disks, cdroms and luns which are connected to the vmi. - `blockSize` V1BlockSize: BlockSize provides the option to change the block size presented to the VM for a disk. Only one of its members may be specified. - … - `bootOrder` integer: 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. - `cache` string: Cache specifies which kvm disk cache mode should be used. Supported values are: none: Guest I/O not cached on the host, but may be kept in a disk cache. writethrough: Guest I/O cached on the host but written through to the physical medium. Slowest but with most guarantees. writeback: Guest I/O cached on the host. directsync: Guest I/O bypasses the host page cache and is written to the physical medium synchronously. Defaults to none if the storage supports O_DIRECT, otherwise writethrough. - `cdrom` V1CDRomTarget - … - `changedBlockTracking` boolean: ChangedBlockTracking indicates this disk should have CBT option Defaults to false. - `dedicatedIOThread` boolean: dedicatedIOThread indicates this disk should have an exclusive IO Thread. Enabling this implies useIOThreads = true. Defaults to false. - `disk` V1DiskTarget - … - `errorPolicy` string: If specified, it can change the default error policy (stop) for the disk - `io` string: IO specifies which QEMU disk IO mode should be used. Supported values are: native, default, threads. - `lun` V1LunTarget - … - `name` string, required: Name is the device name - `serial` string: Serial provides the ability to specify a serial number for the disk device. - `shareable` boolean: If specified the disk is made sharable and multiple write from different VMs are permitted - `tag` string: If specified, disk address and its tag will be provided to the guest via config drive metadata - `downwardMetrics` V1DownwardMetrics - `filesystems` V1Filesystem[]: Filesystems describes filesystem which is connected to the vmi. - `name` string, required: Name is the device name - `virtiofs` V1FilesystemVirtiofs, required - `gpus` V1GPU[]: Whether to attach a GPU device to the vmi. - `claimName` string: ClaimName references the name of an entry in the VMI's spec.resourceClaims[] array. The referenced entry may use either resourceClaimName or resourceClaimTemplateName. - `deviceName` string: DeviceName is the name of the device provisioned by device-plugins - `name` string, required: Name of the GPU device as exposed by a device plugin - `requestName` string: RequestName specifies which request from the ResourceClaim/ResourceClaimTemplate spec.devices.requests array this claim request corresponds to. - `tag` string: If specified, the virtual network interface address and its tag will be provided to the guest via config drive - `virtualGPUOptions` V1VGPUOptions - … - `hostDevices` V1HostDevice[]: Whether to attach a host device to the vmi. - `claimName` string: ClaimName references the name of an entry in the VMI's spec.resourceClaims[] array. The referenced entry may use either resourceClaimName or resourceClaimTemplateName. - `deviceName` string: DeviceName is the name of the device provisioned by device-plugins - `name` string, required - `requestName` string: RequestName specifies which request from the ResourceClaim/ResourceClaimTemplate spec.devices.requests array this claim request corresponds to. - `tag` string: If specified, the virtual network interface address and its tag will be provided to the guest via config drive - `inputs` V1Input[]: Inputs describe input devices - `bus` string: Bus indicates the bus of input device to emulate. Supported values: virtio, usb. - `name` string, required: Name is the device name - `type` string, required: Type indicated the type of input device. Supported values: tablet. - `interfaces` V1Interface[]: Interfaces describe network interfaces which are added to the vmi. - `acpiIndex` integer: 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). - `binding` V1PluginBinding: PluginBinding represents a binding implemented in a plugin. - … - `bootOrder` integer: 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. - `bridge` V1InterfaceBridge: InterfaceBridge connects to a given network via a linux bridge. - `dhcpOptions` V1DHCPOptions: Extra DHCP options to use in the interface. - … - `macAddress` string: Interface MAC address. For example: de:ad:00:00:be:af or DE-AD-00-00-BE-AF. - `macvtap` V1DeprecatedInterfaceMacvtap: DeprecatedInterfaceMacvtap is an alias to the deprecated InterfaceMacvtap that connects to a given network by extending the Kubernetes node's L2 networks via a macvtap interface. Deprecated: Removed in v1.3 - `masquerade` V1InterfaceMasquerade: InterfaceMasquerade connects to a given network using netfilter rules to nat the traffic. - `model` string: Interface model. One of: e1000, e1000e, igb, ne2k_pci, pcnet, rtl8139, virtio. Defaults to virtio. - `name` string, required: Logical name of the interface as well as a reference to the associated networks. Must match the Name of a Network. - `passt` V1DeprecatedInterfacePasst: DeprecatedInterfacePasst is an alias to the deprecated InterfacePasst Deprecated: Removed in v1.3 - `passtBinding` V1InterfacePasstBinding: InterfacePasstBinding connects to a given network using passt usermode networking. - `pciAddress` string: 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 - `portRanges` V1PortRange[]: List of port ranges to be forwarded to the virtual machine. Mutually exclusive with ports. Only supported on masquerade interfaces. This feature is in Alpha. - … - `ports` V1Port[]: List of ports to be forwarded to the virtual machine. Mutually exclusive with portRanges. - … - `slirp` V1DeprecatedInterfaceSlirp: DeprecatedInterfaceSlirp is an alias to the deprecated InterfaceSlirp that connects to a given network using QEMU user networking mode. Deprecated: Removed in v1.3 - `sriov` V1InterfaceSRIOV: InterfaceSRIOV connects to a given network by passing-through an SR-IOV PCI device via vfio. - `state` string: State represents the requested operational state of the interface. The supported values are: `absent`, expressing a request to remove the interface. `down`, expressing a request to set the link down. `up`, expressing a request to set the link up. Empty value functions as `up`. - `tag` string: If specified, the virtual network interface address and its tag will be provided to the guest via config drive - `logSerialConsole` boolean: Whether to log the auto-attached default serial console or not. Serial console logs will be collect to a file and then streamed from a named `guest-console-log`. Not relevant if autoattachSerialConsole is disabled. Defaults to cluster wide setting on VirtualMachineOptions. - `networkInterfaceMultiqueue` boolean: 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. - `panicDevices` V1PanicDevice[]: PanicDevices provides additional crash information when a guest crashes. - `model` string: Model specifies what type of panic device is provided. The panic model used when this attribute is missing depends on the hypervisor and guest arch. One of: isa, hyperv, pvpanic. - `rng` V1Rng: Rng represents the random device passed from host - `sound` V1SoundDevice: Represents the user's configuration to emulate sound cards in the VMI. - `model` string: 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 - `name` string, required: User's defined name for this sound device - `tpm` V1TPMDevice - `enabled` boolean: Enabled allows a user to explicitly disable the vTPM even when one is enabled by a preference referenced by the VirtualMachine Defaults to True - `persistent` boolean: Persistent indicates the state of the TPM device should be kept accross reboots Defaults to false - `useVirtioTransitional` boolean: 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). - `video` V1VideoDevice - `type` string: Type specifies the video device type (e.g., virtio, vga, bochs, ramfb). If not specified, the default is architecture-dependent (VGA for BIOS-based VMs, Bochs for EFI-based VMs on AMD64; virtio for Arm and s390x). - `watchdog` V1Watchdog: Named watchdog device. - `diag288` V1Diag288Watchdog: diag288 watchdog device. - … - `i6300esb` V1I6300ESBWatchdog: i6300esb watchdog device. - … - `name` string, required: Name of the watchdog. - `features` V1Features - `acpi` V1FeatureState: Represents if a feature is enabled or disabled. - `enabled` boolean: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true. - `apic` V1FeatureAPIC - `enabled` boolean: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true. - `endOfInterrupt` boolean: EndOfInterrupt enables the end of interrupt notification in the guest. Defaults to false. - `hyperv` V1FeatureHyperv: Hyperv specific features. - `evmcs` V1FeatureState: Represents if a feature is enabled or disabled. - … - `frequencies` V1FeatureState: Represents if a feature is enabled or disabled. - … - `ipi` V1FeatureState: Represents if a feature is enabled or disabled. - … - `reenlightenment` V1FeatureState: Represents if a feature is enabled or disabled. - … - `relaxed` V1FeatureState: Represents if a feature is enabled or disabled. - … - `reset` V1FeatureState: Represents if a feature is enabled or disabled. - … - `runtime` V1FeatureState: Represents if a feature is enabled or disabled. - … - `spinlocks` V1FeatureSpinlocks - … - `synic` V1FeatureState: Represents if a feature is enabled or disabled. - … - `synictimer` V1SyNICTimer - … - `tlbflush` V1TLBFlush - … - `vapic` V1FeatureState: Represents if a feature is enabled or disabled. - … - `vendorid` V1FeatureVendorID - … - `vpindex` V1FeatureState: Represents if a feature is enabled or disabled. - … - `hypervPassthrough` V1HyperVPassthrough - `enabled` boolean - `kvm` V1FeatureKVM - `hidden` boolean: Hide the KVM hypervisor from standard MSR based discovery. Defaults to false - `pvspinlock` V1FeatureState: Represents if a feature is enabled or disabled. - `enabled` boolean: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true. - `smm` V1FeatureState: Represents if a feature is enabled or disabled. - `enabled` boolean: Enabled determines if the feature should be enabled or disabled on the guest. Defaults to true. - `firmware` V1Firmware - `acpi` V1ACPI - `msdmNameRef` string: Similar to SlicNameRef, another ACPI entry that is used in more recent Windows versions. The above points to the spec of MSDM too. - `slicNameRef` string: SlicNameRef should match the volume name of a secret object. The data in the secret should be a binary blob that follows the ACPI SLIC standard, see: https://learn.microsoft.com/en-us/previous-versions/windows/hardware/design/dn653305(v=vs.85) - `bootloader` V1Bootloader: Represents the firmware blob used to assist in the domain creation process. Used for setting the QEMU BIOS file path for the libvirt domain. - `bios` V1BIOS: If set (default), BIOS will be used. - … - `efi` V1EFI: If set, EFI will be used instead of BIOS. - … - `kernelBoot` V1KernelBoot: Represents the firmware blob used to assist in the kernel boot process. Used for setting the kernel, initrd and command line arguments - `container` V1KernelBootContainer: If set, the VM will be booted from the defined kernel / initrd. - … - `kernelArgs` string: Arguments to be passed to the kernel at boot time - `serial` string: The system-serial-number in SMBIOS - `uuid` string: UUID reported by the vmi bios. Defaults to a random generated uid. - `ioThreads` V1DiskIOThreads - `supplementalPoolThreadCount` integer: SupplementalPoolThreadCount specifies how many iothreads are allocated for the supplementalPool policy. - `ioThreadsPolicy` string: Controls whether or not disks will share IOThreads. Omitting IOThreadsPolicy disables use of IOThreads. One of: shared, auto, supplementalPool - `launchSecurity` V1LaunchSecurity - `sev` V1SEV - `attestation` V1SEVAttestation - `dhCert` string: Base64 encoded guest owner's Diffie-Hellman key. - `policy` V1SEVPolicy - … - `session` string: Base64 encoded session blob. - `snp` V1SEVSNP - `tdx` V1TDX - `machine` V1Machine - `type` string: QEMU machine type is the actual chipset of the VirtualMachineInstance. - `memory` V1Memory: Memory allows specifying the VirtualMachineInstance memory features. - `guest` union: Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. - string - integer - number - `hugepages` V1Hugepages: Hugepages allow to use hugepages for the VirtualMachineInstance instead of regular memory. - `pageSize` string: PageSize specifies the hugepage size, for x86_64 architecture valid values are 1Gi and 2Mi. - `maxGuest` union: Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. - string - integer - number - `reservedOverhead` V1ReservedOverhead - `addedOverhead` union: Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. - … - `memLock` string: RequiresLock determines whether the VM's and its overhead memory need to be locked or not. It is a common practice to enable this if vDPA, VFIO or any other specialized hardware that depends on DMA is being used by the VM. False - (Default) memory lock RLimits are not modified. True - Memory lock RLimits will be updated to consider VM memory size and memory overhead - `rebootPolicy` string: RebootPolicy specifies how the guest should behave on reboot. Reboot (default): The guest is allowed to reboot silently. Terminate: The VMI will be terminated on guest reboot, allowing higher level controllers (such as the VM controller) to recreate the VMI with any updated configuration such as boot order changes. - `resources` V1ResourceRequirements - `limits` object: Limits describes the maximum amount of compute resources allowed. Valid resource keys are "memory" and "cpu". - `overcommitGuestOverhead` boolean: 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. - `requests` object: Requests is a description of the initial vmi resources. Valid resource keys are "memory" and "cpu". - `emulationPolicy` string: The most permissive emulation backend this VM may use. Takes precedence over spec.configuration.emulationPolicy in the KubeVirt CR. Valid Options from least to most permissive are: - None: Only native-kvm - Hardware: Not yet implemented - Software: Qemu TCG cross-architecture emulation Default policy is 'None' This is an alpha field and should only be configured if the feature-gate CrossArchitectureVirtualization is enabled. This feature is in alpha. - `evictionStrategy` string: EvictionStrategy describes the strategy to follow when a node drain occurs. The possible options are: - "None": No action will be taken, according to the specified 'RunStrategy' the VirtualMachine will be restarted or shutdown. - "LiveMigrate": the VirtualMachineInstance will be migrated instead of being shutdown. - "LiveMigrateIfPossible": the same as "LiveMigrate" but only if the VirtualMachine is Live-Migratable, otherwise it will behave as "None". - "External": the VirtualMachineInstance will be protected and `vmi.Status.EvacuationNodeName` will be set on eviction. This is mainly useful for cluster-api-provider-kubevirt (capk) which needs a way for VMI's to be blocked from eviction, yet signal capk that eviction has been called on the VMI so the capk controller can handle tearing the VMI down. Details can be found in the commit description https://github.com/kubevirt/kubevirt/commit/c1d77face705c8b126696bac9a3ee3825f27f1fa. - `hostname` string: Specifies the hostname of the vmi If not specified, the hostname will be set to the name of the vmi, if dhcp or cloud-init is configured properly. - `livenessProbe` V1Probe: Probe describes a health check to be performed against a VirtualMachineInstance to determine whether it is alive or ready to receive traffic. - `exec` IoK8sApiCoreV1ExecAction: ExecAction describes a "run in container" action. - `command` string[]: 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. - `failureThreshold` integer: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. - `guestAgentPing` V1GuestAgentPing: GuestAgentPing configures the guest-agent based ping probe - `httpGet` IoK8sApiCoreV1HTTPGetAction: HTTPGetAction describes an action based on HTTP Get requests. - `host` string: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. - `httpHeaders` IoK8sApiCoreV1HTTPHeader[]: Custom headers to set in the request. HTTP allows repeated headers. - `name` string, required: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. - `value` string, required: The header field value - `path` string: Path to access on the HTTP server. - `port` union, required: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. - string - number - `scheme` 'HTTP' | 'HTTPS': Scheme to use for connecting to the host. Defaults to HTTP. Possible enum values: - `"HTTP"` means that the scheme used will be http:// - `"HTTPS"` means that the scheme used will be https:// - `initialDelaySeconds` integer: 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 - `periodSeconds` integer: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. - `successThreshold` integer: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. - `tcpSocket` IoK8sApiCoreV1TCPSocketAction: TCPSocketAction describes an action based on opening a socket - `host` string: Optional: Host name to connect to, defaults to the pod IP. - `port` union, required: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. - string - number - `timeoutSeconds` integer: Number of seconds after which the probe times out. For exec probes the timeout fails the probe but does not terminate the command running on the guest. This means a blocking command can result in an increasing load on the guest. A small buffer will be added to the resulting workload exec probe to compensate for delays caused by the qemu guest exec mechanism. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - `networks` V1Network[]: List of networks that can be attached to a vm's virtual interface. - `multus` V1MultusNetwork: Represents the multus cni network. - `default` boolean: Select the default network and add it to the multus-cni.io/default-network annotation. - `networkName` string, required: References to a NetworkAttachmentDefinition CRD object. Format: , /. If namespace is not specified, VMI namespace is assumed. - `name` string, required: Network name. Must be a DNS_LABEL and unique within the vm. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - `pod` V1PodNetwork: Represents the stock pod network interface. - `vmIPv6NetworkCIDR` string: IPv6 CIDR for the vm network. Defaults to fd10:0:2::/120 if not specified. - `vmNetworkCIDR` string: CIDR for vm network. Default 10.0.2.0/24 if not specified. - `resourceClaim` V1ClaimRequest - `claimName` string: ClaimName references the name of an entry in the VMI's spec.resourceClaims[] array. The referenced entry may use either resourceClaimName or resourceClaimTemplateName. - `requestName` string: RequestName specifies which request from the ResourceClaim/ResourceClaimTemplate spec.devices.requests array this claim request corresponds to. - `nodeSelector` object: NodeSelector is a selector which must be true for the vmi to fit on a node. Selector which must match a node's labels for the vmi to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ - `priorityClassName` string: If specified, indicates the pod's priority. If not specified, the pod priority will be default or zero if there is no default. - `readinessProbe` V1Probe: Probe describes a health check to be performed against a VirtualMachineInstance to determine whether it is alive or ready to receive traffic. - `exec` IoK8sApiCoreV1ExecAction: ExecAction describes a "run in container" action. - `command` string[]: 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. - `failureThreshold` integer: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. - `guestAgentPing` V1GuestAgentPing: GuestAgentPing configures the guest-agent based ping probe - `httpGet` IoK8sApiCoreV1HTTPGetAction: HTTPGetAction describes an action based on HTTP Get requests. - `host` string: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. - `httpHeaders` IoK8sApiCoreV1HTTPHeader[]: Custom headers to set in the request. HTTP allows repeated headers. - `name` string, required: The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. - `value` string, required: The header field value - `path` string: Path to access on the HTTP server. - `port` union, required: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. - string - number - `scheme` 'HTTP' | 'HTTPS': Scheme to use for connecting to the host. Defaults to HTTP. Possible enum values: - `"HTTP"` means that the scheme used will be http:// - `"HTTPS"` means that the scheme used will be https:// - `initialDelaySeconds` integer: 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 - `periodSeconds` integer: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. - `successThreshold` integer: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. - `tcpSocket` IoK8sApiCoreV1TCPSocketAction: TCPSocketAction describes an action based on opening a socket - `host` string: Optional: Host name to connect to, defaults to the pod IP. - `port` union, required: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. - string - number - `timeoutSeconds` integer: 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 - `resourceClaims` V1VirtualMachineInstanceResourceClaim[]: ResourceClaims define which ResourceClaims must be allocated and reserved before the VMI, hence virt-launcher pod is allowed to start. The resources will be made available to the domain which consumes them by name. This field should only be configured if one of the feature-gates GPUsWithDRA, HostDevicesWithDRA, or NetworkDevicesWithDRA is enabled. - `name` string, required: Name uniquely identifies this resource claim inside the VMI. This field is required and must be a DNS_LABEL. - `resourceClaimName` string: ResourceClaimName is the name of a ResourceClaim object in the same namespace as this VMI. Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set. - `resourceClaimTemplateName` string: ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this VMI. The template name is passed through to the generated virt-launcher Pod spec. From the Pod spec, the template is used to create a new ResourceClaim, which is bound to the virt-launcher Pod. When the virt-launcher Pod is deleted, the ResourceClaim is also deleted. The generated ResourceClaim name is unique and is recorded in pod.status.resourceClaimStatuses. Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set. - `schedulerName` string: If specified, the VMI will be dispatched by specified scheduler. If not specified, the VMI will be dispatched by default scheduler. - `serviceAccountName` string: ServiceAccountName is the name of the ServiceAccount to use to run the virt-launcher pod. This sets pod.spec.serviceAccountName but does NOT automatically expose the service account token to the VM guest. To expose the token to the VM, use a serviceAccount volume. - `startStrategy` string: StartStrategy can be set to "Paused" if Virtual Machine should be started in paused state. - `subdomain` string: If specified, the fully qualified vmi hostname will be "...svc.". If not specified, the vmi will not have a domainname at all. The DNS entry will resolve to the vmi, no matter if the vmi itself can pick up a hostname. - `terminationGracePeriodSeconds` integer: Grace period observed after signalling a VirtualMachineInstance to stop after which the VirtualMachineInstance is force terminated. - `tolerations` IoK8sApiCoreV1Toleration[]: If toleration is specified, obey all the toleration rules. - `effect` 'NoExecute' | 'NoSchedule' | 'PreferNoSchedule': Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. Possible enum values: - `"NoExecute"` Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController. - `"NoSchedule"` Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler. - `"PreferNoSchedule"` Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler. - `key` string: 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. - `operator` 'Equal' | 'Exists' | 'Gt' | 'Lt': Operator represents a key's relationship to the value. Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators). Possible enum values: - `"Equal"` - `"Exists"` - `"Gt"` - `"Lt"` - `tolerationSeconds` integer: 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. - `value` string: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. - `topologySpreadConstraints` IoK8sApiCoreV1TopologySpreadConstraint[]: 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. - `labelSelector` IoK8sApimachineryPkgApisMetaV1LabelSelector: A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. - `matchExpressions` IoK8sApimachineryPkgApisMetaV1LabelSelectorRequirement[]: matchExpressions is a list of label selector requirements. The requirements are ANDed. - `key` string, required: key is the label key that the selector applies to. - `operator` string, required: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. - `values` string[]: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. - `matchLabels` object: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. - `matchLabelKeys` string[]: 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. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default). - `maxSkew` integer, required: 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. - `minDomains` integer: 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. 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. - `nodeAffinityPolicy` 'Honor' | 'Ignore': 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. If this value is nil, the behavior is equivalent to the Honor policy. Possible enum values: - `"Honor"` means use this scheduling directive when calculating pod topology spread skew. - `"Ignore"` means ignore this scheduling directive when calculating pod topology spread skew. - `nodeTaintsPolicy` 'Honor' | 'Ignore': 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. If this value is nil, the behavior is equivalent to the Ignore policy. Possible enum values: - `"Honor"` means use this scheduling directive when calculating pod topology spread skew. - `"Ignore"` means ignore this scheduling directive when calculating pod topology spread skew. - `topologyKey` string, required: 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 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. - `whenUnsatisfiable` 'DoNotSchedule' | 'ScheduleAnyway', required: 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. Possible enum values: - `"DoNotSchedule"` instructs the scheduler not to schedule the pod when constraints are not satisfied. - `"ScheduleAnyway"` instructs the scheduler to schedule the pod even if constraints are not satisfied. - `utilityVolumes` V1UtilityVolume[]: List of utility volumes that can be mounted to the vmi virt-launcher pod without having a matching disk in the domain. Used to collect data for various operational workflows. - `claimName` string, required: 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 - `name` string, required: UtilityVolume's name. Must be unique within the vmi, including regular Volumes. - `readOnly` boolean: readOnly Will force the ReadOnly setting in VolumeMounts. Default false. - `type` string: Type represents the type of the utility volume. - `virtualMachineState` V1VirtualMachineStateSpec: VirtualMachineStateSpec references or templates the PVC that backs the VirtualMachineState (persistent UEFI, TPM and CBT state). At least one of VolumeClaimTemplate or Source must be set. - `source` V1VirtualMachineStateSource: VirtualMachineStateSource references an existing PVC to adopt as the starting VirtualMachineState. - `name` string, required: Name of the source PVC. - `volumeClaimTemplate` IoK8sApiCoreV1PersistentVolumeClaimTemplate: PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. - `metadata` IoK8sApimachineryPkgApisMetaV1ObjectMeta: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `annotations` object: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations - `creationTimestamp` string, nullable: CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - `deletionGracePeriodSeconds` integer: Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. - `deletionTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `finalizers` string[]: Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. - `generateName` string: GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency - `generation` integer: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. - `labels` object: Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels - `managedFields` IoK8sApimachineryPkgApisMetaV1ManagedFieldsEntry[]: ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. - … - `name` string: Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names - `namespace` string: Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces - `ownerReferences` IoK8sApimachineryPkgApisMetaV1OwnerReference[]: List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. - … - `resourceVersion` string: An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - `selfLink` string: Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. - `uid` string: UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids - `spec` IoK8sApiCoreV1PersistentVolumeClaimSpec, required: PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes - `accessModes` string[]: accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 - `dataSource` IoK8sApiCoreV1TypedLocalObjectReference: TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. - … - `dataSourceRef` IoK8sApiCoreV1TypedObjectReference: TypedObjectReference contains enough information to let you locate the typed referenced object - … - `resources` IoK8sApiCoreV1VolumeResourceRequirements: VolumeResourceRequirements describes the storage resource requirements for a volume. - … - `selector` IoK8sApimachineryPkgApisMetaV1LabelSelector: A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. - … - `storageClassName` string: storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 - `volumeAttributesClassName` string: volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - `volumeMode` 'Block' | 'Filesystem' | 'FromStorageProfile': volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. Possible enum values: - `"Block"` means the volume will not be formatted with a filesystem and will remain a raw block device. - `"Filesystem"` means the volume will be or is formatted with a filesystem. - `"FromStorageProfile"` means the volume mode will be auto selected by CDI according to a matching StorageProfile - `volumeName` string: volumeName is the binding reference to the PersistentVolume backing this claim. - `volumes` V1Volume[]: List of volumes that can be mounted by disks belonging to the vmi. - `cloudInitConfigDrive` V1CloudInitConfigDriveSource: Represents a cloud-init config drive user data source. More info: https://cloudinit.readthedocs.io/en/latest/topics/datasources/configdrive.html - `networkData` string: NetworkData contains config drive inline cloud-init networkdata. - `networkDataBase64` string: NetworkDataBase64 contains config drive cloud-init networkdata as a base64 encoded string. - `networkDataSecretRef` IoK8sApiCoreV1LocalObjectReference: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - `secretRef` IoK8sApiCoreV1LocalObjectReference: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - `userData` string: UserData contains config drive inline cloud-init userdata. - `userDataBase64` string: UserDataBase64 contains config drive cloud-init userdata as a base64 encoded string. - `cloudInitNoCloud` V1CloudInitNoCloudSource: Represents a cloud-init nocloud user data source. More info: http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html - `networkData` string: NetworkData contains NoCloud inline cloud-init networkdata. - `networkDataBase64` string: NetworkDataBase64 contains NoCloud cloud-init networkdata as a base64 encoded string. - `networkDataSecretRef` IoK8sApiCoreV1LocalObjectReference: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - `secretRef` IoK8sApiCoreV1LocalObjectReference: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - `userData` string: UserData contains NoCloud inline cloud-init userdata. - `userDataBase64` string: UserDataBase64 contains NoCloud cloud-init userdata as a base64 encoded string. - `configMap` V1ConfigMapVolumeSource: ConfigMapVolumeSource adapts a ConfigMap into a volume. More info: https://kubernetes.io/docs/concepts/storage/volumes/#configmap - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - `optional` boolean: Specify whether the ConfigMap or it's keys must be defined - `volumeLabel` string: The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart). - `containerDisk` V1ContainerDiskSource: Represents a docker image with an embedded disk. - `image` string, required: Image is the name of the image with the embedded disk. - `imagePullPolicy` 'Always' | 'IfNotPresent' | 'Never': 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 Possible enum values: - `"Always"` means that kubelet always attempts to pull the latest image. Container will fail If the pull fails. - `"IfNotPresent"` means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails. - `"Never"` means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present - `imagePullSecret` string: ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist. - `path` string: Path defines the path to disk file in the container - `containerPath` V1ContainerPathVolumeSource: ContainerPathVolumeSource represents a path from the virt-launcher container to be exposed to the VM via virtiofs. The path must correspond to an existing volumeMount in the virt-launcher pod's compute container. - `path` string, required: Path is the absolute path within the virt-launcher container to expose to the VM. The path must correspond to an existing volumeMount in the compute container. - `readOnly` boolean: ReadOnly controls whether the volume is exposed as read-only to the VM. Defaults to true. Write access is not currently supported. - `dataVolume` V1DataVolumeSource - `hotpluggable` boolean: Hotpluggable indicates whether the volume can be hotplugged and hotunplugged. - `name` string, required: Name of both the DataVolume and the PVC in the same namespace. - `downwardAPI` V1DownwardAPIVolumeSource: DownwardAPIVolumeSource represents a volume containing downward API info. - `fields` IoK8sApiCoreV1DownwardAPIVolumeFile[]: Fields is a list of downward API volume file - `fieldRef` IoK8sApiCoreV1ObjectFieldSelector: ObjectFieldSelector selects an APIVersioned field of an object. - … - `mode` integer: 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. - `path` string, required: Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' - `resourceFieldRef` IoK8sApiCoreV1ResourceFieldSelector: ResourceFieldSelector represents container resources (cpu, memory) and their output format - … - `volumeLabel` string: 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). - `downwardMetrics` V1DownwardMetricsVolumeSource: DownwardMetricsVolumeSource adds a very small disk to VMIs which contains a limited view of host and guest metrics. The disk content is compatible with vhostmd (https://github.com/vhostmd/vhostmd) and vm-dump-metrics. - `emptyDisk` V1EmptyDiskSource: EmptyDisk represents a temporary disk which shares the vmis lifecycle. - `capacity` union, required: Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. - string - integer - number - `ephemeral` V1EphemeralVolumeSource - `persistentVolumeClaim` IoK8sApiCoreV1PersistentVolumeClaimVolumeSource: PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). - `claimName` string, required: 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 - `readOnly` boolean: readOnly Will force the ReadOnly setting in VolumeMounts. Default false. - `hostDisk` V1HostDisk: Represents a disk created on the cluster level - `capacity` union: Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. - string - integer - number - `path` string, required: The path to HostDisk image located on the cluster - `shared` boolean: Shared indicate whether the path is shared between nodes - `type` string, required: Contains information if disk.img exists or should be created allowed options are 'Disk' and 'DiskOrCreate' - `memoryDump` V1MemoryDumpVolumeSource: MemoryDumpVolumeSource represents a memory dump PVC in the volumes of a VMI. Deprecated: memory dumps are attached as utility volumes of type MemoryDump. - `claimName` string, required: 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 - `hotpluggable` boolean: Hotpluggable indicates whether the volume can be hotplugged and hotunplugged. - `readOnly` boolean: readOnly Will force the ReadOnly setting in VolumeMounts. Default false. - `name` string, required: Volume's name. Must be a DNS_LABEL and unique within the vmi. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - `persistentVolumeClaim` V1PersistentVolumeClaimVolumeSource: 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 - `claimName` string, required: 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 - `hotpluggable` boolean: Hotpluggable indicates whether the volume can be hotplugged and hotunplugged. - `readOnly` boolean: readOnly Will force the ReadOnly setting in VolumeMounts. Default false. - `secret` V1SecretVolumeSource: SecretVolumeSource adapts a Secret into a volume. - `optional` boolean: Specify whether the Secret or it's keys must be defined - `secretName` string: Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - `volumeLabel` string: The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart). - `serviceAccount` V1ServiceAccountVolumeSource: ServiceAccountVolumeSource adapts a ServiceAccount into a volume. - `serviceAccountName` string: Name of the service account in the pod's namespace to use. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ - `sysprep` V1SysprepSource: Represents a Sysprep volume source. - `configMap` IoK8sApiCoreV1LocalObjectReference: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - `secret` IoK8sApiCoreV1LocalObjectReference: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - `status` V1VirtualMachineInstanceStatus, nullable: VirtualMachineInstanceStatus represents information about the status of a VirtualMachineInstance. Status may trail the actual state of a system. - `VSOCKCID` integer: VSOCKCID is used to track the allocated VSOCK CID in the VM. - `activePods` object: ActivePods is a mapping of pod UID to node name. It is possible for multiple pods to be running for a single VMI during migration. - `changedBlockTracking` V1ChangedBlockTrackingStatus: ChangedBlockTrackingStatus represents the status of ChangedBlockTracking for a VM - `backupStatus` V1VirtualMachineInstanceBackupStatus: VirtualMachineInstanceBackupStatus tracks the information of the executed backup - `backupMsg` string: BackupMsg resturns any relevant information like failure reason unfreeze failed etc... - `backupName` string: BackupName is the name of the executed backup - `checkpointName` string: CheckpointName is the name of the checkpoint created for the backup - `completed` boolean: Completed indicates the backup completed - `endTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `failed` boolean: Failed indicates that the backup failed - `quiesceStatus` string: QuiesceStatus indicates whether filesystem freeze succeeded, failed, or was skipped. - `startTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `volumes` V1VirtualMachineInstanceBackupVolumeInfo[]: Volumes lists the volumes included in the backup - `type` string: Type is how the volume was backed up, either Full or Incremental. - `volumeName` string, required: VolumeName is the volume name from VMI spec - `state` string, required: State represents the current CBT state - `conditions` V1VirtualMachineInstanceCondition[]: Conditions are specific points in VirtualMachineInstance's pod runtime. - `lastProbeTime` string, nullable - `lastTransitionTime` string, nullable - `message` string - `reason` string - `status` string, required - `type` string, required - `currentCPUTopology` V1CPUTopology: CPUTopology allows specifying the amount of cores, sockets and threads. - `cores` integer: Cores specifies the number of cores inside the vmi. Must be a value greater or equal 1. - `sockets` integer: Sockets specifies the number of sockets inside the vmi. Must be a value greater or equal 1. - `threads` integer: Threads specifies the number of threads inside the vmi. Must be a value greater or equal 1. - `evacuationNodeName` string: EvacuationNodeName is used to track the eviction process of a VMI. It stores the name of the node that we want to evacuate. It is meant to be used by KubeVirt core components only and can't be set or modified by users. - `fsFreezeStatus` string: FSFreezeStatus indicates whether a freeze operation was requested for the guest filesystem. It will be set to "frozen" if the request was made, or unset otherwise. This does not reflect the actual state of the guest filesystem. - `guestOSInfo` V1VirtualMachineInstanceGuestOSInfo - `id` string: Guest OS Id - `kernelRelease` string: Guest OS Kernel Release - `kernelVersion` string: Kernel version of the Guest OS - `machine` string: Machine type of the Guest OS - `name` string: Name of the Guest OS - `prettyName` string: Guest OS Pretty Name - `version` string: Guest OS Version - `versionId` string: Version ID of the Guest OS - `interfaces` V1VirtualMachineInstanceNetworkInterface[]: Interfaces represent the details of available network interfaces. - `infoSource` string: Specifies the origin of the interface data collected. values: domain, guest-agent, multus-status, pod-status. - `interfaceName` string: The interface name inside the Virtual Machine - `ipAddress` string: IP address of a Virtual Machine interface. It is always the first item of IPs - `ipAddresses` string[]: List of all IP addresses of a Virtual Machine interface - `linkState` string: LinkState Reports the current operational link state`. values: up, down. - `mac` string: Hardware address of a Virtual Machine interface - `name` string: Name of the interface, corresponds to name of the network assigned to the interface - `podInterfaceName` string: PodInterfaceName represents the name of the pod network interface - `queueCount` integer: Specifies how many queues are allocated by MultiQueue - `kernelBootStatus` V1KernelBootStatus: KernelBootStatus contains info about the kernelBootContainer - `initrdInfo` V1InitrdInfo: InitrdInfo show info about the initrd file - `checksum` integer: deprecated; Checksum is the checksum of the initrd file - `kernelInfo` V1KernelInfo: KernelInfo show info about the kernel image - `checksum` integer: deprecated; Checksum is the checksum of the kernel image - `launcherContainerImageVersion` string: LauncherContainerImageVersion indicates what container image is currently active for the vmi. - `machine` V1Machine - `type` string: QEMU machine type is the actual chipset of the VirtualMachineInstance. - `memory` V1MemoryStatus - `guestAtBoot` union: Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. - string - integer - number - `guestCurrent` union: Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. - string - integer - number - `guestRequested` union: Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. - string - integer - number - `memoryOverhead` union: Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. - string - integer - number - `migratedVolumes` V1StorageMigratedVolumeInfo[]: MigratedVolumes lists the source and destination volumes during the volume migration - `destinationPVCInfo` V1PersistentVolumeClaimInfo: PersistentVolumeClaimInfo contains the relavant information virt-handler needs cached about a PVC - `accessModes` string[]: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 - `capacity` object: Capacity represents the capacity set on the corresponding PVC status - `claimName` string: ClaimName is the name of the PVC - `filesystemOverhead` string: Percentage of filesystem's size to be reserved when resizing the PVC - `preallocated` boolean: Preallocated indicates if the PVC's storage is preallocated or not - `requests` object: Requests represents the resources requested by the corresponding PVC spec - `volumeMode` 'Block' | 'Filesystem' | 'FromStorageProfile': VolumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. Possible enum values: - `"Block"` means the volume will not be formatted with a filesystem and will remain a raw block device. - `"Filesystem"` means the volume will be or is formatted with a filesystem. - `"FromStorageProfile"` means the volume mode will be auto selected by CDI according to a matching StorageProfile - `sourcePVCInfo` V1PersistentVolumeClaimInfo: PersistentVolumeClaimInfo contains the relavant information virt-handler needs cached about a PVC - `accessModes` string[]: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 - `capacity` object: Capacity represents the capacity set on the corresponding PVC status - `claimName` string: ClaimName is the name of the PVC - `filesystemOverhead` string: Percentage of filesystem's size to be reserved when resizing the PVC - `preallocated` boolean: Preallocated indicates if the PVC's storage is preallocated or not - `requests` object: Requests represents the resources requested by the corresponding PVC spec - `volumeMode` 'Block' | 'Filesystem' | 'FromStorageProfile': VolumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. Possible enum values: - `"Block"` means the volume will not be formatted with a filesystem and will remain a raw block device. - `"Filesystem"` means the volume will be or is formatted with a filesystem. - `"FromStorageProfile"` means the volume mode will be auto selected by CDI according to a matching StorageProfile - `volumeName` string, required: VolumeName is the name of the volume that is being migrated - `migrationMethod` string: Represents the method using which the vmi can be migrated: live migration or block migration - `migrationState` V1VirtualMachineInstanceMigrationState - `abortRequested` boolean: Indicates that the migration has been requested to abort - `abortStatus` string: Indicates the final status of the live migration abortion - `completed` boolean: Indicates the migration completed - `endTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `failed` boolean: Indicates that the migration failed - `failureReason` string: Contains the reason why the migration failed - `migrationConfiguration` V1VMIMConfigurationOptions: VMIMConfigurationOptions holds the resolved migration options for a single migration. It is written to VirtualMachineInstanceMigrationState and represents the effective configuration after merging KubeVirt defaults with any matched MigrationPolicy. - `allowAutoConverge` boolean: AllowAutoConverge allows the platform to compromise performance/availability of VMIs to guarantee successful VMI live migrations. Defaults to false - `allowPostCopy` boolean: AllowPostCopy enables post-copy live migrations. Such migrations allow even the busiest VMIs to successfully live-migrate. However, events like a network failure can cause a VMI crash. If set to true, migrations will still start in pre-copy, but switch to post-copy when CompletionTimeoutPerGiB triggers. Defaults to false - `allowWorkloadDisruption` boolean: AllowWorkloadDisruption indicates that the migration shouldn't be canceled after acceptableCompletionTime is exceeded. Instead, if permitted, migration will be switched to post-copy or the VMI will be paused to allow the migration to complete - `bandwidthPerMigration` union: Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. - string - integer - number - `completionTimeoutPerGiB` integer: CompletionTimeoutPerGiB is the maximum number of seconds per GiB a migration is allowed to take. If the timeout is reached, the migration will be either paused, switched to post-copy or cancelled depending on other settings. Defaults to 150 - `disableTLS` boolean: DisableTLS disables both TLS encryption and mutual TLS authentication on the migration proxy when set to true. This removes all cryptographic protection from the migration data stream. When disabled, implement network-level access controls to restrict migration traffic to trusted sources only. Defaults to false. - `experimental` V1ExperimentalMigrationOptions: ExperimentalMigrationOptions is an alpha API for experimental migration tunables. It is intended for experimental purposes only and will be removed in the future. - `compression` string: Compression selects the algorithm for compressing the live migration data stream. When omitted (nil) or set to "none", compression is disabled. - `downtimeTuning` V1DowntimeTuningOptions: DowntimeTuningOptions controls how virt-launcher gradually increases max_downtime during live migration to help convergence. - … - `stallDetector` V1StallDetectorOptions - … - `matchSELinuxLevelOnMigration` boolean: By default, the SELinux level of target virt-launcher pods is forced to the level of the source virt-launcher. When set to true, MatchSELinuxLevelOnMigration lets the CRI auto-assign a random level to the target. That will ensure the target virt-launcher doesn't share categories with another pod on the node. However, migrations will fail when using RWX volumes that don't automatically deal with SELinux levels. - `maxDowntimeMs` integer: MaxDowntimeMs specifies the maximum tolerable downtime (in milliseconds) during switchover. Defaults to 900 - `network` string: Network is the name of the CNI network to use for live migrations. By default, migrations go through the pod network. - `nodeDrainTaintKey` string: NodeDrainTaintKey defines the taint key that indicates a node should be drained. Note: this option relies on the deprecated node taint feature. Default: kubevirt.io/drain - `parallelMigrationsPerCluster` integer: ParallelMigrationsPerCluster is the total number of concurrent live migrations allowed cluster-wide. Defaults to 5 - `parallelOutboundMigrationsPerNode` integer: ParallelOutboundMigrationsPerNode is the maximum number of concurrent outgoing live migrations allowed per node. Defaults to 2 - `progressTimeout` integer: ProgressTimeout is the maximum number of seconds a live migration is allowed to make no progress. Hitting this timeout means a migration transferred 0 data for that many seconds. The migration is then considered stuck and therefore cancelled. Defaults to 150 - `unsafeMigrationOverride` boolean: UnsafeMigrationOverride allows live migrations to occur even if the compatibility check indicates the migration will be unsafe to the guest. Defaults to false - `utilityVolumesTimeout` integer: UtilityVolumesTimeout is the maximum number of seconds a migration can wait in Pending state for utility volumes to be detached. If utility volumes are still present after this timeout, the migration will be marked as Failed. Defaults to 150 - `migrationNetworkType` string: The type of migration network, either 'pod' or 'migration' - `migrationPolicyName` string: Name of the migration policy. If string is empty, no policy is matched - `migrationUid` string: The VirtualMachineInstanceMigration object associated with this migration - `mode` string: Lets us know if the vmi is currently running pre or post copy migration - `sourceNode` string: The source node that the VMI originated on - `sourcePersistentStatePVCName` string: If the VMI being migrated uses persistent features (backend-storage), its source PVC name is saved here - `sourcePod` string - `sourceState` V1VirtualMachineInstanceMigrationSourceState - `domainName` string: The name of the domain on the source libvirt domain - `domainNamespace` string: Namespace used in the name of the source libvirt domain. Can be used to find and modify paths in the domain - `migrationUID` string: The Source VirtualMachineInstanceMigration object associated with this migration - `node` string: The source node that the VMI originated on - `nodeSelectors` object: Node selectors needed by the target to start the receiving pod. - `persistentStatePVCName` string: If the VMI being migrated uses persistent features (backend-storage), its source PVC name is saved here - `pod` string: The source pod that the VMI is originated on - `selinuxContext` string: SELinuxContext is the actual SELinux context of the pod - `syncAddress` string: The ip address/fqdn:port combination to use to synchronize the VMI with the target. - `virtualMachineInstanceUID` string: VirtualMachineInstanceUID is the UID of the target virtual machine instance - `startTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `targetAttachmentPodUID` string: The UID of the target attachment pod for hotplug volumes - `targetCPUSet` integer[]: If the VMI requires dedicated CPUs, this field will hold the dedicated CPU set on the target node - `targetDirectMigrationNodePorts` object: The list of ports opened for live migration on the destination node - `targetMemoryOverhead` union: Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` ::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E" ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. - string - integer - number - `targetNode` string: The target node that the VMI is moving to - `targetNodeAddress` string: The address of the target node to use for the migration - `targetNodeDomainDetected` boolean: The Target Node has seen the Domain Start Event - `targetNodeDomainReadyTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `targetNodeTopology` string: If the VMI requires dedicated CPUs, this field will hold the numa topology on the target node - `targetPersistentStatePVCName` string: If the VMI being migrated uses persistent features (backend-storage), its target PVC name is saved here - `targetPod` string: The target pod that the VMI is moving to - `targetState` V1VirtualMachineInstanceMigrationTargetState - `attachmentPodUID` string: The UID of the target attachment pod for hotplug volumes - `cpuSet` integer[]: If the VMI requires dedicated CPUs, this field will hold the dedicated CPU set on the target node - `directMigrationNodePorts` object: The list of ports opened for live migration on the destination node - `domainDetected` boolean: The Target Node has seen the Domain Start Event - `domainName` string: The name of the domain on the source libvirt domain - `domainNamespace` string: Namespace used in the name of the source libvirt domain. Can be used to find and modify paths in the domain - `domainReadyTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `migrationUID` string: The Source VirtualMachineInstanceMigration object associated with this migration - `node` string: The source node that the VMI originated on - `nodeAddress` string: The address of the target node to use for the migration - `nodeTopology` string: If the VMI requires dedicated CPUs, this field will hold the numa topology on the target node - `persistentStatePVCName` string: If the VMI being migrated uses persistent features (backend-storage), its source PVC name is saved here - `pod` string: The source pod that the VMI is originated on - `selinuxContext` string: SELinuxContext is the actual SELinux context of the pod - `syncAddress` string: The ip address/fqdn:port combination to use to synchronize the VMI with the target. - `virtualMachineInstanceUID` string: VirtualMachineInstanceUID is the UID of the target virtual machine instance - `migrationTransport` string: This represents the migration transport - `nodeName` string: NodeName is the name where the VirtualMachineInstance is currently running. - `phase` string: Phase is the status of the VirtualMachineInstance in kubernetes world. It is not the VirtualMachineInstance status, but partially correlates to it. - `phaseTransitionTimestamps` V1VirtualMachineInstancePhaseTransitionTimestamp[]: PhaseTransitionTimestamp is the timestamp of when the last phase change occurred - `phase` string: Phase is the status of the VirtualMachineInstance in kubernetes world. It is not the VirtualMachineInstance status, but partially correlates to it. - `phaseTransitionTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `qosClass` 'BestEffort' | 'Burstable' | 'Guaranteed': The Quality of Service (QOS) classification assigned to the virtual machine instance based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md Possible enum values: - `"BestEffort"` is the BestEffort qos class. - `"Burstable"` is the Burstable qos class. - `"Guaranteed"` is the Guaranteed qos class. - `reason` string: A brief CamelCase message indicating details about why the VMI is in this state. e.g. 'NodeUnresponsive' - `runtimeUser` integer: RuntimeUser is used to determine what user will be used in launcher - `selinuxContext` string: SELinuxContext is the actual SELinux context of the virt-launcher pod - `snapshotOverlayPVCUID` string: SnapshotOverlayPVCUID identifies the scratch PVC verified for the OverlaySnapshotActive condition. Updated together with that condition. - `topologyHints` V1TopologyHints - `tscFrequency` integer - `virtualMachineRevisionName` string: VirtualMachineRevisionName is used to get the vm revision of the vmi when doing an online vm snapshot - `virtualMachineStateVolume` V1VolumeStatus: VolumeStatus represents information about the status of volumes attached to the VirtualMachineInstance. - `containerDiskVolume` V1ContainerDiskInfo: ContainerDiskInfo shows info about the containerdisk - `checksum` integer: deprecated; Checksum is the checksum of the rootdisk or kernel artifacts inside the containerdisk - `hotplugVolume` V1HotplugVolumeStatus: HotplugVolumeStatus represents the hotplug status of the volume - `attachPodName` string: AttachPodName is the name of the pod used to attach the volume to the node. - `attachPodUID` string: AttachPodUID is the UID of the pod used to attach the volume to the node. - `memoryDumpVolume` V1DomainMemoryDumpInfo: DomainMemoryDumpInfo represents the memory dump information - `claimName` string: ClaimName is the name of the pvc the memory was dumped to - `endTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `startTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `targetFileName` string: TargetFileName is the name of the memory dump output - `message` string: Message is a detailed message about the current hotplug volume phase - `name` string, required: Name is the name of the volume - `persistentVolumeClaimInfo` V1PersistentVolumeClaimInfo: PersistentVolumeClaimInfo contains the relavant information virt-handler needs cached about a PVC - `accessModes` string[]: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 - `capacity` object: Capacity represents the capacity set on the corresponding PVC status - `claimName` string: ClaimName is the name of the PVC - `filesystemOverhead` string: Percentage of filesystem's size to be reserved when resizing the PVC - `preallocated` boolean: Preallocated indicates if the PVC's storage is preallocated or not - `requests` object: Requests represents the resources requested by the corresponding PVC spec - `volumeMode` 'Block' | 'Filesystem' | 'FromStorageProfile': VolumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. Possible enum values: - `"Block"` means the volume will not be formatted with a filesystem and will remain a raw block device. - `"Filesystem"` means the volume will be or is formatted with a filesystem. - `"FromStorageProfile"` means the volume mode will be auto selected by CDI according to a matching StorageProfile - `phase` string: Phase is the phase - `reason` string: Reason is a brief description of why we are in the current hotplug volume phase - `size` integer: Represents the size of the volume - `target` string, required: Target is the target name used when adding the volume to the VM, eg: vda - `volumeStatus` V1VolumeStatus[]: VolumeStatus contains the statuses of all the volumes - `containerDiskVolume` V1ContainerDiskInfo: ContainerDiskInfo shows info about the containerdisk - `checksum` integer: deprecated; Checksum is the checksum of the rootdisk or kernel artifacts inside the containerdisk - `hotplugVolume` V1HotplugVolumeStatus: HotplugVolumeStatus represents the hotplug status of the volume - `attachPodName` string: AttachPodName is the name of the pod used to attach the volume to the node. - `attachPodUID` string: AttachPodUID is the UID of the pod used to attach the volume to the node. - `memoryDumpVolume` V1DomainMemoryDumpInfo: DomainMemoryDumpInfo represents the memory dump information - `claimName` string: ClaimName is the name of the pvc the memory was dumped to - `endTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `startTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `targetFileName` string: TargetFileName is the name of the memory dump output - `message` string: Message is a detailed message about the current hotplug volume phase - `name` string, required: Name is the name of the volume - `persistentVolumeClaimInfo` V1PersistentVolumeClaimInfo: PersistentVolumeClaimInfo contains the relavant information virt-handler needs cached about a PVC - `accessModes` string[]: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 - `capacity` object: Capacity represents the capacity set on the corresponding PVC status - `claimName` string: ClaimName is the name of the PVC - `filesystemOverhead` string: Percentage of filesystem's size to be reserved when resizing the PVC - `preallocated` boolean: Preallocated indicates if the PVC's storage is preallocated or not - `requests` object: Requests represents the resources requested by the corresponding PVC spec - `volumeMode` 'Block' | 'Filesystem' | 'FromStorageProfile': VolumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. Possible enum values: - `"Block"` means the volume will not be formatted with a filesystem and will remain a raw block device. - `"Filesystem"` means the volume will be or is formatted with a filesystem. - `"FromStorageProfile"` means the volume mode will be auto selected by CDI according to a matching StorageProfile - `phase` string: Phase is the phase - `reason` string: Reason is a brief description of why we are in the current hotplug volume phase - `size` integer: Represents the size of the volume - `target` string, required: Target is the target name used when adding the volume to the VM, eg: vda - `kind` string: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `metadata` IoK8sApimachineryPkgApisMetaV1ListMeta: ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. - `continue` string: continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. - `remainingItemCount` integer: remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. - `resourceVersion` string: String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - `selfLink` string: Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. - `shardInfo` IoK8sApimachineryPkgApisMetaV1ShardInfo: ShardInfo describes the shard selector that was applied to produce a list response. Its presence on a list response indicates the list is a filtered subset. - `selector` string, required: selector is the shard selector string from the request, echoed back so clients can verify which shard they received and merge responses from multiple shards. ## Other responses - `401`: Unauthorized --- [API](https://skmtc.dev/kubevirt/apis/kubevirt-api.md) - [All operations](https://skmtc.dev/kubevirt/apis/kubevirt-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kubevirt/apis/kubevirt-api/revisions/53caa6a73177?raw)