Validates libvirt cluster create operation

POST 
/v1/spectroclusters/libvirt/validate

Validates libvirt cluster create operation

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

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.

Populated by the system. Read-only.

spec object
cloudConfig object
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
clusterConfig object
General cluster configuration like health, patching settings, namespace resource allocation, rbac
clusterMetaAttributestring
ClusterMetaAttribute can be used to set additional cluster metadata information.
controlPlaneHealthCheckTimeoutstring
hostClusterConfig
clusterEndpoint
host cluster configuration
config
ingressConfig
Ingress configuration for exposing the virtual cluster's kube-apiserver
hoststring
portint64
loadBalancerConfig
Load balancer configuration for exposing the virtual cluster's kube-apiserver
externalIPsstring[]
externalTrafficPolicystring
loadBalancerSourceRangesstring[]
typestring
Possible values: [Ingress, LoadBalancer]
is enabled as host cluster
clusterGroup object
ObjectReference contains enough information to let you inspect or modify the referred object.
kindstring
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
namestring
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
uidstring
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
hostCluster object
ObjectReference contains enough information to let you inspect or modify the referred object.
kindstring
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
namestring
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
uidstring
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
isHostClusterboolean
Default value: false
is enabled as host cluster
location object
Cluster location information
countryCodestring
country code for cluster location
countryNamestring
country name for cluster location
geoLoc object
Geolocation Latlong entity
latitudefloat64
Latitude of a resource
longitudefloat64
Longitude of a resource
regionCodestring
region code for cluster location
regionNamestring
region name for cluster location
resources object
namespaces object[]
Array [
metadata object
ObjectMeta update entity with uid as input
annotations object
property name*string
labels object
property name*string
namestring
Name of the resource
uidstring
Populated by the system. Read-only.
spec
Cluster namespace spec
isRegexboolean
relatedObject object
Object for which the resource is related
kindstring
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
namestring
uidstring
resourceAllocation
Cluster namespace resource allocation
cpuCoresnumber
memoryMiBnumber
]
rbacs object[]
Array [
metadata object
ObjectMeta update entity with uid as input
annotations object
property name*string
labels object
property name*string
namestring
Name of the resource
uidstring
Populated by the system. Read-only.
spec object
Cluster RBAC spec
bindings object[]
Array [
namespacestring
role object
Cluster role ref
kindstring
Possible values: [Role, ClusterRole]
namestring
subjects object[]
Array [
namestring
namespacestring
typestring
Possible values: [User, Group, ServiceAccount]
]
typestring
Possible values: [RoleBinding, ClusterRoleBinding]
]
relatedObject object
Object for which the resource is related
kindstring
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
namestring
uidstring
]
updateWorkerPoolsInParallelboolean
machinepoolconfig object[]
Array [
cloudConfig
instanceType objectrequired
LibvirtInstanceType defines the instance configuration for a virtual machine
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
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 configuration Placements If defined, will replace default values defined in VsphereClusterConfig Array means one MachinePool can span across multiple vsphere compute cluster
Array [
dataStoragePoolstring
gpuDevices object[]
GPUDevices defines an array of gpu device for a specific edge host. This will be overridden by edge host GPU devices if configured during registration.
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
]
hostUidstringrequired
networks object[]
Array [
networkNamestringrequired
NetworkName of the libvirt network where this machine will be connected
networkTypestringrequired
Possible values: [default, bridge]
NetworkType specifies the type of network
]
sourceStoragePoolstring
targetStoragePoolstring
]
rootDiskInGBint32required
RootDiskInGB is the size of a vm's root disk, in GiB
xslTemplatestring
XSLTemplate defines a base64-encoded raw xsl template which will be included in the machine definition
poolConfig object
Machine pool configuration for the cluster
additionalLabels object
Additional labels to be part of the machine pool
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
isControlPlaneboolean
Whether this pool is for control plane
labelsstring[]required
Labels for this machine 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
namestringrequired
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
sizeint32required
Size of the pool, number of nodes/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 machine pool 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
]
policies object
Cluster policies
backupPolicy
Cluster backup config
backupLocationNamestring
backupLocationUidstring
backupNamestring
backupPrefixstring
durationInHoursint64
includeAllDisksboolean
includeClusterResourcesboolean
locationTypestring
namespacesstring[]
schedule
Cluster feature schedule
scheduledRunTimestring
scanPolicy
Cluster compliance scan schedule configuration
kubeBench
Cluster compliance scan schedule config for kube bench driver
schedule
Cluster feature schedule
scheduledRunTimestring
kubeHunter
Cluster compliance scan schedule config for kube hunter driver
schedule
Cluster feature schedule
scheduledRunTimestring
sonobuoy
Cluster compliance scan schedule config for sonobuoy driver
schedule
Cluster feature schedule
scheduledRunTimestring
profiles object[]
Array [
packValues object[]
Cluster profile packs array
Array [
manifests undefined[]
Pack manifests are additional content as part of the profile
Array [
contentstring
Manifest content in yaml
namestringrequired
Manifest name
uidstring
Manifest uid
]
namestringrequired
Pack name
tagstring
Pack version tag
typestring
Possible values: [spectro, helm, manifest, oci]
Default value: spectro
valuesstring
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
]
replaceWithProfilestring
Cluster profile uid to be replaced with new profile
uidstring
Cluster profile uid
]

Responses

200

Libvirt Cluster validation response

application/json

Schema

Schema

machinePools object
Constraint validator response
results object[]
Array [
displayNamestring
errors object[]
Array [
codestring
messagestring
]
namestring
]
profiles object[]
Array [
packs object
Constraint validator response
results object[]
Array [
displayNamestring
errors object[]
Array [
codestring
messagestring
]
namestring
]
uidstring
Cluster profile uid
]

Example (from schema)

{
  "machinePools": {
    "results": [
      {
        "displayName": "string",
        "errors": [
          {
            "code": "string",
            "message": "string"
          }
        ],
        "name": "string"
      }
    ]
  },
  "profiles": [
    {
      "packs": {
        "results": [
          {
            "displayName": "string",
            "errors": [
              {
                "code": "string",
                "message": "string"
              }
            ],
            "name": "string"
          }
        ]
      },
      "uid": "string"
    }
  ]
}

Loading...