Skip to main content
Version: latest

Returns the specified libvirt cloud config

GET 

/v1/cloudconfigs/libvirt/:configUid

Returns the specified libvirt cloud config

Request

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses

OK

Schema

    apiVersionstring

    Deprecated. Not used for the resource info. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

    kindstring

    Cloud type of the cloud config

    metadata

    object

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

    annotations

    object

    Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.

    property name*string
    creationTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    deletionTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    labels

    object

    Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

    property name*string
    lastModifiedTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    namestring

    Name of the resource.

    uidstring

    UID is the unique identifier generated for the resource. This is not an input field for any request.

    spec

    object

    LibvirtCloudConfigSpec defines the desired state of LibvirtCloudConfig

    clusterConfig

    object

    required

    controlPlaneEndpoint

    object

    ControlPlaneEndpoint is the control plane endpoint, which can be an IP or FQDN

    ddnsSearchDomainstring

    DDNSSearchDomain is the search domain used for resolving IP addresses when the EndpointType is DDNS. This search domain is appended to the generated Hostname to obtain the complete DNS name for the endpoint. If Host is already a DDNS FQDN, DDNSSearchDomain is not required

    hoststring

    Host is FQDN(DDNS) or IP

    typestring

    Type indicates DDNS or VIP

    ntpServersstring[]

    NTPServers is a list of NTP servers to use instead of the machine image's default NTP server list

    sshKeysstring[]

    SSHKeys specifies a list of ssh authorized keys to access the vms as a 'spectro' user

    staticIpboolean

    StaticIP indicates if IP allocation type is static IP. DHCP is the default allocation type

    machinePoolConfig

    object[]

    required

  • Array [

  • additionalLabels

    object

    additionalLabels

    property name*string

    additionalTags

    object

    AdditionalTags is an optional set of tags to add to resources managed by the provider, in addition to the ones added by default. For eg., tags for EKS nodeGroup or EKS NodegroupIAMRole

    property name*string

    instanceType

    object

    required

    InstanceType defines the instance configuration of the vms in the machine pool

    cpuPassthroughSpec

    object

    Defines CPU Passthrough Spec. A not null value enables CPU Passthrough for the libvirt domain. Further cache passthrough can be enabled with the CPU passthrough spec.

    cachePassthroughboolean
    isEnabledboolean

    Enables the CPU Passthrough for the libvirt domain

    cpusetstring

    CPUSet defines cpuset for an instance which allows allocation specific set of cpus E.g cpuset="1-4,^3,6" See https://libvirt.org/formatdomain.html#cpu-allocation

    gpuConfig

    object

    GPU configuration

    addresses

    object

    Addresses is a map of PCI device entry name to its addresses. Example entry would be "11:00.0 VGA compatible controller [0300]: NVIDIA Corporation Device [10de:1eb1] (rev a1)"- > 0000_11_00_0" The address is BDF (Bus Device Function) identifier format seperated by underscores. The first 4 bits are almost always 0000. In the above example 11 is Bus, 00 is Device,0 is function. The values of these addreses are expected in hexadecimal format

    property name*string
    deviceModelstring

    DeviceModel is the model of GPU, for a given vendor, for eg., TU104GL [Tesla T4]

    numGPUsint32

    NumGPUs is the number of GPUs

    vendorNamestring

    VendorName is the GPU vendor, for eg., NVIDIA or AMD

    memoryInMBint32required

    MemoryinMB is the memory in megabytes

    numCPUsint32required

    NumCPUs is the number of CPUs

    isControlPlaneboolean

    whether this pool is for control plane

    labelsstring[]

    labels for this pool, example: master/worker, gpu, windows

    machinePoolProperties

    object

    Machine pool specific properties

    archTypestring

    Possible values: [amd64, arm64]

    Default value: amd64

    Architecture type of the pool. Default value is 'amd64'

    maxSizeint32

    max size of the pool, for scaling

    minSizeint32

    min size of the pool, for scaling

    namestring
    nodeRepaveIntervalint32

    Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster

    nonRootDisksInGB

    object[]

    NonRootDisksInGB is the list of additional disks, if required, in GB

  • Array [

  • dataStoragePoolstring

    DataStoragePool is the storage pool from which additional disks are assigned

    managedboolean

    Managed indicates if the disk is a persistent or not. By default its false indicating all disks are ephemeral.

    sizeInGBint32required

    SizeInGB is the target size in GB of the disk to be added

  • ]

  • placements

    object[]

    required

    Placements defines the configurations of the failureDomains(hosts) for the machine pool

  • Array [

  • dataStoragePoolstring

    DataStoragePool is the storage pool from which additional disks are assigned

    gpuDevices

    object[]

    GPU Devices is the list of LibvirtHost GPU devices, to be used for this placement

  • Array [

  • addresses

    object

    Addresses is a map of PCI device entry name to its addresses. Example entry would be "11:00.0 VGA compatible controller [0300]: NVIDIA Corporation Device [10de:1eb1] (rev a1)"- > 0000_11_00_0" The address is BDF (Bus Device Function) identifier format seperated by underscores. The first 4 bits are almost always 0000. In the above example 11 is Bus, 00 is Device,0 is function. The values of these addreses are expected in hexadecimal format

    property name*string
    modelstring

    Model is the model of GPU, for a given vendor, for eg., TU104GL [Tesla T4]

    vendorstring

    Vendor is the GPU vendor, for eg., NVIDIA or AMD

  • ]

  • hostAddressstringrequired

    HostAddress is a FQDN or IP address of the LibvirtHost

    hostIdentity

    object

    HostIdentity is the identity to access the LibvirtHost

    caCertstring

    CACert is the client CA certificate

    modestring

    Mode indicates a system or session connection to the host

    socketPathstring

    SocketPath is an optional path to the socket on the host, if not using defaults

    sshSecret

    object

    SSHSecrets to the secret containing ssh-username

    namestring

    SSH secret name

    privateKeystring

    Private Key to access the host

    hostUidstringrequired

    HostUid is the ID of the LibvirtHost

    networks

    object[]

    required

    Networks defines the network specifications of the vms in the machine pool

  • Array [

  • networkNamestringrequired

    NetworkName of the libvirt network where this machine will be connected

    networkTypestringrequired

    Possible values: [default, bridge]

    NetworkType specifies the type of network

  • ]

  • sourceStoragePoolstringrequired

    SourceStoragePool is the storage pool for the vm image

    targetStoragePoolstring

    TargetStoragePool is the optional storage pool from which additional disks are assigned. If not specified, the sourceStoragePool is also used as the targetStoragePool

  • ]

  • rootDiskInGBint32required

    RootDiskInGB is the size of a vm's root disk, in GB

    sizeint32

    size of the pool, number of machines

    taints

    object[]

    master or worker taints

  • Array [

  • effectstring

    Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

    keystring

    The taint key to be applied to a node

    timeAddeddate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    valuestring

    The taint value corresponding to the taint key.

  • ]

  • updateStrategy

    object

    rolling update strategy for this machinepool if not specified, will use ScaleOut

    typestring

    Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]

    update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut

    useControlPlaneAsWorkerboolean

    if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools

    xslTemplatestring

    XSLTemplate defines a base64-encoded raw xsl template which will be included in the machine definition

  • ]

  • status

    object

    conditions

    object[]

  • Array [

  • lastProbeTimedate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    lastTransitionTimedate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    messagestring

    Human-readable message indicating details about last transition.

    reasonstring

    Unique, one-word, CamelCase reason for the condition's last transition.

    statusstringrequired
    typestringrequired
  • ]

  • nodeImages

    object[]

    NodeImages are the list of images generated on all the LibvirtHosts

  • Array [

  • hostIDstring

    HostID is the ID of the LibvirtHost

    imageNamestring

    ImageName is the name of the Libvirt image

    storagePoolstring

    StoragePool is the name of the storagePool where is image is located

  • ]

  • sourceImageIdstring

    SourceImageId can be from packref's annotations or from pack.json

Loading...