apiVersion
optional

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

string

kind
optional

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

string

name
required

name is the name of the group.

string

preferredVersion
optional

preferredVersion is the version preferred by the API server, which probably is the storage version.

v1.GroupVersionForDiscovery

serverAddressByClientCIDRs
optional

a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.

< v1.ServerAddressByClientCIDR > array

versions
required

versions are the versions supported in this group.

< v1.GroupVersionForDiscovery > array

apiVersion
optional

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

string

groups
required

groups is a list of APIGroup.

< v1.APIGroup > array

kind
optional

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

string

categories
optional

categories is a list of the grouped resources this resource belongs to (e.g. 'all')

< string > array

group
optional

group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".

string

kind
required

kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')

string

name
required

name is the plural name of the resource.

string

namespaced
required

namespaced indicates if a resource is namespaced or not.

boolean

shortNames
optional

shortNames is a list of suggested short names of the resource.

< string > array

singularName
required

singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.

string

storageVersionHash
optional

The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.

string

verbs
required

verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)

< string > array

version
optional

version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource’s group)".

string

apiVersion
optional

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

string

groupVersion
required

groupVersion is the group and version this APIResourceList is for.

string

kind
optional

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

string

resources
required

resources contains the name of the resources and if they are namespaced.

< v1.APIResource > array

nodeAffinity
optional

Describes node affinity scheduling rules for the pod.

v1.NodeAffinity

podAffinity
optional

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

v1.PodAffinity

podAntiAffinity
optional

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

v1.PodAntiAffinity

bios
optional

If set (default), BIOS will be used.

v1.BIOS

efi
optional

If set, EFI will be used instead of BIOS.

v1.EFI

bus
optional

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

string

readonly
optional

ReadOnly. Defaults to true.

boolean

tray
optional

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

string

cores
optional

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

integer (int64)

dedicatedCpuPlacement
optional

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

boolean

features
optional

Features specifies the CPU features list inside the VMI.

< v1.CPUFeature > array

isolateEmulatorThread
optional

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

boolean

model
optional

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.

string

sockets
optional

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

integer (int64)

threads
optional

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

integer (int64)

name
required

Name of the CPU feature

string

policy
optional

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

string

asset
optional

string

manufacturer
optional

string

serial
optional

string

sku
optional

string

version
optional

string

timer
optional

Timer specifies whih timers are attached to the vmi.

v1.Timer

timezone
optional

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

string

utc
optional

UTC sets the guest clock to UTC on each boot. If an offset is specified, guest changes to the clock will be kept during reboots and are not reset.

v1.ClockOffsetUTC

offsetSeconds
optional

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

integer (int32)

networkData
optional

NetworkData contains config drive inline cloud-init networkdata.

string

networkDataBase64
optional

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

string

networkDataSecretRef
optional

NetworkDataSecretRef references a k8s secret that contains config drive networkdata.

v1.LocalObjectReference

secretRef
optional

UserDataSecretRef references a k8s secret that contains config drive userdata.

v1.LocalObjectReference

userData
optional

UserData contains config drive inline cloud-init userdata.

string

userDataBase64
optional

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

string

networkData
optional

NetworkData contains NoCloud inline cloud-init networkdata.

string

networkDataBase64
optional

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

string

networkDataSecretRef
optional

NetworkDataSecretRef references a k8s secret that contains NoCloud networkdata.

v1.LocalObjectReference

secretRef
optional

UserDataSecretRef references a k8s secret that contains NoCloud userdata.

v1.LocalObjectReference

userData
optional

UserData contains NoCloud inline cloud-init userdata.

string

userDataBase64
optional

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

string

name
optional

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

string

optional
optional

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

boolean

volumeLabel
optional

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).

string

image
required

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

string

imagePullPolicy
optional

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

string

imagePullSecret
optional

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

string

path
optional

Path defines the path to disk file in the container

string

bootFileName
optional

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

string

ntpServers
optional

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

< string > array

privateOptions
optional

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

