update the vSphere cloud config for the private gateway

PUT 
/v1/overlords/vsphere/:uid/cloudconfig

update the vSphere cloud config for the private gateway

Request

Path Parameters

uid stringrequired

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

clusterConfig object

controlPlaneEndpoint object

The optional 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

IP or FQDN(External/DDNS)

typestring

Possible values: [VIP, External, DDNS]

VIP or External

ntpServersstring[]

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

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

Array [

clusterstring

Cluster is the computecluster in vsphere

datacenterstring

Datacenter is the name or inventory path of the datacenter where this machine's VM is created/located.

datastorestring

Datastore is the datastore in which VMs are created/located.

folderstring

Folder is the folder in which VMs are created/located.

imageTemplateFolderstring

ImageTemplateFolder is the folder in which VMs templates are created/located. if empty will use default value spectro-templates

network object

network info

networkNamestringrequired

NetworkName is the name of the network in which VMs are created/located.

parentPoolUidstring

ParentPoolRef Uid to the ParentPool which allocates IPs for this IPPool

staticIpboolean

support dhcp or static IP, if false, use DHCP

resourcePoolstring

ResourcePool is the resource pool within the above computecluster Cluster

storagePolicyNamestring

StoragePolicyName of the storage policy to use with this Virtual Machine

uidstring

UID for this placement

]

sshKeysstring[]

SSHKeys specifies a list of ssh authorized keys for the 'spectro' user

staticIpboolean

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

clusterProfiles object[]
Cluster profiles pack configuration for private gateway cluster
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
]
clusterSettings object
clusterSettings is the generic configuration related to a cluster like OS patch, Rbac, Namespace allocation
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
lifecycleConfig
pauseboolean
Default value: false
enable pause life cycle config
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
machineManagementConfig object
osPatchConfig object
Os patch config contains properties to patch node os with latest security packages. If OsPatchConfig is not provided then node os will not be patched with latest security updates.
onDemandPatchAfterdate-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.
patchOnBootboolean
PatchOnBoot indicates need to do patch when node first boot up, only once
rebootIfRequiredboolean
Reboot once the OS patch is applied
schedulestring
The schedule at which security patches will be applied to OS. Schedule should be in Cron format, see https://en.wikipedia.org/wiki/Cron for more help.
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
sizeint32

size of the pool, number of machines

Responses

204

The resource was updated successfully

Loading...