Returns the specified vSphere cloud config
GET/v1/cloudconfigs/vsphere/:configUid
Returns the specified vSphere cloud config
Request​
Path Parameters
Cluster's cloud config uid
Header Parameters
Scope the request to the specified project uid
Responses​
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
Array [
Array [
]
]
Array [
]
]
Array [
]
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
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.
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
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
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 of the resource.
UID is the unique identifier generated for the resource. This is not an input field for any request.
spec
object
VsphereCloudConfigSpec defines the desired state of VsphereCloudConfig
cloudAccountRef
object
ObjectReference contains enough information to let you inspect or modify the referred object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
clusterConfig
object
required
controlPlaneEndpoint
object
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
IP or FQDN(External/DDNS)
Possible values: [VIP, External, DDNS]
VIP or External
NTPServers is a list of NTP servers to use instead of the machine image's default NTP server list.
placement
object
required
Both ClusterConfig and MachinePoolConfig will have PlacementConfig MachinePoolconfig.Placements will overwrite values defined in ClusterConfig Currently the convention is: Datacenter / Folder / ImageTemplateFolder / Network should be defined at ClusterConfig Cluster / ResourcePool / Datastore / Network is defined at MachinePool ClusterConfig Network should only indicate use DHCP or not MachinePool Network should contain the actual network and IPPool
Cluster is the computecluster in vsphere
Datacenter is the name or inventory path of the datacenter where this machine's VM is created/located.
Datastore is the datastore in which VMs are created/located.
Folder is the folder in which VMs are created/located.
ImageTemplateFolder is the folder in which VMs templates are created/located. if empty will use default value spectro-templates
network
object
ipPool
object
IPPool defines static IPs available. Gateway, Prefix, Nameserver, if defined, will be default values for all Pools
Gateway is the gateway ip address
nameserver
object
Nameserver define search domains and nameserver addresses
pools
object[]
Pools contains the list of IP addresses pools
End is the last IP address that can be rendered. It is used as a validation that the rendered IP is in bound.
Gateway is the gateway ip address
nameserver
object
Nameserver define search domains and nameserver addresses
Prefix is the mask of the network as integer (max 128)
Start is the first ip address that can be rendered
Subnet is used to validate that the rendered IP is in bounds. eg: 192.168.0.0/24 If Start value is not given, start value is derived from the subnet ip incremented by 1 (start value is 192.168.0.1 for subnet 192.168.0.0/24)
Prefix is the mask of the network as integer (max 128)
UID is the UID of this IPPool, used by Hubble
NetworkName is the name of the network in which VMs are created/located.
parentPoolRef
object
ObjectReference contains enough information to let you inspect or modify the referred object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
support dhcp or static IP, if false, use DHCP
ResourcePool is the resource pool within the above computecluster Cluster
StoragePolicyName of the storage policy to use with this Virtual Machine
UID for this placement
SSHKeys specifies a list of ssh authorized keys for the 'spectro' user
whether this cluster should use dhcp or static IP, if false, use DHCP if this is set, then all machinepools should have staticIP with provided IPPool adding this as an additional standalone flag without relating to placement.Nework main reason is to enable more validation for placement.Network.StaticIP which should come together with valid Network.IPPool and Network.Name
edgeHostRef
object
ObjectReference contains enough information to let you inspect or modify the referred object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
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
instanceType
object
required
DiskGiB is the size of a virtual machine's disk, in GiB. Defaults to the analogue property value in the template from which this machine is cloned.
MemoryMiB is the size of a virtual machine's memory, in MiB. Defaults to the analogue property value in the template from which this machine is cloned.
NumCPUs is the number of virtual processors in a virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.
whether this pool is for control plane
labels for this pool, example: master/worker, gpu, windows
machinePoolProperties
object
Machine pool specific properties
Possible values: [amd64, arm64]
Default value: amd64
max size of the pool, for scaling
min size of the pool, for scaling
Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster
placements
object[]
Placements configuration Placements If defined, will replace default values defined in VsphereClusterConfig Array means one MachinePool can span across multiple vsphere compute cluster
Cluster is the computecluster in vsphere
Datacenter is the name or inventory path of the datacenter where this machine's VM is created/located.
Datastore is the datastore in which VMs are created/located.
Folder is the folder in which VMs are created/located.
ImageTemplateFolder is the folder in which VMs templates are created/located. if empty will use default value spectro-templates
network
object
ipPool
object
IPPool defines static IPs available. Gateway, Prefix, Nameserver, if defined, will be default values for all Pools
Gateway is the gateway ip address
nameserver
object
Nameserver define search domains and nameserver addresses
pools
object[]
Pools contains the list of IP addresses pools
End is the last IP address that can be rendered. It is used as a validation that the rendered IP is in bound.
Gateway is the gateway ip address
nameserver
object
Nameserver define search domains and nameserver addresses
Prefix is the mask of the network as integer (max 128)
Start is the first ip address that can be rendered
Subnet is used to validate that the rendered IP is in bounds. eg: 192.168.0.0/24 If Start value is not given, start value is derived from the subnet ip incremented by 1 (start value is 192.168.0.1 for subnet 192.168.0.0/24)
Prefix is the mask of the network as integer (max 128)
UID is the UID of this IPPool, used by Hubble
NetworkName is the name of the network in which VMs are created/located.
parentPoolRef
object
ObjectReference contains enough information to let you inspect or modify the referred object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
support dhcp or static IP, if false, use DHCP
ResourcePool is the resource pool within the above computecluster Cluster
StoragePolicyName of the storage policy to use with this Virtual Machine
UID for this placement
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
UpdatesStrategy will be used to translate to RollingUpdateStrategy of a MachineDeployment We'll start with default values for the translation, can expose more details later Following is details of parameters translated from the type ScaleOut => maxSurge=1, maxUnavailable=0 ScaleIn => maxSurge=0, maxUnavailable=1
Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]
update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut
if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools
status
object
VsphereCloudConfigStatus defines the observed state of VsphereCloudConfig
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.
addon layers present in spc
nodeImage
object
A generated Image should always be a template which resides inside vsphere Will not generate a OVA file out of the image OVA can be used as a base input of the os pack, that's internal to the pack
full path of the image template location it contains datacenter/folder/templatename etc eg: /mydc/vm/template/spectro/workerpool-1-centos
roleDigest
object
this map will be for ansible roles present in eack pack
sourceImageId, it can be from packref's annotations or from pack.json
UploadOVAS3 will hold last image name which uploaded to S3
If no ansible roles found in Packs then Mold should tell Drive to use capi image and not create custom image, because there is nothing to add
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"creationTimestamp": "2024-04-16T17:49:00.479Z",
"deletionTimestamp": "2024-04-16T17:49:00.479Z",
"labels": {},
"lastModifiedTimestamp": "2024-04-16T17:49:00.479Z",
"name": "string",
"uid": "string"
},
"spec": {
"cloudAccountRef": {
"kind": "string",
"name": "string",
"uid": "string"
},
"clusterConfig": {
"controlPlaneEndpoint": {
"ddnsSearchDomain": "string",
"host": "string",
"type": "VIP"
},
"ntpServers": [
"string"
],
"placement": {
"cluster": "string",
"datacenter": "string",
"datastore": "string",
"folder": "string",
"imageTemplateFolder": "string",
"network": {
"ipPool": {
"gateway": "string",
"nameserver": {
"addresses": [
"string"
],
"search": [
"string"
]
},
"pools": [
{
"end": "string",
"gateway": "string",
"nameserver": {
"addresses": [
"string"
],
"search": [
"string"
]
},
"prefix": 0,
"start": "string",
"subnet": "string"
}
],
"prefix": 0,
"uid": "string"
},
"networkName": "string",
"parentPoolRef": {
"kind": "string",
"name": "string",
"uid": "string"
},
"staticIp": true
},
"resourcePool": "string",
"storagePolicyName": "string",
"uid": "string"
},
"sshKeys": [
"string"
],
"staticIp": true
},
"edgeHostRef": {
"kind": "string",
"name": "string",
"uid": "string"
},
"machinePoolConfig": [
{
"additionalLabels": {},
"additionalTags": {},
"instanceType": {
"diskGiB": 0,
"memoryMiB": 0,
"numCPUs": 0
},
"isControlPlane": true,
"labels": [
"string"
],
"machinePoolProperties": {
"archType": "amd64"
},
"maxSize": 0,
"minSize": 0,
"name": "string",
"nodeRepaveInterval": 0,
"placements": [
{
"cluster": "string",
"datacenter": "string",
"datastore": "string",
"folder": "string",
"imageTemplateFolder": "string",
"network": {
"ipPool": {
"gateway": "string",
"nameserver": {
"addresses": [
"string"
],
"search": [
"string"
]
},
"pools": [
{
"end": "string",
"gateway": "string",
"nameserver": {
"addresses": [
"string"
],
"search": [
"string"
]
},
"prefix": 0,
"start": "string",
"subnet": "string"
}
],
"prefix": 0,
"uid": "string"
},
"networkName": "string",
"parentPoolRef": {
"kind": "string",
"name": "string",
"uid": "string"
},
"staticIp": true
},
"resourcePool": "string",
"storagePolicyName": "string",
"uid": "string"
}
],
"size": 0,
"taints": [
{
"effect": "NoSchedule",
"key": "string",
"timeAdded": "2024-04-16T17:49:00.480Z",
"value": "string"
}
],
"updateStrategy": {
"type": "RollingUpdateScaleOut"
},
"useControlPlaneAsWorker": true
}
]
},
"status": {
"ansibleDigest": "string",
"conditions": [
{
"lastProbeTime": "2024-04-16T17:49:00.480Z",
"lastTransitionTime": "2024-04-16T17:49:00.480Z",
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"isAddonLayer": true,
"lastOVACreated": "string",
"lastVMExported": "string",
"nodeImage": {
"fullPath": "string",
"state": "string"
},
"roleDigest": {},
"sourceImageId": "string",
"uploadOvaS3": "string",
"useCapiImage": true
}
}