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

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

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

Name Schema

bus
required

string

domain
required

string

function
required

string

slot
required

string

type
required

string

v1.Affinity

Affinity groups all the affinity rules related to a VM

Name Description Schema

nodeAffinity
optional

Host affinity support

v1.NodeAffinity

v1.Alias

Name Schema

name
required

string

v1.Ballooning

Name Schema

model
required

string

v1.Boot

Name Schema

dev
required

string

v1.BootMenu

Name Schema

enabled
optional

boolean

timeout
optional

integer (integer)

v1.BootOrder

Name Schema

order
required

integer (integer)

v1.Channel

Name Schema

source
optional

v1.ChannelSource

target
optional

v1.ChannelTarget

type
required

string

v1.ChannelSource

Name Schema

mode
required

string

path
required

string

v1.ChannelTarget

Name Schema

address
optional

string

name
optional

string

port
optional

integer (integer)

type
required

string

v1.CloudInitDataSourceNoCloud

Name Description Schema

metaDataBase64
required

The NoCloud cloud-init metadata as a base64 encoded string

string

userDataBase64
required

The NoCloud cloud-init userdata as a base64 encoded string

string

userDataSecretRef
required

Reference to a k8s secret that contains NoCloud userdata

string

v1.CloudInitSpec

Only one of the fields in the CloudInitSpec can be set

Name Description Schema

nocloud
required

Nocloud DataSource

v1.CloudInitDataSourceNoCloud

v1.Console

Name Schema

target
optional

v1.ConsoleTarget

type
required

string

v1.ConsoleTarget

Name Schema

port
optional

integer (integer)

type
optional

string

v1.Devices

Name Schema

channels
optional

< v1.Channel > array

consoles
optional

< v1.Console > array

disks
optional

< v1.Disk > array

emulator
optional

string

graphics
optional

< v1.Graphics > array

interfaces
optional

< v1.Interface > array

memballoon
optional

v1.Ballooning

serials
optional

< v1.Serial > array

video
optional

< v1.Video > array

watchdog
optional

v1.Watchdog

v1.Disk

Name Schema

auth
optional

v1.DiskAuth

cloudinit
optional

v1.CloudInitSpec

device
required

string

driver
optional

v1.DiskDriver

readOnly
optional

v1.ReadOnly

serial
optional

string

snapshot
optional

string

source
required

v1.DiskSource

target
required

v1.DiskTarget

type
required

string

v1.DiskAuth

Name Schema

secret
optional

v1.DiskSecret

username
required

string

v1.DiskDriver

Name Schema

cache
optional

string

errorPolicy
optional

string

io
optional

string

name
optional

string

type
optional

string

v1.DiskSecret

Name Schema

type
required

string

usage
required

string

v1.DiskSource

Name Schema

file
optional

string

host
optional

v1.DiskSourceHost

name
optional

string

protocol
optional

string

startupPolicy
optional

string

v1.DiskSourceHost

Name Schema

name
required

string

port
optional

string

v1.DiskTarget

Name Schema

bus
optional

string

dev
required

string

v1.DomainSpec

Name Schema

clock
optional

v1.Clock

devices
required

v1.Devices

memory
required

v1.Memory

os
required

v1.OS

sysInfo
optional

v1.SysInfo

type
required

string

v1.Entry

Name Schema

name
required

string

value
required

string

v1.FilterRef

Name Schema

filter
required

string

v1.Graphics

Name Schema

autoPort
optional

string

defaultMode
optional

string

listen
optional

v1.Listen

passwdValidTo
optional

string

port
optional

integer (int32)

tlsPort
optional

integer (int32)

type
required

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

Name Schema

address
optional

v1.Address

alias
optional

v1.Alias

bandwidth
optional

v1.BandWidth

boot
optional

v1.BootOrder

filterRef
optional

v1.FilterRef

link
optional

v1.LinkState

mac
optional

v1.MAC

model
optional

v1.Model

source
required

v1.InterfaceSource

target
optional

v1.InterfaceTarget

type
required

string

