Returns the specified libvirt cloud config
GET/v1/cloudconfigs/libvirt/:configUid
Returns the specified libvirt cloud config
Request​
Path Parameters
Cluster's cloud config uid
Responses​
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
Array [
]
Array [
]
Array [
]
]
Array [
]
Array [
Array [
]
Array [
]
]
Array [
]
]
Array [
]
Array [
]
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
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/sig-architecture/api-conventions.md#types-kinds
metadata
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations
object
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
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.
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
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
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.
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
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
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
SelfLink is a URL representing this object. Populated by the system. Read-only.
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
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
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
Host is FQDN(DDNS) or IP
Type indicates DDNS or VIP
NTPServers is a list of NTP servers to use instead of the machine image's default NTP server list
SSHKeys specifies a list of ssh authorized keys to access the vms as a 'spectro' user
StaticIP indicates if IP allocation type is static IP. DHCP is the default allocation type
machinePoolConfig
object[]
required
additionalLabels
object
additionalLabels
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
infraProfileRef
object
ObjectReference contains enough information to let you inspect or modify the referred object.
API version of the referent.
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
infraProfileTemplate
object
ClusterProfileTemplate contains details of a clusterprofile definition
Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]
Default value: all
packServerRefs
object[]
PackServerRefs is only used on Hubble side it is reference to pack registry servers which PackRef belongs to in hubble, pack server is a top level object, so use a reference to point to it packs within a clusterprofile can come from different pack servers, so this is an array
API version of the referent.
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
This secret is used only on Palette side use case is similar to k8s image pull secret this single secret internally should contains all the pack servers in PackServerRefs if empty, means no credential is needed to access the pack server For spectro saas, Ally will set this field before pass to palette
packs
object[]
Packs definitions here are final definitions. If ClonedFrom and ParamsOverwrite is present, then Packs are the final merge result of ClonedFrom and ParamsOverwrite So orchestration engine will just take the Packs and do the work, no need to worry about parameters merge
annotations
object
Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml
digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade
pack is invalid when the associated tag is deleted from the registry
Possible values: [kernel, os, k8s, cni, csi, addon]
manifests
object[]
API version of the referent.
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
pack name
PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.
params
object
params passed as env variables to be consumed at installation time
presets
object[]
pack registry uid
schema
object[]
pack registry server or helm repo
pack tag
Possible values: [spectro, helm, manifest]
type of the pack
values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values
pack version
version start from 1.0.0, matching the index of ClusterProfileSpec.Versions[] will be used by clusterSpec to identify which version is applied to the cluster
Deprecated. Use profileVersion
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.
Enables the CPU Passthrough for the libvirt domain
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
DeviceModel is the model of GPU, for a given vendor, for eg., TU104GL [Tesla T4]
NumGPUs is the number of GPUs
VendorName is the GPU vendor, for eg., NVIDIA or AMD
MemoryinMB is the memory in megabytes
NumCPUs is the number of CPUs
whether this pool is for control plane
labels for this pool, example: master/worker, gpu, windows
max size of the pool, for scaling
min size of the pool, for scaling
nonRootDisksInGB
object[]
NonRootDisksInGB is the list of additional disks, if required, in GB
DataStoragePool is the storage pool from which additional disks are assigned
Managed indicates if the disk is a persistent or not. By default its false indicating all disks are ephemeral.
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
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
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
Model is the model of GPU, for a given vendor, for eg., TU104GL [Tesla T4]
Vendor is the GPU vendor, for eg., NVIDIA or AMD
HostAddress is a FQDN or IP address of the LibvirtHost
hostIdentity
object
HostIdentity is the identity to access the LibvirtHost
CACert is the client CA certificate
Mode indicates a system or session connection to the host
SocketPath is an optional path to the socket on the host, if not using defaults
sshSecret
object
SSHSecrets to the secret containing ssh-username
SSH secret name
Private Key to access the host
HostUid is the ID of the LibvirtHost
networks
object[]
required
Networks defines the network specifications of the vms in the machine pool
NetworkName of the libvirt network where this machine will be connected
Possible values: [default, bridge]
NetworkType specifies the type of network
SourceStoragePool is the storage pool for the vm image
TargetStoragePool is the optional storage pool from which additional disks are assigned. If not specified, the sourceStoragePool is also used as the targetStoragePool
RootDiskInGB is the size of a vm's root disk, in GB
size of the pool, number of machines
taints
object[]
master or worker taints
Possible values: [NoSchedule, PreferNoSchedule, NoExecute]
The taint key to be applied to a node
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.
The taint value corresponding to the taint key.
updateStrategy
object
rolling update strategy for this machinepool if not specified, will use ScaleOut
Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]
update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut
if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools
status
object
conditions
object[]
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.
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.
Human-readable message indicating details about last transition.
Unique, one-word, CamelCase reason for the condition's last transition.
nodeImages
object[]
NodeImages are the list of images generated on all the LibvirtHosts
HostID is the ID of the LibvirtHost
ImageName is the name of the Libvirt image
StoragePool is the name of the storagePool where is image is located
SourceImageId can be from packref's annotations or from pack.json
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"creationTimestamp": "2024-07-05T19:31:05.184Z",
"deletionTimestamp": "2024-07-05T19:31:05.184Z",
"labels": {},
"lastModifiedTimestamp": "2024-07-05T19:31:05.184Z",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"clusterConfig": {
"controlPlaneEndpoint": {
"ddnsSearchDomain": "string",
"host": "string",
"type": "string"
},
"ntpServers": [
"string"
],
"sshKeys": [
"string"
],
"staticIp": true
},
"machinePoolConfig": [
{
"additionalLabels": {},
"additionalTags": {},
"infraProfileRef": {
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
},
"infraProfileTemplate": {
"cloudType": "all",
"name": "string",
"packServerRefs": [
{
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
}
],
"packServerSecret": "string",
"packs": [
{
"annotations": {},
"digest": "string",
"inValidReason": "string",
"isInvalid": true,
"layer": "kernel",
"manifests": [
{
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
}
],
"name": "string",
"packUid": "string",
"params": {},
"presets": [
{
"add": "string",
"displayName": "string",
"group": "string",
"name": "string",
"remove": [
"string"
]
}
],
"registryUid": "string",
"schema": [
{
"format": "string",
"hints": [
"string"
],
"listOptions": [
"string"
],
"name": "string",
"readonly": true,
"regex": "string",
"required": true,
"type": "string"
}
],
"server": "string",
"tag": "string",
"type": "spectro",
"values": "string",
"version": "string"
}
],
"profileVersion": "string",
"type": "string",
"uid": "string",
"version": 0
},
"instanceType": {
"cpuPassthroughSpec": {
"cachePassthrough": true,
"isEnabled": true
},
"cpuset": "string",
"gpuConfig": {
"addresses": {},
"deviceModel": "string",
"numGPUs": 0,
"vendorName": "string"
},
"memoryInMB": 0,
"numCPUs": 0
},
"isControlPlane": true,
"labels": [
"string"
],
"maxSize": 0,
"minSize": 0,
"name": "string",
"nonRootDisksInGB": [
{
"dataStoragePool": "string",
"managed": true,
"sizeInGB": 0
}
],
"placements": [
{
"dataStoragePool": "string",
"gpuDevices": [
{
"addresses": {},
"model": "string",
"vendor": "string"
}
],
"hostAddress": "string",
"hostIdentity": {
"caCert": "string",
"mode": "string",
"socketPath": "string",
"sshSecret": {
"name": "string",
"privateKey": "string"
}
},
"hostUid": "string",
"networks": [
{
"networkName": "string",
"networkType": "default"
}
],
"sourceStoragePool": "string",
"targetStoragePool": "string"
}
],
"rootDiskInGB": 0,
"size": 0,
"taints": [
{
"effect": "NoSchedule",
"key": "string",
"timeAdded": "2024-07-05T19:31:05.185Z",
"value": "string"
}
],
"updateStrategy": {
"type": "RollingUpdateScaleOut"
},
"useControlPlaneAsWorker": true
}
]
},
"status": {
"conditions": [
{
"lastProbeTime": "2024-07-05T19:31:05.185Z",
"lastTransitionTime": "2024-07-05T19:31:05.185Z",
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"nodeImages": [
{
"hostID": "string",
"imageName": "string",
"storagePool": "string"
}
],
"sourceImageId": "string"
}
}