clusterSpec
clusterSpec
JSON Example
{
"clusterTemplateId": "string",
"clusterType": "string",
"ipFamilies": "string",
"description": "string",
"variables": [
{
"name": "string"
}
],
"clusterConfig": {
"csi": [
{
"name": "string",
"properties": {
"serverIP": "string",
"mountPath": "string",
"datastoreUrl": "string",
"region": "string",
"zone": "string"
}
}
],
"tools": [
{
"name": "string",
"properties": {
"extensionId": "string",
"type": "string",
"url": "string",
"username": "string"
}
}
],
"networking": [
{
"name": "string",
"properties": {
"aviController": {
"aviUsername": "string",
"aviCaDataB64": "string"
},
"loadBalancerAndIngressService": {
"cloudName": "string",
"defaultServiceEngineGroup": "string",
"defaultVipNetwork": "string",
"defaultVipNetworkCidr": "string"
}
}
}
],
"systemSettings": [
{
"name": "string",
"properties": {
"host": "string",
"port": 0,
"protocol": "string"
}
}
]
},
"airgapConfig": {
"type": "string",
"extensionId": "string",
"fqdn": "string",
"ip": "string",
"caCert": "string"
},
"proxyConfig": {
"type": "string",
"extensionId": "string",
"httpProxy": "string",
"httpsProxy": "string",
"noProxy": "string",
"caCert": "string"
},
"hcxCloudUrl": "string",
"vimOwnerHcxCloudUrl": "string",
"vimId": "string",
"vimOwnerVimId": "string",
"hcxUUID": "string",
"resourceProviderHcxUUID": "string",
"managementClusterId": "string",
"masterNodes": [
{
"name": "string",
"networks": [
{
"label": "string",
"networkName": "string",
"mtu": 0,
"nameservers": [
"string"
]
}
],
"placementParams": [
{
"name": "string",
"type": "string"
}
]
}
],
"placementParams": [
{
"name": "string",
"type": "string"
}
],
"vmTemplate": "string",
"workerNodes": [
{
"name": "string",
"networks": [
{
"label": "string",
"networkName": "string",
"mtu": 0,
"nameservers": [
"string"
]
}
],
"placementParams": [
{
"name": "string",
"type": "string"
}
]
}
]
}string
clusterTemplateId
Required
clusterTemplateId
string
clusterType
Required
clusterType
Possible values are : MANAGEMENT, WORKLOAD,
string
ipFamilies
Optional
ipFamilies
Possible values are : IPv4, IPv6,
string
description
Optional
description
array of object
variables
Optional
Variables can be used to customize the Cluster.
object
clusterConfig
Optional
clusterConfig
object
airgapConfig
Optional
airgapConfig
string
hcxCloudUrl
Required
hcxCloudUrl
string
vimOwnerHcxCloudUrl
Optional
vimOwnerHcxCloudUrl
string
vimId
Optional
vimId
string
vimOwnerVimId
Optional
vimOwnerVimId
string
hcxUUID
Optional
hcxUUID
string
resourceProviderHcxUUID
Optional
resourceProviderHcxUUID
string
managementClusterId
Optional
managementClusterId
array of object
masterNodes
Required
Pool of nodes on which Kubernetes control plane can run.
array of object
placementParams
Required
placementParams
string
vmTemplate
Required
OS Image With Kubernetes
array of object
workerNodes
Optional
Pool of worker nodes on which Network Functions can run. Each Node Pool can be deployed on a vSphere Resource Pool. All the worker nodes in a node pool contain same Kubelet and Operating System Configuration. It is recommended that a Node Pool should be used by only one Network Function, if it has Infrastructure requirements.