Top Level API Objects

Definitions

v1.APIGroup

APIGroup contains the name, the supported versions, and the preferred version of a group.

Name Description Schema

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/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/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
required

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

v1.APIGroupList

APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.

Name Description Schema

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/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/api-conventions.md#types-kinds

string

v1.APIResource

APIResource specifies the name of a resource and whether it is namespaced.

Name Description Schema

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

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

v1.APIResourceList

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

Name Description Schema

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/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/api-conventions.md#types-kinds

string

resources
required

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

< v1.APIResource > array

v1.Affinity

Affinity groups all the affinity rules related to a VM

Name Description Schema

nodeAffinity
optional

Node affinity support

v1.NodeAffinity

v1.CDRomTarget

Name Description Schema

bus
optional

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

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 +optional

string

v1.CPU

CPU allow specifying the CPU topology

Name Description Schema

cores
optional

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

integer

v1.Clock

Represents the clock and timers of a vm

Name Description Schema

timer
required

Timer specifies whih timers are attached to the vm

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

v1.ClockOffsetTimezone

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

v1.ClockOffsetUTC

UTC sets the guest clock to UTC on each boot.

Name Description Schema

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)

v1.CloudInitNoCloudSource

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

Name Description Schema

secretRef
optional

UserDataSecretRef references a k8s secret that contains NoCloud userdata + optional

v1.LocalObjectReference

userData
optional

UserData contains NoCloud inline cloud-init userdata + optional

string

userDataBase64
optional

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

string

v1.DeleteOptions

DeleteOptions may be provided when deleting an API object.

Name Description Schema

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/api-conventions.md#resources

string

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

v1.DeletionPropagation

v1.Devices

Name Description Schema

disks
optional

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

< v1.Disk > array

watchdog
optional

Watchdog describes a watchdog device which can be added to the vm

v1.Watchdog

v1.Disk

Name Description Schema

cdrom
optional

Attach a volume as a cdrom to the vm

v1.CDRomTarget

disk
optional

Attach a volume as a disk to the vm

v1.DiskTarget

floppy
optional

Attach a volume as a floppy to the vm

v1.FloppyTarget

lun
optional

Attach a volume as a LUN to the vm

v1.LunTarget

name
required

Name is the device name

string

volumeName
required

Name of the volume which is referenced Must match the Name of a Volume.

string

v1.DiskTarget

Name Description Schema

bus
optional

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

string

readonly
optional

ReadOnly Defaults to false

boolean

v1.DomainSpec

Name Description Schema

clock
optional

Clock sets the clock and timers of the vm. +optional

v1.Clock

cpu
optional

CPU allow specified the detailed CPU topology inside the vm. +optional

v1.CPU

devices
required

Devices allows adding disks, network interfaces, …

v1.Devices

features
optional

Features like acpi, apic, hyperv +optional

v1.Features

firmware
optional

Firmware +optional

v1.Firmware

machine
optional

Machine type +optional

v1.Machine

resources
optional

Resources describes the Compute Resources required by this vm.

v1.ResourceRequirements

v1.EmptyDiskSource

EmptyDisk represents a temporary disk which shares the vms lifecycle

Name Description Schema

capacity
required

Capacity of the sparse disk.

string

v1.EphemeralVolumeSource

Name Description Schema

persistentVolumeClaim
optional

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

v1.PersistentVolumeClaimVolumeSource

v1.FeatureAPIC

Name Description Schema

enabled
optional

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

boolean

endOfInterrupt
optional

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

boolean

v1.FeatureHyperv

Hyperv specific features

Name Description Schema

relaxed
optional

Relaxed relaxes constraints on timer Defaults to the machine type setting +optional

v1.FeatureState

reset
optional

Reset enables Hyperv reboot/reset for the vm Defaults to the machine type setting +optional

v1.FeatureState

runtime
optional

Runtime Defaults to the machine type setting +optional

v1.FeatureState

spinlocks
optional

Spinlocks indicates if spinlocks should be made available to the guest +optional

v1.FeatureSpinlocks

synic
optional

SyNIC enable Synthetic Interrupt Controller Defaults to the machine type setting +optional

v1.FeatureState

synictimer
optional

SyNICTimer enable Synthetic Interrupt Controller timer Defaults to the machine type setting +optional

v1.FeatureState

vapic
optional

VAPIC indicates whether virtual APIC is enabled Defaults to the machine type setting +optional

v1.FeatureState

vendorid
optional

VendorID allows setting the hypervisor vendor id Defaults to the machine type setting +optional

v1.FeatureVendorID

vpindex
optional

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

v1.FeatureState

v1.FeatureSpinlocks

Name Description Schema

enabled
optional

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

boolean

spinlocks
optional

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

integer

v1.FeatureState

Represents if a feature is enabled or disabled

Name Description Schema

enabled
optional

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

boolean

v1.FeatureVendorID

Name Description Schema

enabled
optional

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

boolean

vendorid
required

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

string

v1.Features

Name Description Schema

acpi
optional

ACPI enables/disables ACPI insidejsondata guest Defaults to enabled +optional

v1.FeatureState

apic
optional

