cluster

cluster
cluster
JSON Example
{
    "id": "string",
    "clusterName": "string",
    "isImported": false,
    "ipFamilies": "string",
    "clusterType": "string",
    "vsphereClusterName": "string",
    "managementClusterId": "string",
    "hcxUUID": "string",
    "resourceProviderHcxUUID": "string",
    "status": "string",
    "activeTasksCount": 0,
    "clusterTemplate": {
        "name": "string",
        "version": "string",
        "id": "string"
    },
    "variables": [
        {
            "name": "string"
        }
    ],
    "clusterConfig": {
        "cniEditable": false,
        "csiEditable": false,
        "cni": [
            {
                "name": "string"
            }
        ],
        "networking": [
            {
                "name": "string",
                "properties": {
                    "aviController": {
                        "aviUsername": "string",
                        "aviPassword": "string",
                        "aviCaDataB64": "string"
                    },
                    "loadBalancerAndIngressService": {
                        "cloudName": "string",
                        "defaultServiceEngineGroup": "string",
                        "defaultVipNetwork": "string",
                        "defaultVipNetworkCidr": "string"
                    }
                }
            }
        ],
        "csi": [
            {
                "name": "string",
                "properties": {
                    "name": "string",
                    "isDefault": false,
                    "serverIP": "string",
                    "mountPath": "string",
                    "datastoreUrl": "string",
                    "timeout": "string",
                    "region": "string",
                    "zone": "string"
                }
            }
        ],
        "kubernetesVersion": "string",
        "tools": [
            {}
        ],
        "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"
    },
    "clusterId": "string",
    "clusterUrl": "string",
    "kubeConfig": "string",
    "endpointIP": "string",
    "masterNodes": [
        {
            "cpu": 0,
            "memory": 0,
            "name": "string",
            "networks": [
                {
                    "label": "string",
                    "networkName": "string",
                    "mtu": 0,
                    "isManagement": false,
                    "nameservers": [
                        "string"
                    ]
                }
            ],
            "nodes": [
                {
                    "ip": "string",
                    "vmName": "string"
                }
            ],
            "storage": 0,
            "replica": 0,
            "labels": [
                "string"
            ],
            "cloneMode": "string"
        }
    ],
    "workerNodes": [
        {
            "cpu": 0,
            "memory": 0,
            "name": "string",
            "networks": [
                {
                    "label": "string",
                    "networkName": "string",
                    "mtu": 0,
                    "isManagement": false,
                    "nameservers": [
                        "string"
                    ]
                }
            ],
            "nodes": [
                {
                    "ip": "string",
                    "vmName": "string"
                }
            ],
            "storage": 0,
            "replica": 0,
            "labels": [
                "string"
            ],
            "cloneMode": "string",
            "config": {
                "cpuManagerPolicy": {
                    "type": "string",
                    "policy": "string",
                    "properties": {
                        "kubeReserved": {
                            "cpu": 0,
                            "memoryInGiB": 0
                        },
                        "systemReserved": {
                            "cpu": 0,
                            "memoryInGiB": 0
                        }
                    }
                },
                "healthCheck": {
                    "nodeStartupTimeout": "string",
                    "unhealthyConditions": [
                        {
                            "type": "string",
                            "status": "string",
                            "timeout": "string"
                        }
                    ]
                }
            }
        }
    ],
    "vimId": "string",
    "error": "string",
    "hasSupportedKubernetesVersion": false,
    "supportedOperatorsVersion": "string",
    "clusterPassword": "string",
    "creationTenantId": "string",
    "creationUser": "string",
    "lastUpdated": "string",
    "creationDate": "string",
    "placementParams": [
        {
            "name": "string",
            "type": "string"
        }
    ],
    "warnings": [
        {
            "operationType": "string",
            "message": "string",
            "errorCode": "string",
            "internalMessage": "string"
        }
    ],
    "errors": [
        {
            "operationType": "string",
            "message": "string",
            "errorCode": "string",
            "internalMessage": "string"
        }
    ]
}
string
id
Optional

id

string
clusterName
Optional

clusterName

boolean
isImported
Optional

Flag to indicate if this cluster is imported. Clusters created outside TCA and imported to TCA will have this flag set to True.

string
ipFamilies
Optional

ipFamilies

Possible values are : IPv4, IPv6,
string
clusterType
Optional

Type of cluster. Can be Workload/Management.

string
vsphereClusterName
Optional

Name of the vsphere cluster on which the k8s cluster is deployed.

string
managementClusterId
Optional

Id of the management cluster, only relevant for workload clusters.

string
hcxUUID
Optional

Endpoint id of the tca cp which is managing the cluster.

string
resourceProviderHcxUUID
Optional

Endpoint id of the tca cp on which the cluster resources are deployed.

string
status
Optional

Current status of the cluster.

integer
activeTasksCount
Optional

Number of operations in processing or queued state on the cluster

object
clusterTemplate
Optional

Cluster template using which the cluster is deployed.

array of object
variables
Optional

Variables can be used to customize the Cluster.

clusterConfig
Optional

clusterConfig

object
airgapConfig
Optional

airgapConfig

proxyConfig
Optional

proxyConfig

string
clusterId
Optional

clusterId

string
clusterUrl
Optional

clusterUrl

string
kubeConfig
Optional

kubeConfig

string
endpointIP
Optional

API server load balancer IP. This address is used by Kube-vip pod that runs in the control plane nodes and provides load balancing services for the cluster API server. Make sure that this Ip Address is not in the DHCP range,but its in the same subnet as the DHCP range of master node's management network.

array of object
masterNodes
Optional

Pool of nodes on which Kubernetes control plane can run.

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 Instance, if it has Infrastructure requirements.

string
vimId
Optional

vimId

string
error
Optional

Any error associated with the cluster. For eg. "Kubernetes version not supported".

boolean
hasSupportedKubernetesVersion
Optional

Flag to indicate if the cluster is on one of the supported kubernetes versions.

string
supportedOperatorsVersion
Optional

The supported version for the operators like vmconfig operator and nodeconfig operator.

string
clusterPassword
Optional

This password is used to login to the master nodes and worker nodes. The username is "capv".

object
_links
Optional

_links

string
creationTenantId
Optional

creationTenantId

string
creationUser
Optional

creationUser

string
lastUpdated
Optional

lastUpdated

string
creationDate
Optional

creationDate

array of object
placementParams
Optional

placementParams

array of object
warnings
Optional

warnings

array of object
errors
Optional

Errors are for internal use and subject to change. Please use task for monitoring progress of operation.