v1.InterfaceSource

Name Schema

bridge
optional

string

device
optional

string

network
optional

string

v1.InterfaceTarget

Name Schema

dev
required

string

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

Name Schema

state
required

string

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

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

Name Schema

address
optional

string

network
optional

string

type
required

string

v1.MAC

Name Schema

address
required

string

v1.Memory

Name Schema

unit
required

string

value
required

integer (integer)

v1.Migration

A Migration is a job that moves a Virtual Machine from one node to another

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

v1.MigrationSpec

status
optional

v1.MigrationStatus

v1.MigrationList

A list of Migrations

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

MigrationSpec is a description of a VM Migration For example "destinationNodeName": "testvm" will migrate a VM called "testvm" in the namespace "default"

Name Description Schema

nodeSelector
optional

Criteria to use when selecting the destination for the migration for example, to select by the hostname, specify kubernetes.io/hostname: master other possible choices include the hardware required to run the vm or or lableing of the nodes to indicate their roles in larger applications. examples: disktype: ssd, randomGenerator: /dev/random, randomGenerator: superfastdevice, app: mysql, licensedForServiceX: true Note that these selectors are additions to the node selectors on the VM itself and they must not exist on the VM. If they are conflicting with the VM, no migration will be started.

object

selector
required

Criterias for selecting the VM to migrate. For example selector: name: testvm will select the VM testvm for migration

v1.VMSelector

v1.MigrationStatus

MigrationStatus is the last reported status of a VM Migratrion. Status may trail the actual state of a migration.

Name Schema

instance
optional

types.UID

phase
optional

string

v1.Model

Name Schema

type
required

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

Name Schema

bios
optional

v1.BIOS

bootMenu
optional

v1.BootMenu

bootOrder
required

< v1.Boot > array

smBIOS
optional

v1.SMBios

type
required

v1.OSType

v1.OSType

Name Schema

arch
optional

string

machine
optional

string

os
required

string

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

Name Schema

mode
required

string

v1.Serial

Name Schema

target
optional

v1.SerialTarget

type
required

string

v1.SerialTarget

Name Schema

port
optional

integer (integer)

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

Name Schema

baseBoard
required

< v1.Entry > array

bios
required

< v1.Entry > array

system
required

< v1.Entry > array

type
required

string

v1.VMCondition

Name Schema

lastProbeTime
optional

string

lastTransitionTime
optional

string

message
optional

string

reason
optional

string

status
required

string

type
required

string

v1.VMGraphics

Name Schema

host
required

string

port
required

integer (int32)

type
required

string

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
required

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

Name Description Schema

name
required

Name of the VM to migrate

string

v1.VMSpec

VMSpec is a description of a VM. Not to be confused with api.DomainSpec in virt-handler. It is expected that v1.DomainSpec will be merged into this structure.

Name Description Schema

affinity
optional

If affinity is specifies, obey all the affinity rules

v1.Affinity

domain
optional

Domain is the actual libvirt domain.

v1.DomainSpec

nodeSelector
optional

If labels are specified, only nodes marked with all of these labels are considered when scheduling the VM.

object

v1.VMStatus

VMStatus 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.VMCondition > array

graphics
required

Graphics represent the details of available graphical consoles.

< v1.VMGraphics > array

migrationNodeName
optional

MigrationNodeName is the node where the VM is live migrating to.

string

nodeName
optional

NodeName is the name where the VM is currently running.

string

phase
required

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

string

v1.VMTemplateSpec

Name Description Schema

metadata
optional

v1.ObjectMeta

spec
optional

VM Spec contains the VM specification.

v1.VMSpec

v1.Video

Name Schema

heads
optional

integer (integer)

ram
optional

integer (integer)

type
required

string

vRam
optional

integer (integer)

vgaMem
optional

integer (integer)

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

status
required

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

v1.VMStatus

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

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

Hardware watchdog device

Name Description Schema

action
required

The action to take. poweroff, reset, shutdown, pause, dump.

string

model
required

Defines what watchdog model to use, typically 'i6300esb'

string