Defaults to the machine type setting +optional

v1.FeatureAPIC

hyperv
optional

Defaults to the machine type setting +optional

v1.FeatureHyperv

v1.Firmware

Name Description Schema

uuid
optional

UUID reported by the vm bios Defaults to a random generated uid

string

v1.FloppyTarget

Name Description Schema

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 +optional

string

v1.GroupVersionForDiscovery

GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.

Name Description Schema

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

v1.HPETTimer

Name Description Schema

present
optional

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

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

v1.HypervTimer

Name Description Schema

present
optional

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

boolean

v1.I6300ESBWatchdog

i6300esb watchdog device

Name Description Schema

action
optional

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

string

v1.Initializer

Initializer is information about an initializer that has not yet completed.

Name Description Schema

name
required

name of the process that is responsible for initializing this object.

string

v1.Initializers

Initializers tracks the progress of initialization.

Name Description Schema

pending
required

Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

< v1.Initializer > array

result
optional

If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.

v1.Status

v1.KVMTimer

Name Description Schema

present
optional

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

boolean

v1.LabelSelector

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.

Name Description Schema

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.

object

v1.LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name Description Schema

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

v1.ListMeta

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

Name Description Schema

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

string

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/api-conventions.md#concurrency-control-and-consistency

string

selfLink
optional

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

string

v1.LocalObjectReference

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

Name Description Schema

name
optional

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

string

v1.LunTarget

Name Description Schema

bus
optional

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

string

readonly
optional

ReadOnly Defaults to false

boolean

v1.Machine

Name Description Schema

type
required

QEMU machine type is the actual chipset of the VM.

string

v1.NodeAffinity

Node affinity is a group of node affinity scheduling rules.

Name Description Schema

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

v1.NodeSelector

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.

Name Description Schema

nodeSelectorTerms
required

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

< v1.NodeSelectorTerm > array

v1.NodeSelectorRequirement

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name Description Schema

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

v1.NodeSelectorTerm

A null or empty node selector term matches no objects.

Name Description Schema

matchExpressions
required

Required. A list of node selector requirements. The requirements are ANDed.

< v1.NodeSelectorRequirement > array

v1.ObjectMeta

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

Name Description Schema

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

object

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

creationTimestamp
optional

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/api-conventions.md#metadata

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/api-conventions.md#metadata

string

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

initializers
optional

An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven’t explicitly asked to observe uninitialized objects.

When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.

v1.Initializers

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

object

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/api-conventions.md#concurrency-control-and-consistency

string

selfLink
optional

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

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

v1.OfflineVirtualMachine

OfflineVirtualMachine handles the VirtualMachines that are not running or are in a stopped state The OfflineVirtualMachine contains the template to create the VirtualMachine. It also mirrors the running state of the created VirtualMachine in its status.

Name Description Schema

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/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/api-conventions.md#types-kinds

string

metadata
optional

v1.ObjectMeta

spec
optional

Spec contains the specification of VirtualMachine created

v1.OfflineVirtualMachineSpec

status
optional

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

v1.OfflineVirtualMachineStatus

v1.OfflineVirtualMachineCondition

OfflineVirtualMachineCondition represents the state of OfflineVirtualMachine

Name Schema

lastProbeTime
optional

string

lastTransitionTime
optional

string

message
optional

string

reason
optional

string

status
required

string

type
required

string

v1.OfflineVirtualMachineList

OfflineVirtualMachineList is a list of offlinevirtualmachines

Name Description Schema

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/api-conventions.md#resources

string

items
required

Items is a list of OfflineVirtualMachines

< v1.OfflineVirtualMachine > 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/api-conventions.md#types-kinds

string

metadata
required

v1.ListMeta

v1.OfflineVirtualMachineSpec

OfflineVirtualMachineSpec describes how the proper OfflineVirtualMachine should look like

Name Description Schema

running
required

Running controlls whether the associatied VirtualMachine is created or not

boolean

template
required

Template is the direct specification of VirtualMachine

v1.VMTemplateSpec

v1.OfflineVirtualMachineStatus

OfflineVirtualMachineStatus represents the status returned by the controller to describe how the OfflineVirtualMachine is doing

Name Description Schema

conditions
optional

Hold the state information of the OfflineVirtualMachine and its VirtualMachine

< v1.OfflineVirtualMachineCondition > array

v1.OwnerReference

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

Name Description Schema

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/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

v1.PITTimer

Name Description Schema

present
optional

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

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

v1.PersistentVolumeClaimVolumeSource

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

Name Description Schema

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

v1.Preconditions

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

Name Description Schema

uid
optional

Specifies the target UID.

types.UID

v1.PreferredSchedulingTerm

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name Description Schema

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)

v1.RTCTimer

Name Description Schema

present
optional

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

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

v1.RegistryDiskSource

Represents a docker image with an embedded disk

Name Description Schema

image
required

Image is the name of the image with the embedded disk

string

imagePullSecret
optional

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

string

v1.ResourceRequirements

Name Description Schema

limits
optional

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

object

requests
optional

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

object

v1.ServerAddressByClientCIDR

ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.

Name Description Schema

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

v1.Status