< v1.DHCPPrivateOptions > array

tftpServerName
optional

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

string

option
required

Option is an Integer value from 224-254 Required.

integer (int32)

value
required

Value is a String value for the Option provided Required.

string

name
required

Name represents the name of the DataVolume in the same namespace

string

apiVersion
optional

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

string

dryRun
optional

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

< string > array

gracePeriodSeconds
optional

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

integer (int64)

kind
optional

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

string

orphanDependents
optional

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

boolean

preconditions
optional

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

v1.Preconditions

propagationPolicy
optional

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

string

autoattachGraphicsDevice
optional

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

boolean

autoattachPodInterface
optional

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

boolean

autoattachSerialConsole
optional

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

boolean

blockMultiQueue
optional

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

boolean

disks
optional

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

< v1.Disk > array

gpus
optional

Whether to attach a GPU device to the vmi.

< v1.GPU > array

inputs
optional

Inputs describe input devices

< v1.Input > array

interfaces
optional

Interfaces describe network interfaces which are added to the vmi.

< v1.Interface > array

networkInterfaceMultiqueue
optional

If specified, virtual network interfaces configured with a virtio bus will also enable the vhost multiqueue feature

boolean

rng
optional

Whether to have random number generator from host

v1.Rng

watchdog
optional

Watchdog describes a watchdog device which can be added to the vmi.

v1.Watchdog

bootOrder
optional

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.

integer (int32)

cache
optional

Cache specifies which kvm disk cache mode should be used.

string

cdrom
optional

Attach a volume as a cdrom to the vmi.

v1.CDRomTarget

dedicatedIOThread
optional

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

boolean

disk
optional

Attach a volume as a disk to the vmi.

v1.DiskTarget

floppy
optional

Attach a volume as a floppy to the vmi.

v1.FloppyTarget

lun
optional

Attach a volume as a LUN to the vmi.

v1.LunTarget

name
required

Name is the device name

string

serial
optional

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

string

tag
optional

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

string

bus
optional

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

string

pciAddress
optional

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

string

readonly
optional

ReadOnly. Defaults to false.

boolean

chassis
optional

Chassis specifies the chassis info passed to the domain.

v1.Chassis

clock
optional

Clock sets the clock and timers of the vmi.

v1.Clock

cpu
optional

CPU allow specified the detailed CPU topology inside the vmi.

v1.CPU

devices
required

Devices allows adding disks, network interfaces, and others

v1.Devices

features
optional

Features like acpi, apic, hyperv, smm.

v1.Features

firmware
optional

Firmware.

v1.Firmware

ioThreadsPolicy
optional

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

string

machine
optional

Machine type.

v1.Machine

memory
optional

Memory allow specifying the VMI memory features.

v1.Memory

resources
optional

Resources describes the Compute Resources required by this vmi.

v1.ResourceRequirements

secureBoot
optional

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

boolean

capacity
required

Capacity of the sparse disk.

resource.Quantity

persistentVolumeClaim
optional

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

v1.PersistentVolumeClaimVolumeSource

enabled
optional

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

boolean

endOfInterrupt
optional

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

boolean

evmcs
optional

EVMCS Speeds up L2 vmexits, but disables other virtualization features. Requires vapic. Defaults to the machine type setting.

v1.FeatureState

frequencies
optional

Frequencies improves the TSC clock source handling for Hyper-V on KVM. Defaults to the machine type setting.

v1.FeatureState

ipi
optional

IPI improves performances in overcommited environments. Requires vpindex. Defaults to the machine type setting.

v1.FeatureState

reenlightenment
optional

Reenlightenment enables the notifications on TSC frequency changes. Defaults to the machine type setting.

v1.FeatureState

relaxed
optional

Relaxed instructs the guest OS to disable watchdog timeouts. Defaults to the machine type setting.

v1.FeatureState

reset
optional

Reset enables Hyperv reboot/reset for the vmi. Requires synic. Defaults to the machine type setting.

v1.FeatureState

runtime
optional

