API Reference
Packages
tensorstack.dev/v1beta1
Package v1beta1 contains API Schema definitions for the v1beta1 API group
Resource Types
AdditionalDiskConfig
Appears in:
| Field | Description |
|---|---|
name string | |
bus DiskBus | Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi. |
serial string | The system-serial-number in SMBIOS |
VolumeSource VolumeSource | VolumeSource represents the location and type of the mounted volume. Defaults to Disk, if no type is specified. |
CPURequirements
CPU resources info, including cpu model and count.
Appears in:
| Field | Description |
|---|---|
model string | virt-handler detects cpus on nodes and add cpu-model.node.kubevirt.io/[model-name] labels to nodes. Set this filed to filter nodes by model. optional |
cores Quantity | Count of cpu. |
FileSystemConfig
Appears in:
| Field | Description |
|---|---|
name string | |
VolumeSource VolumeSource | VolumeSource represents the location and type of the mounted volume. Defaults to Disk, if no type is specified. |
GPURequirements
GPU resources info, including device name and count.
Appears in:
| Field | Description |
|---|---|
type string | kubevirt-gpu-device-plugin detects gpus on nodes and add extended resources to k8s cluster. Type is the name of gpu extended resource, it is usually related to gpu device name. |
count integer | Count of gpus in use. |
Network
Appears in:
| Field | Description |
|---|---|
tcp integer array | The ports exposed with TCP protocol. |
udp integer array | The ports exposed with UDP protocol. |
macAddress string | Interface MAC address. For example: de:ad:00:00:be:af or DE-AD-00-00-BE-AF. |
dnsConfig PodDNSConfig | Specifies the DNS parameters of a VM. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. |
dnsPolicy DNSPolicy | Set DNS policy for the VM. 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'. |
PVCTemplate
Appears in:
| Field | Description |
|---|---|
size Quantity | PVC Size |
volumeMode PersistentVolumeMode | volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
accessModes PersistentVolumeAccessMode array | AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
storageClassName string | Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
ResourceRequirements
Resources allocated to VirtualMachine.
Appears in:
| Field | Description |
|---|---|
gpu GPURequirements | GPU resources allocated to VirtualMachine. optional |
cpu CPURequirements | CPU required by this VirtualMachine. |
memory Quantity | Memory required by this VirtualMachine. |
RootDisk
Appears in:
| Field | Description |
|---|---|
ephemeral boolean | Not to record the data generated in the virtual machine to the root disk. Defaults to false. |
pvc PVCTemplate | Create and bind a new pvc to DataVolume. |
source DataVolumeSource | The src of the data for the requested DataVolume. |
bus DiskBus | Bus indicates the type of disk device to emulate. supported values: virtio, sata, scsi. |
SchedulePolicy
SchedulePolicy specifies the preferred scheduler responsible for handling resource allocation requests.
Appears in:
| Field | Description |
|---|---|
t9kScheduler T9kScheduler |
Storage
Appears in:
| Field | Description |
|---|---|
root RootDisk | Root disk. |
additionalDisks AdditionalDiskConfig array | Attach a volume as a disk to the VM. |
filesystems FileSystemConfig array | Filesystems describes filesystem which is connected to the VM. |
T9kScheduler
Appears in:
| Field | Description |
|---|---|
queue string | Name of the queue to use with the T9kScheduler. |
VMRef
Appears in:
| Field | Description |
|---|---|
name string |
VirtualServer
VirtualServer is the Schema for the virtualservers API
Appears in:
| Field | Description |
|---|---|
apiVersion string | tensorstack.dev/v1beta1 |
kind string | VirtualServer |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec VirtualServerSpec | |
status VirtualServerStatus |
VirtualServerCondition
VirtualServerCondition defines the observed condition of VirtualServer.
Appears in:
| Field | Description |
|---|---|
type VirtualServerConditionType | Type is the type of the condition. |
status ConditionStatus | Status is the status of the condition type. Possible values of are `True |
message string | Message is a human-readable message for the reason of the status. |
reason string | Unique, one-word, CamelCase reason for the vm's last transition. |
lastTransitionTime Time | LastTransitionTime is the last time the status was changed. |
VirtualServerConditionType
Underlying type: string
VirtualServerConditionType defines all possible types of VirtualServerCondition. Can be one of: DataImported, Ready, Failure or Paused.
Appears in:
VirtualServerList
VirtualServerList contains a list of VirtualServer
| Field | Description |
|---|---|
apiVersion string | tensorstack.dev/v1beta1 |
kind string | VirtualServerList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items VirtualServer array |
VirtualServerSpec
VirtualServerSpec defines the desired state of VirtualServer
Appears in:
| Field | Description |
|---|---|
resources ResourceRequirements | Compute Resources required by this VM. |
storage Storage | Disks and filesystems attached to the VM. |
firmware Firmware | Firmware. |
network Network | VM network config. |
runStrategy VirtualMachineRunStrategy | Running state indicates the requested running state of the VirtualMachineInstance |
useVirtioTransitional boolean | Fall back to legacy virtio 0.9 support if virtio bus is selected on devices. This is helpful for old machines like CentOS6 or RHEL6 which do not understand virtio_non_transitional (virtio 1.0). |
scheduler SchedulePolicy | Specifies the preferred scheduler responsible for handling resource allocation requests. |
cloudInit string | CloudInit 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 |
VirtualServerStatus
VirtualServerStatus defines the observed state of VirtualServer
Appears in:
| Field | Description |
|---|---|
conditions VirtualServerCondition array | The latest available observations of a VirtualServer's current state. |
printableStatus VirtualMachinePrintableStatus | PrintableStatus is a human readable, high-level representation of the status of the virtual machine |
vm VMRef | Refers to VirtualMachine created by this VirtualServer. |
runStrategy VirtualMachineRunStrategy | Running state indicates the requested running state of the VirtualMachineInstance mutually exclusive with Running |