Status is a return value for calls that don’t return other objects.

Name Description Schema

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/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/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/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/api-conventions.md#spec-and-status

string

v1.StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Name Description Schema

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

v1.StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

Name Description Schema

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/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

v1.Timer

Represents all available timers in a vm

Name Description Schema

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

v1.VMReplicaSetCondition

Name Schema

lastProbeTime
optional

string

lastTransitionTime
optional

string

message
optional

string

reason
optional

string

status
required

string

type
required

string

v1.VMReplicaSetSpec

Name Description Schema

paused
optional

Indicates that the replica set is paused. +optional

boolean

replicas
optional

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

integer (int32)

selector
optional

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

v1.LabelSelector

template
required

Template describes the pods that will be created.

v1.VMTemplateSpec

v1.VMReplicaSetStatus

Name Description Schema

conditions
optional

< v1.VMReplicaSetCondition > array

readyReplicas
optional

The number of ready replicas for this replica set. +optional

integer (int32)

replicas
optional

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

integer (int32)

v1.VMTemplateSpec

Name Description Schema

metadata
optional

v1.ObjectMeta

spec
optional

VM Spec contains the VM specification.

v1.VirtualMachineSpec

v1.VirtualMachine

VirtualMachine is the VM Definition. It represents a virtual machine in the runtime environment of kubernetes.

Name Description Schema

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/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/api-conventions.md#types-kinds

string

metadata
optional

v1.ObjectMeta

spec
optional

VM Spec contains the VM specification.

v1.VirtualMachineSpec

status
optional

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

v1.VirtualMachineStatus

v1.VirtualMachineCondition

Name Schema

lastProbeTime
optional

string

lastTransitionTime
optional

string

message
optional

string

reason
optional

string

status
required

string

type
required

string

v1.VirtualMachineList

VirtualMachineList is a list of VirtualMachines

Name Description Schema

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/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/api-conventions.md#types-kinds

string

metadata
optional

v1.ListMeta

v1.VirtualMachineNetworkInterface

Name Description Schema

ipAddress
optional

IP address of a Virtual Machine interface

string

mac
optional

Hardware address of a Virtual Machine interface

string

v1.VirtualMachinePreset

Name Description Schema

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/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/api-conventions.md#types-kinds

string

metadata
optional

v1.ObjectMeta

spec
optional

VM Spec contains the VM specification.

v1.VirtualMachinePresetSpec

v1.VirtualMachinePresetList

VirtualMachinePresetList is a list of VirtualMachinePresets

Name Description Schema

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/api-conventions.md#resources

string

items
required

< v1.VirtualMachinePreset > 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/api-conventions.md#types-kinds

string

metadata
optional

v1.ListMeta

v1.VirtualMachinePresetSpec

Name Description Schema

domain
optional

Domain is the same object type as contained in VirtualMachineSpec

v1.DomainSpec

selector
required

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

v1.LabelSelector

v1.VirtualMachineReplicaSet

VM is the VM Definition. It represents a virtual machine in the runtime environment of kubernetes.

Name Description Schema

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/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/api-conventions.md#types-kinds

string

metadata
optional

v1.ObjectMeta

spec
optional

VM Spec contains the VM specification.

v1.VMReplicaSetSpec

status
optional

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

v1.VMReplicaSetStatus

v1.VirtualMachineReplicaSetList

VMList is a list of VMs

Name Description Schema

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/api-conventions.md#resources

string

items
required

< v1.VirtualMachineReplicaSet > 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/api-conventions.md#types-kinds

string

metadata
optional

v1.ListMeta

v1.VirtualMachineSpec

VirtualMachineSpec is a description of a VirtualMachine.

Name Description Schema

affinity
optional

If affinity is specifies, obey all the affinity rules

v1.Affinity

domain
required

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

v1.DomainSpec

nodeSelector
optional

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

object

terminationGracePeriodSeconds
optional

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

integer (int64)

volumes
optional

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

< v1.Volume > array

v1.VirtualMachineStatus

VirtualMachineStatus represents information about the status of a VM. Status may trail the actual state of a system.

Name Description Schema

conditions
optional

Conditions are specific points in VM’s pod runtime.

< v1.VirtualMachineCondition > array

interfaces
optional

Interfaces represent the details of available network interfaces.

< v1.VirtualMachineNetworkInterface > array

nodeName
optional

NodeName is the name where the VM is currently running.

string

phase
optional

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

string

v1.Volume

Volume represents a named volume in a vm.

Name Description Schema

cloudInitNoCloud
optional

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

v1.CloudInitNoCloudSource

emptyDisk
optional

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

v1.EmptyDiskSource

ephemeral
optional

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

v1.EphemeralVolumeSource

name
required

Volume’s 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

persistentVolumeClaim
optional

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

v1.PersistentVolumeClaimVolumeSource

registryDisk
optional

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

v1.RegistryDiskSource

v1.WatchEvent

Name Schema

object
required

string

type
required

string

v1.Watchdog

Named watchdog device

Name Description Schema

i6300esb
optional

i6300esb watchdog device +optional

v1.I6300ESBWatchdog

name
required

Name of the watchdog

string