Runtime improves the time accounting to improve scheduling in the guest. Defaults to the machine type setting.

v1.FeatureState

spinlocks
optional

Spinlocks allows to configure the spinlock retry attempts.

v1.FeatureSpinlocks

synic
optional

SyNIC enables the Synthetic Interrupt Controller. Defaults to the machine type setting.

v1.FeatureState

synictimer
optional

SyNICTimer enables Synthetic Interrupt Controller Timers, reducing CPU load. Defaults to the machine type setting.

v1.FeatureState

tlbflush
optional

TLBFlush improves performances in overcommited environments. Requires vpindex. Defaults to the machine type setting.

v1.FeatureState

vapic
optional

VAPIC improves the paravirtualized handling of interrupts. Defaults to the machine type setting.

v1.FeatureState

vendorid
optional

VendorID allows setting the hypervisor vendor id. Defaults to the machine type setting.

v1.FeatureVendorID

vpindex
optional

VPIndex enables the Virtual Processor Index to help windows identifying virtual processors. Defaults to the machine type setting.

v1.FeatureState

enabled
optional

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

boolean

spinlocks
optional

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

integer (int64)

enabled
optional

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

boolean

enabled
optional

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

boolean

vendorid
optional

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

string

acpi
optional

ACPI enables/disables ACPI insidejsondata guest. Defaults to enabled.

v1.FeatureState

apic
optional

Defaults to the machine type setting.

v1.FeatureAPIC

hyperv
optional

Defaults to the machine type setting.

v1.FeatureHyperv

smm
optional

SMM enables/disables System Management Mode. TSEG not yet implemented.

v1.FeatureState

bootloader
optional

Settings to control the bootloader that is used.

v1.Bootloader

serial
optional

The system-serial-number in SMBIOS

string

uuid
optional

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

string

readonly
optional

ReadOnly. Defaults to false.

boolean

tray
optional

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

string

deviceName
required

string

name
required

Name of the GPU device as exposed by a device plugin

string

groupVersion
required

groupVersion specifies the API group and version in the form "group/version"

string

version
required

version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.

string

present
optional

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

boolean

tickPolicy
optional

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

string

host
optional

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

string

httpHeaders
optional

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

< v1.HTTPHeader > array

path
optional

Path to access on the HTTP server.

string

scheme
optional

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

string

name
required

The header field name

string

value
required

The header field value

string

capacity
optional

Capacity of the sparse disk

resource.Quantity

path
required

The path to HostDisk image located on the cluster

string

shared
optional

Shared indicate whether the path is shared between nodes

boolean

type
required

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

string

pageSize
optional

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

string

present
optional

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

boolean

action
optional

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

string

bus
optional

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

string

name
required

Name is the device name

string

type
required

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

string

bootOrder
optional

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.

integer (int32)

bridge
optional

v1.InterfaceBridge

dhcpOptions
optional

If specified the network interface will pass additional DHCP options to the VMI

v1.DHCPOptions

macAddress
optional

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

string

masquerade
optional

v1.InterfaceMasquerade

model
optional

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

string

name
required

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

string

pciAddress
optional

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

string

ports
optional

List of ports to be forwarded to the virtual machine.

< v1.Port > array

slirp
optional

v1.InterfaceSlirp

sriov
optional

v1.InterfaceSRIOV

tag
optional

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

string

present
optional

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

boolean

matchExpressions
optional

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

< v1.LabelSelectorRequirement > array

matchLabels
optional

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.

< string, string > map

key
required

key is the label key that the selector applies to.

string

operator
required

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

string

values
optional

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.

< string > array

continue
optional

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.

string

remainingItemCount
optional

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.

integer (int64)

resourceVersion
optional

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

string

selfLink
optional

selfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

string

name
optional

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

string

bus
optional

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

string

readonly
optional

ReadOnly. Defaults to false.

boolean

type
required

QEMU machine type is the actual chipset of the VirtualMachineInstance.

string

apiVersion
optional

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.

string

