vino/docs/api/vino.md
Kostiantyn Kalynovskyi bccf6d68c5 Adding ability to override VM interface
Change-Id: I35cc4368c4f7a0e0642c16d089bda910412a832c
2021-02-09 23:27:16 +00:00

12 KiB

Vino API reference

Packages:

airship.airshipit.org/v1

Package v1 contains API Schema definitions for the airship v1 API group

Resource Types:

    CPUConfiguration

    (Appears on: VinoSpec)

    CPUConfiguration CPU node configuration

    Field Description
    cpuExclude
    string

    Exclude CPU example 0-4,54-60

    DaemonSetOptions

    (Appears on: VinoSpec)

    DaemonSetOptions be used to spawn vino-builder, libvirt, sushy an

    Field Description
    namespacedName
    NamespacedName
    libvirtImage
    string
    sushyImage
    string
    vinoBuilderImage
    string
    nodeAnnotatorImage
    string

    DiskDrivesTemplate

    (Appears on: NodeSet)

    DiskDrivesTemplate defines disks on the VM

    Field Description
    name
    string
    type
    string
    path
    string
    options
    DiskOptions

    DiskOptions

    (Appears on: DiskDrivesTemplate)

    DiskOptions disk options

    Field Description
    sizeGb
    int
    sparse
    bool

    NamespacedName

    (Appears on: DaemonSetOptions, NodeSet)

    NamespacedName to be used to spawn VMs

    Field Description
    name
    string
    namespace
    string

    Network

    (Appears on: VinoSpec)

    Network defines libvirt networks

    Field Description
    name
    string

    Network Parameter defined

    subnet
    string
    allocationStart
    string
    allocationStop
    string
    dns_servers
    []string
    routes
    VMRoutes
    vmInterfaceName
    string

    VMinterfaceName defines the interface name to be used as bridge for virtual machines

    NetworkInterface

    (Appears on: NodeSet)

    NetworkInterface define interface on the VM

    Field Description
    name
    string

    Define parameter for network interfaces

    type
    string
    network
    string
    mtu
    int
    options
    map[string]string

    NodeSelector

    (Appears on: VinoSpec)

    NodeSelector identifies nodes to create VMs on

    Field Description
    matchLabels
    map[string]string

    Node type needs to specified

    NodeSet

    (Appears on: VinoSpec)

    NodeSet node definitions

    Field Description
    name
    string

    Parameter for Node master or worker-standard

    count
    int
    labels
    VMNodeFlavor
    libvirtTemplate
    NamespacedName
    networkInterfaces
    NetworkInterface
    diskDrives
    DiskDrivesTemplate

    VMNodeFlavor

    (Appears on: NodeSet)

    VMNodeFlavor labels for node to be annotated

    Field Description
    vmFlavor
    map[string]string

    VMRoutes

    (Appears on: Network)

    VMRoutes defined

    Field Description
    to
    string
    via
    string

    Vino

    Vino is the Schema for the vinoes API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    VinoSpec


    nodeSelector
    NodeSelector

    Define nodelabel parameters

    configuration
    CPUConfiguration

    Define CPU configuration

    networks
    Network

    Define network parameters

    nodes
    []NodeSet

    Define node details

    daemonSetOptions
    DaemonSetOptions

    DaemonSetOptions defines how vino will spawn daemonset on nodes

    status
    VinoStatus

    VinoSpec

    (Appears on: Vino)

    VinoSpec defines the desired state of Vino

    Field Description
    nodeSelector
    NodeSelector

    Define nodelabel parameters

    configuration
    CPUConfiguration

    Define CPU configuration

    networks
    Network

    Define network parameters

    nodes
    []NodeSet

    Define node details

    daemonSetOptions
    DaemonSetOptions

    DaemonSetOptions defines how vino will spawn daemonset on nodes

    VinoStatus

    (Appears on: Vino)

    VinoStatus defines the observed state of Vino

    This page was automatically generated with gen-crd-api-reference-docs