clusterSpec

clusterSpec
clusterSpec
JSON Example
{
    "placementParams": [
        {
            "name": "name",
            "type": "type"
        },
        {
            "name": "name",
            "type": "type"
        }
    ],
    "clusterType": "MANAGEMENT",
    "proxyConfig": {
        "http_proxy": "http_proxy",
        "no_proxy": "no_proxy",
        "https_proxy": "https_proxy",
        "caCert": "caCert",
        "type": "extension",
        "extensionId": "extensionId"
    },
    "hcxUUID": "hcxUUID",
    "vmTemplate": "vmTemplate",
    "airgapConfig": {
        "caCert": "caCert",
        "fqdn": "fqdn",
        "ip": "ip",
        "type": "extension",
        "extensionId": "extensionId"
    },
    "vimId": "vimId",
    "workerNodes": [
        {
            "placementParams": [
                {
                    "name": "name",
                    "type": "type"
                },
                {
                    "name": "name",
                    "type": "type"
                }
            ],
            "name": "name",
            "networks": [
                {
                    "nameservers": [
                        "nameservers",
                        "nameservers"
                    ],
                    "networkName": "networkName",
                    "label": "label",
                    "mtu": 6
                },
                {
                    "nameservers": [
                        "nameservers",
                        "nameservers"
                    ],
                    "networkName": "networkName",
                    "label": "label",
                    "mtu": 6
                }
            ]
        },
        {
            "placementParams": [
                {
                    "name": "name",
                    "type": "type"
                },
                {
                    "name": "name",
                    "type": "type"
                }
            ],
            "name": "name",
            "networks": [
                {
                    "nameservers": [
                        "nameservers",
                        "nameservers"
                    ],
                    "networkName": "networkName",
                    "label": "label",
                    "mtu": 6
                },
                {
                    "nameservers": [
                        "nameservers",
                        "nameservers"
                    ],
                    "networkName": "networkName",
                    "label": "label",
                    "mtu": 6
                }
            ]
        }
    ],
    "description": "description",
    "hcxCloudUrl": "hcxCloudUrl",
    "managementClusterId": "managementClusterId",
    "clusterTemplateId": "clusterTemplateId",
    "clusterConfig": {
        "systemSettings": [
            {
                "name": "syslog",
                "properties": {
                    "protocol": "udp",
                    "port": 0,
                    "host": "host"
                }
            },
            {
                "name": "syslog",
                "properties": {
                    "protocol": "udp",
                    "port": 0,
                    "host": "host"
                }
            }
        ],
        "csi": [
            {
                "name": "nfs_client",
                "properties": {
                    "mountPath": "mountPath",
                    "datastoreUrl": "datastoreUrl",
                    "zone": "zone",
                    "serverIP": "serverIP",
                    "region": "region"
                }
            },
            {
                "name": "nfs_client",
                "properties": {
                    "mountPath": "mountPath",
                    "datastoreUrl": "datastoreUrl",
                    "zone": "zone",
                    "serverIP": "serverIP",
                    "region": "region"
                }
            }
        ],
        "tools": [
            {
                "name": "harbor",
                "properties": {
                    "type": "extension",
                    "extensionId": "extensionId",
                    "url": "url",
                    "username": "username"
                }
            },
            {
                "name": "harbor",
                "properties": {
                    "type": "extension",
                    "extensionId": "extensionId",
                    "url": "url",
                    "username": "username"
                }
            }
        ]
    },
    "masterNodes": [
        {
            "placementParams": [
                {
                    "name": "name",
                    "type": "type"
                },
                {
                    "name": "name",
                    "type": "type"
                }
            ],
            "name": "name",
            "networks": [
                {
                    "nameservers": [
                        "nameservers",
                        "nameservers"
                    ],
                    "networkName": "networkName",
                    "label": "label",
                    "mtu": 0
                },
                {
                    "nameservers": [
                        "nameservers",
                        "nameservers"
                    ],
                    "networkName": "networkName",
                    "label": "label",
                    "mtu": 0
                }
            ]
        },
        {
            "placementParams": [
                {
                    "name": "name",
                    "type": "type"
                },
                {
                    "name": "name",
                    "type": "type"
                }
            ],
            "name": "name",
            "networks": [
                {
                    "nameservers": [
                        "nameservers",
                        "nameservers"
                    ],
                    "networkName": "networkName",
                    "label": "label",
                    "mtu": 0
                },
                {
                    "nameservers": [
                        "nameservers",
                        "nameservers"
                    ],
                    "networkName": "networkName",
                    "label": "label",
                    "mtu": 0
                }
            ]
        }
    ]
}
string
clusterTemplateId
Required

clusterTemplateId

string
clusterType
Required

clusterType

Possible values are : MANAGEMENT, WORKLOAD,
string
description
Optional

description

clusterConfig
Optional

clusterConfig

airgapConfig
Optional

airgapConfig

proxyConfig
Optional

proxyConfig

string
hcxCloudUrl
Required

hcxCloudUrl

string
vimId
Optional

vimId

string
hcxUUID
Optional

hcxUUID

string
managementClusterId
Optional

managementClusterId

masterNodes
Required

Pool of nodes on which Kubernetes control plane can run.

placementParams
Required

placementParams

string
vmTemplate
Required

OS Image With Kubernetes

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.

Returned By