fieldsType
optional

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

string

fieldsV1
optional

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

v1.FieldsV1

manager
optional

Manager is an identifier of the workflow managing these fields.

string

operation
optional

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

string

time
optional

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

v1.Time

guest
optional

Guest allows to specifying the amount of memory which is visible inside the Guest OS. The Guest must lie between Requests and Limits from the resources section. Defaults to the requested memory in the resources section if not specified.

resource.Quantity

hugepages
optional

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

v1.Hugepages

default
optional

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

boolean

networkName
required

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

string

multus
optional

v1.MultusNetwork

name
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

string

pod
optional

v1.PodNetwork

preferredDuringSchedulingIgnoredDuringExecution
optional

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.

< v1.PreferredSchedulingTerm > array

requiredDuringSchedulingIgnoredDuringExecution
optional

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

v1.NodeSelector

nodeSelectorTerms
required

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

< v1.NodeSelectorTerm > array

key
required

The label key that the selector applies to.

string

operator
required

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

string

values
optional

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

< string > array

matchExpressions
optional

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

< v1.NodeSelectorRequirement > array

matchFields
optional

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

< v1.NodeSelectorRequirement > array

annotations
optional

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

< string, string > map

clusterName
optional

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

string

deletionGracePeriodSeconds
optional

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.

integer (int64)

deletionTimestamp
optional

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

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

v1.Time

finalizers
optional

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.

< string > array

generateName
optional

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

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

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

string

generation
optional

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

integer (int64)

labels
optional

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

< string, string > map

managedFields
optional

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.

< v1.ManagedFieldsEntry > array

name
optional

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

string

namespace
optional

Namespace defines the space within 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: http://kubernetes.io/docs/user-guide/namespaces

string

ownerReferences
optional

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.

< v1.OwnerReference > array

resourceVersion
optional

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

string

selfLink
optional

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

string

uid
optional

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: http://kubernetes.io/docs/user-guide/identifiers#uids

string

apiVersion
required

API version of the referent.

string

blockOwnerDeletion
optional

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

boolean

controller
optional

If true, this reference points to the managing controller.

boolean

kind
required

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

string

name
required

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

string

uid
required

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

string

present
optional

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

boolean

tickPolicy
optional

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

string

accessModes
optional

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

< string > array

dataSource
optional

This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.

v1.TypedLocalObjectReference

resources
optional

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

v1.ResourceRequirements

selector
optional

A label query over volumes to consider for binding.

v1.LabelSelector

storageClassName
optional

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

string

volumeMode
optional

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

string

volumeName
optional

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

string

claimName
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

string

readOnly
optional

Will force the ReadOnly setting in VolumeMounts. Default false.

boolean

preferredDuringSchedulingIgnoredDuringExecution
optional

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.

< v1.WeightedPodAffinityTerm > array

requiredDuringSchedulingIgnoredDuringExecution
optional

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.

< v1.PodAffinityTerm > array

labelSelector
optional

A label query over a set of resources, in this case pods.

v1.LabelSelector

namespaces
optional

namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod’s namespace"

< string > array

topologyKey
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.

string

preferredDuringSchedulingIgnoredDuringExecution
optional

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

< v1.WeightedPodAffinityTerm > array

requiredDuringSchedulingIgnoredDuringExecution
optional

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.

< v1.PodAffinityTerm > array

nameservers
optional

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

< string > array

options
optional

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.

< v1.PodDNSConfigOption > array

searches
optional

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.

< string > array

name
optional

Required.

string

value
optional

string

vmNetworkCIDR
optional

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

string

name
optional

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

string

port
required

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

integer (int32)

protocol
optional

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

string

resourceVersion
optional

Specifies the target ResourceVersion

string

uid
optional

Specifies the target UID.

string

preference
required

A node selector term, associated with the corresponding weight.

v1.NodeSelectorTerm

weight
required

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

integer (int32)

failureThreshold
optional

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

integer (int32)

httpGet
optional

HTTPGet specifies the http request to perform.

v1.HTTPGetAction

initialDelaySeconds
optional

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

integer (int32)

periodSeconds
optional

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

integer (int32)

successThreshold
optional

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.

integer (int32)

tcpSocket
optional

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

v1.TCPSocketAction

timeoutSeconds
optional

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

integer (int32)

present
optional

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

boolean

tickPolicy
optional

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

string

track
optional

Track the guest or the wall clock.

string

limits
optional

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

< string, resource.Quantity > map

overcommitGuestOverhead
optional

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.

boolean

requests
optional

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

< string, resource.Quantity > map

apiVersion
optional

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

string

gracePeriodSeconds
optional

The duration in seconds before the object should be force-restared. Value must be non-negative integer. The value zero indicates, restart immediately. If this value is nil, the default grace period for deletion of the corresponding VMI for the specified type will be used to determine on how much time to give the VMI to restart. Defaults to a per object value if not specified. zero means restart immediately. Allowed Values: nil and 0

integer (int64)

kind
optional

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

string

paths
required

paths are the paths available at root.

< string > array

optional
optional

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

boolean

secretName
optional

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

string

volumeLabel
optional

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).

string

clientCIDR
required

The CIDR with which clients can match their IP to figure out the server address that they should use.

string

serverAddress
required

Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.

string

serviceAccountName
optional

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/

string

apiVersion
optional

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

string

code
optional

Suggested HTTP return code for this status, 0 if not set.

integer (int32)

details
optional

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

v1.StatusDetails

kind
optional

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

string

message
optional

A human-readable description of the status of this operation.

string

metadata
optional

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

v1.ListMeta

reason
optional

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

string

status
optional

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

string

field
optional

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"

string

message
optional

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

string

reason
optional

A machine-readable description of the cause of the error. If this value is empty there is no information available.

string

causes
optional

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

< v1.StatusCause > array

group
optional

The group attribute of the resource associated with the status StatusReason.

string

kind
optional

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

string

name
optional

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

string

retryAfterSeconds
optional

If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.

integer (int32)

uid
optional

UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

string

host
optional

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

string

hpet
optional

HPET (High Precision Event Timer) - multiple timers with periodic interrupts.

v1.HPETTimer

hyperv
optional

Hyperv (Hypervclock) - lets guests read the host’s wall clock time (paravirtualized). For windows guests.

v1.HypervTimer

kvm
optional

KVM (KVM clock) - lets guests read the host’s wall clock time (paravirtualized). For linux guests.

v1.KVMTimer

pit
optional

PIT (Programmable Interval Timer) - a timer with periodic interrupts.

v1.PITTimer

rtc
optional

RTC (Real Time Clock) - a continuously running timer with periodic interrupts.

v1.RTCTimer

effect
optional

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

string

key
optional

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.

string

operator
optional

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

string

tolerationSeconds
optional

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.

integer (int64)

value
optional

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

string

apiGroup
optional

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

string

kind
required

Kind is the type of resource being referenced

string

name
required

Name is the name of resource being referenced

string

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

v1.ObjectMeta

spec
required

Spec contains the specification of VirtualMachineInstance created

v1.VirtualMachineSpec

status
optional

Status holds the current state of the controller and brief information about its associated VirtualMachineInstance

v1.VirtualMachineStatus

message
optional

string

reason
optional

string

status
required

string

type
required

string

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

v1.ObjectMeta

spec
required

VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

v1.VirtualMachineInstanceSpec

status
optional

Status is the high level overview of how the VirtualMachineInstance is doing. It contains information available to controllers and users.

v1.VirtualMachineInstanceStatus

message
optional

string

reason
optional

string

status
required

string

type
required

string

diskName
required

string

fileSystemType
required

string

mountPoint
required

string

totalBytes
required

integer (int32)

usedBytes
required

integer (int32)

disks
required

< v1.VirtualMachineInstanceFileSystem > array

apiVersion
optional

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

string

items
required

< v1.VirtualMachineInstanceFileSystem > array

kind
optional

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

string

metadata
optional

v1.ListMeta

apiVersion
optional

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

string

fsInfo
optional

FSInfo is a guest os filesystem information containing the disk mapping and disk mounts with usage

v1.VirtualMachineInstanceFileSystemInfo

guestAgentVersion
optional

GAVersion is a version of currently installed guest agent

string

hostname
optional

Hostname represents FQDN of a guest

string

kind
optional

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

string

os
optional

OS contains the guest operating system information

v1.VirtualMachineInstanceGuestOSInfo

timezone
optional

Timezone is guest os current timezone

string

userList
optional

UserList is a list of active guest OS users

< v1.VirtualMachineInstanceGuestOSUser > array

id
optional

Guest OS Id

string

kernelRelease
optional

Guest OS Kernel Release

string

kernelVersion
optional

Kernel version of the Guest OS

string

machine
optional

Machine type of the Guest OS

string

name
optional

Name of the Guest OS

string

prettyName
optional

Guest OS Pretty Name

string

version
optional

Guest OS Version

string

versionId
optional

Version ID of the Guest OS

string

domain
optional

string

loginTime
optional

number (double)

userName
required

string

apiVersion
optional

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

string

items
required

< v1.VirtualMachineInstanceGuestOSUser > array

kind
optional

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

string

metadata
optional

v1.ListMeta

apiVersion
optional

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

string

items
required

< v1.VirtualMachineInstance > array

kind
optional

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

string

metadata
optional

v1.ListMeta

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

v1.ObjectMeta

spec
required

v1.VirtualMachineInstanceMigrationSpec

status
optional

v1.VirtualMachineInstanceMigrationStatus

message
optional

string

reason
optional

string

status
required

string

type
required

string

apiVersion
optional

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

string

items
required

< v1.VirtualMachineInstanceMigration > array

kind
optional

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

string

metadata
optional

v1.ListMeta

vmiName
optional

The name of the VMI to perform the migration on. VMI must exist in the migration objects namespace

string

abortRequested
optional

Indicates that the migration has been requested to abort

boolean

abortStatus
optional

Indicates the final status of the live migration abortion

string

completed
optional

Indicates the migration completed

boolean

endTimestamp
optional

The time the migration action ended

v1.Time

failed
optional

Indicates that the migration failed

boolean

migrationUid
optional

The VirtualMachineInstanceMigration object associated with this migration

string

sourceNode
optional

The source node that the VMI originated on

string

startTimestamp
optional

The time the migration action began

v1.Time

targetDirectMigrationNodePorts
optional

The list of ports opened for live migration on the destination node

< string, integer (int32) > map

targetNode
optional

The target node that the VMI is moving to

string

targetNodeAddress
optional

The address of the target node to use for the migration

string

targetNodeDomainDetected
optional

The Target Node has seen the Domain Start Event

boolean

targetPod
optional

The target pod that the VMI is moving to

string

conditions
optional

< v1.VirtualMachineInstanceMigrationCondition > array

phase
optional

string

interfaceName
optional

The interface name inside the Virtual Machine

string

ipAddress
optional

IP address of a Virtual Machine interface. It is always the first item of IPs

string

ipAddresses
optional

List of all IP addresses of a Virtual Machine interface

< string > array

mac
optional

Hardware address of a Virtual Machine interface

string

name
optional

Name of the interface, corresponds to name of the network assigned to the interface

string

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

v1.ObjectMeta

spec
optional

VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

v1.VirtualMachineInstancePresetSpec

apiVersion
optional

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

string

items
required

< v1.VirtualMachineInstancePreset > array

kind
optional

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

string

metadata
optional

v1.ListMeta

domain
optional

Domain is the same object type as contained in VirtualMachineInstanceSpec

v1.DomainSpec

selector
required

Selector is a label query over a set of VMIs. Required.

v1.LabelSelector

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

v1.ObjectMeta

spec
required

VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

v1.VirtualMachineInstanceReplicaSetSpec

status
optional

Status is the high level overview of how the VirtualMachineInstance is doing. It contains information available to controllers and users.

v1.VirtualMachineInstanceReplicaSetStatus

message
optional

string

reason
optional

string

status
required

string

type
required

string

apiVersion
optional

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

string

items
required

< v1.VirtualMachineInstanceReplicaSet > array

kind
optional

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

string

metadata
optional

v1.ListMeta

paused
optional

Indicates that the replica set is paused.

boolean

replicas
optional

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

integer (int32)

selector
required

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.

v1.LabelSelector

template
required

Template describes the pods that will be created.

v1.VirtualMachineInstanceTemplateSpec

conditions
optional

< v1.VirtualMachineInstanceReplicaSetCondition > array

labelSelector
optional

Canonical form of the label selector for HPA which consumes it through the scale subresource.

string

readyReplicas
optional

The number of ready replicas for this replica set.

integer (int32)

replicas
optional

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

integer (int32)

affinity
optional

If affinity is specifies, obey all the affinity rules

v1.Affinity

dnsConfig
optional

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

v1.PodDNSConfig

dnsPolicy
optional

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'.

string

domain
required

Specification of the desired behavior of the VirtualMachineInstance on the host.

v1.DomainSpec

evictionStrategy
optional

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

string

hostname
optional

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.

string

livenessProbe
optional

Periodic probe of VirtualMachineInstance liveness. VirtualmachineInstances will be stopped if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

v1.Probe

networks
optional

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

< v1.Network > array

nodeSelector
optional

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/

< string, string > map

priorityClassName
optional

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

string

readinessProbe
optional

Periodic probe of VirtualMachineInstance service readiness. VirtualmachineInstances will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

v1.Probe

schedulerName
optional

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

string

subdomain
optional

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

string

terminationGracePeriodSeconds
optional

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

integer (int64)

tolerations
optional

If toleration is specified, obey all the toleration rules.

< v1.Toleration > array

volumes
optional

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

< v1.Volume > array

activePods
optional

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.

< string, string > map

conditions
optional

Conditions are specific points in VirtualMachineInstance’s pod runtime.

< v1.VirtualMachineInstanceCondition > array

guestOSInfo
optional

Guest OS Information

v1.VirtualMachineInstanceGuestOSInfo

interfaces
optional

Interfaces represent the details of available network interfaces.

< v1.VirtualMachineInstanceNetworkInterface > array

migrationMethod
optional

Represents the method using which the vmi can be migrated: live migration or block migration

string

migrationState
optional

Represents the status of a live migration

v1.VirtualMachineInstanceMigrationState

nodeName
optional

NodeName is the name where the VirtualMachineInstance is currently running.

string

phase
optional

Phase is the status of the VirtualMachineInstance in kubernetes world. It is not the VirtualMachineInstance status, but partially correlates to it.

string

qosClass
optional

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

string

reason
optional

A brief CamelCase message indicating details about why the VMI is in this state. e.g. 'NodeUnresponsive'

string

metadata
optional

v1.ObjectMeta

spec
optional

VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

v1.VirtualMachineInstanceSpec

apiVersion
optional

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

string

items
required

< v1.VirtualMachine > array

kind
optional

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

string

metadata
optional

v1.ListMeta

dataVolumeTemplates
optional

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

< v1alpha1.DataVolume > array

runStrategy
optional

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

string

running
optional

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

boolean

template
required

Template is the direct specification of VirtualMachineInstance

v1.VirtualMachineInstanceTemplateSpec

action
required

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

string

data
optional

Provides additional data in order to perform the Action

< string, string > map

uid
optional

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

string

conditions
optional

Hold the state information of the VirtualMachine and its VirtualMachineInstance

< v1.VirtualMachineCondition > array

created
optional

Created indicates if the virtual machine is created in the cluster

boolean

ready
optional

Ready indicates if the virtual machine is running and ready

boolean

stateChangeRequests
optional

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

< v1.VirtualMachineStateChangeRequest > array

cloudInitConfigDrive
optional

CloudInitConfigDrive represents a cloud-init Config Drive user-data source. The Config Drive data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest. More info: https://cloudinit.readthedocs.io/en/latest/topics/datasources/configdrive.html

v1.CloudInitConfigDriveSource

cloudInitNoCloud
optional

CloudInitNoCloud represents a cloud-init NoCloud user-data source. The NoCloud data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest. More info: http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html

v1.CloudInitNoCloudSource

configMap
optional

ConfigMapSource represents a reference to a ConfigMap in the same namespace. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/

v1.ConfigMapVolumeSource

containerDisk
optional

ContainerDisk references a docker image, embedding a qcow or raw disk. More info: https://kubevirt.gitbooks.io/user-guide/registry-disk.html

v1.ContainerDiskSource

dataVolume
optional

DataVolume represents the dynamic creation a PVC for this volume as well as the process of populating that PVC with a disk image.

v1.DataVolumeSource

emptyDisk
optional

EmptyDisk represents a temporary disk which shares the vmis lifecycle. More info: https://kubevirt.gitbooks.io/user-guide/disks-and-volumes.html

v1.EmptyDiskSource

ephemeral
optional

Ephemeral is a special volume source that "wraps" specified source and provides copy-on-write image on top of it.

v1.EphemeralVolumeSource

hostDisk
optional

HostDisk represents a disk created on the cluster level

v1.HostDisk

name
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

string

persistentVolumeClaim
optional

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

v1.PersistentVolumeClaimVolumeSource

secret
optional

SecretVolumeSource represents a reference to a secret data in the same namespace. More info: https://kubernetes.io/docs/concepts/configuration/secret/

v1.SecretVolumeSource

serviceAccount
optional

ServiceAccountVolumeSource represents a reference to a service account. There can only be one volume of this type! More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

v1.ServiceAccountVolumeSource

object
required

Object is: * If Type is Added or Modified: the new state of the object. * If Type is Deleted: the state of the object immediately before deletion. * If Type is Error: *Status is recommended; other types may make sense depending on context.

runtime.RawExtension

type
required

string

i6300esb
optional

i6300esb watchdog device.

v1.I6300ESBWatchdog

name
required

Name of the watchdog.

string

podAffinityTerm
required

Required. A pod affinity term, associated with the corresponding weight.

v1.PodAffinityTerm

weight
required

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

integer (int32)

apiVersion
optional

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

string

kind
optional

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

string

metadata
optional

v1.ObjectMeta

spec
required

v1alpha1.DataVolumeSpec

status
optional

v1alpha1.DataVolumeStatus

blank
optional

v1alpha1.DataVolumeBlankImage

http
optional

v1alpha1.DataVolumeSourceHTTP

pvc
optional

v1alpha1.DataVolumeSourcePVC

registry
optional

v1alpha1.DataVolumeSourceRegistry

s3
optional

v1alpha1.DataVolumeSourceS3

upload
optional

v1alpha1.DataVolumeSourceUpload

certConfigMap
optional

CertConfigMap provides a reference to the Registry certs

string

secretRef
optional

SecretRef provides the secret reference needed to access the HTTP source

string

url
optional

URL is the URL of the http source

string

name
optional

string

namespace
optional

string

certConfigMap
optional

CertConfigMap provides a reference to the Registry certs

string

secretRef
optional

SecretRef provides the secret reference needed to access the Registry source

string

url
optional

URL is the url of the Registry source

string

secretRef
optional

SecretRef provides the secret reference needed to access the S3 source

string

url
optional

URL is the url of the S3 source

string

contentType
optional

DataVolumeContentType options: "kubevirt", "archive"

string

pvc
required

PVC is a pointer to the PVC Spec we want to use

v1.PersistentVolumeClaimSpec

source
required

Source is the src of the data for the requested DataVolume

v1alpha1.DataVolumeSource

phase
optional

Phase is the current phase of the data volume

string

progress
optional

string