Create Cluster

Create Cluster

Api to deploy Kubernetes Cluster for Telco Cloud Automation

Request
URI
POST
https://{api_host}/telco/api/caas/v2/clusters
COPY
Query Parameters
string
mgmtClusterName
Optional

Name of the management cluster where the request has to be executed

string
tcaCpId
Optional

Id of the TCA CP where the request has to be routed.


Request Body

create cluster

cluster of type(s) application/json
Required
{
    "lastUpdated": "lastUpdated",
    "metadata": {
        "createdByIntent": "createdByIntent",
        "modifiedByIntent": "modifiedByIntent",
        "tcaCpId": "tcaCpId",
        "resourceVersion": 0.8008281904610115,
        "name": "name",
        "mgmtClusterName": "mgmtClusterName"
    },
    "creationUser": "creationUser",
    "creationDate": "creationDate",
    "spec": {
        "clusterConfigSpec": {
            "ipFamilies": "IPv4",
            "proxy": {
                "caCert": "caCert",
                "httpProxy": "httpProxy",
                "httpsProxy": "httpsProxy",
                "noProxy": "noProxy"
            },
            "airgapSpec": {
                "caCert": "caCert",
                "fqdn": "fqdn",
                "type": "extension",
                "extensionId": "extensionId"
            },
            "tcaBomReleaseRef": {
                "name": "name"
            },
            "cniType": "cniType",
            "controlPlaneEndpoint": {
                "host": "host"
            },
            "proxySpec": {
                "caCert": "caCert",
                "httpProxy": "httpProxy",
                "httpsProxy": "httpsProxy",
                "noProxy": "noProxy",
                "type": "extension",
                "extensionId": "extensionId"
            },
            "cloudProviders": {
                "primeRef": {
                    "vimId": "vimId",
                    "datacenter": "datacenter"
                },
                "subRefs": [
                    {
                        "vimId": "vimId",
                        "datacenter": "datacenter"
                    },
                    {
                        "vimId": "vimId",
                        "datacenter": "datacenter"
                    }
                ]
            },
            "clusterNetwork": {
                "pods": {
                    "cidrBlocks": [
                        "cidrBlocks",
                        "cidrBlocks"
                    ]
                },
                "apiServerPort": 6,
                "services": {
                    "cidrBlocks": [
                        "cidrBlocks",
                        "cidrBlocks"
                    ]
                },
                "serviceDomain": "serviceDomain"
            },
            "publicKeyRef": {
                "uid": "uid",
                "apiVersion": "apiVersion",
                "kind": "kind",
                "resourceVersion": "resourceVersion",
                "fieldPath": "fieldPath",
                "name": "name",
                "namespace": "namespace"
            },
            "strategy": {
                "type": "type",
                "rollingUpdate": {
                    "maxSurge": "",
                    "maxUnavailable": ""
                }
            },
            "airgap": {
                "caCert": "caCert",
                "fqdn": "fqdn"
            }
        },
        "controlPlaneSpec": {
            "template": "template",
            "diskGiB": 5,
            "numCPUs": 7,
            "datastore": "datastore",
            "replicas": 3,
            "kubeadmConfigTemplate": {
                "clusterConfiguration": {
                    "controllerManager": {
                        "extraArgs": {
                            "key": "extraArgs"
                        },
                        "extraVolumes": [
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            },
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            }
                        ]
                    },
                    "kind": "kind",
                    "dns": {
                        "imageRepository": "imageRepository",
                        "imageTag": "imageTag"
                    },
                    "certificatesDir": "certificatesDir",
                    "featureGates": {
                        "key": true
                    },
                    "networking": {
                        "podSubnet": "podSubnet",
                        "serviceSubnet": "serviceSubnet",
                        "dnsDomain": "dnsDomain"
                    },
                    "scheduler": {
                        "extraArgs": {
                            "key": "extraArgs"
                        },
                        "extraVolumes": [
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            },
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            }
                        ]
                    },
                    "apiVersion": "apiVersion",
                    "controlPlaneEndpoint": "controlPlaneEndpoint",
                    "clusterName": "clusterName",
                    "apiServer": {
                        "extraArgs": {
                            "key": "extraArgs"
                        },
                        "timeoutForControlPlane": "timeoutForControlPlane",
                        "certSANs": [
                            "certSANs",
                            "certSANs"
                        ],
                        "extraVolumes": [
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            },
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            }
                        ]
                    },
                    "imageRepository": "imageRepository",
                    "etcd": {
                        "external": {
                            "caFile": "caFile",
                            "endpoints": [
                                "endpoints",
                                "endpoints"
                            ],
                            "keyFile": "keyFile",
                            "certFile": "certFile"
                        },
                        "local": {
                            "peerCertSANs": [
                                "peerCertSANs",
                                "peerCertSANs"
                            ],
                            "extraArgs": {
                                "key": "extraArgs"
                            },
                            "dataDir": "dataDir",
                            "serverCertSANs": [
                                "serverCertSANs",
                                "serverCertSANs"
                            ],
                            "imageRepository": "imageRepository",
                            "imageTag": "imageTag"
                        }
                    },
                    "kubernetesVersion": "kubernetesVersion"
                }
            },
            "cloudMachineTemplate": {
                "type": "type",
                "vSphereMachine": {
                    "template": "template",
                    "cloneMode": "fullClone",
                    "numCoresPerSocket": 1,
                    "folder": "folder",
                    "datastore": "datastore",
                    "datacenter": "datacenter",
                    "storagePolicyName": "storagePolicyName",
                    "resourcePool": "resourcePool"
                }
            },
            "datacenter": "datacenter",
            "storagePolicyName": "storagePolicyName",
            "memoryMiB": 5,
            "labels": {
                "key": "labels"
            },
            "network": {
                "devices": [
                    {
                        "dhcp4": true,
                        "nameservers": [
                            "nameservers",
                            "nameservers"
                        ],
                        "dhcp6": true,
                        "networkName": "networkName",
                        "gateway6": "gateway6",
                        "gateway4": "gateway4",
                        "mtu": 2
                    },
                    {
                        "dhcp4": true,
                        "nameservers": [
                            "nameservers",
                            "nameservers"
                        ],
                        "dhcp6": true,
                        "networkName": "networkName",
                        "gateway6": "gateway6",
                        "gateway4": "gateway4",
                        "mtu": 2
                    }
                ]
            },
            "cloneMode": "fullClone",
            "numCoresPerSocket": 9,
            "folder": "folder",
            "tcaBomReleaseRef": {
                "name": "name"
            },
            "controlPlaneName": "controlPlaneName",
            "clusterName": "clusterName",
            "cloudProvider": {
                "vimId": "vimId"
            },
            "strategy": {
                "type": "type",
                "rollingUpdate": {
                    "maxSurge": "",
                    "maxUnavailable": ""
                }
            },
            "resourcePool": "resourcePool"
        },
        "nfOrchestrationTcaCPId": "nfOrchestrationTcaCPId"
    },
    "status": {
        "deleteAccepted": true,
        "vimId": "vimId",
        "stats": {
            "nodepools": {
                "total": 7,
                "ready": 4,
                "lastTransitionTime": "lastTransitionTime"
            },
            "addons": {
                "total": 7,
                "ready": 4,
                "lastTransitionTime": "lastTransitionTime"
            }
        },
        "clusterUrl": "clusterUrl",
        "resourceVersion": 2.027123023002322,
        "opstatus": "processing",
        "conditions": [
            {
                "severity": "Warning",
                "reason": "reason",
                "lastTransitionTime": "lastTransitionTime",
                "type": "Ready",
                "message": "message",
                "status": true
            },
            {
                "severity": "Warning",
                "reason": "reason",
                "lastTransitionTime": "lastTransitionTime",
                "type": "Ready",
                "message": "message",
                "status": true
            }
        ],
        "kubernetesVersion": "kubernetesVersion"
    }
}
metadata
Optional

metadata

spec
Optional

spec

status
Optional

status

string
lastUpdated
Optional

lastUpdated

string
creationDate
Optional

creationDate

string
creationUser
Optional

creationUser

Authentication
This operation uses the following authentication methods.
Responses
200

Successfully accepted request to deploy cluster.

Returns cluster of type(s) application/json
{
    "lastUpdated": "lastUpdated",
    "metadata": {
        "createdByIntent": "createdByIntent",
        "modifiedByIntent": "modifiedByIntent",
        "tcaCpId": "tcaCpId",
        "resourceVersion": 0.8008281904610115,
        "name": "name",
        "mgmtClusterName": "mgmtClusterName"
    },
    "creationUser": "creationUser",
    "creationDate": "creationDate",
    "spec": {
        "clusterConfigSpec": {
            "ipFamilies": "IPv4",
            "proxy": {
                "caCert": "caCert",
                "httpProxy": "httpProxy",
                "httpsProxy": "httpsProxy",
                "noProxy": "noProxy"
            },
            "airgapSpec": {
                "caCert": "caCert",
                "fqdn": "fqdn",
                "type": "extension",
                "extensionId": "extensionId"
            },
            "tcaBomReleaseRef": {
                "name": "name"
            },
            "cniType": "cniType",
            "controlPlaneEndpoint": {
                "host": "host"
            },
            "proxySpec": {
                "caCert": "caCert",
                "httpProxy": "httpProxy",
                "httpsProxy": "httpsProxy",
                "noProxy": "noProxy",
                "type": "extension",
                "extensionId": "extensionId"
            },
            "cloudProviders": {
                "primeRef": {
                    "vimId": "vimId",
                    "datacenter": "datacenter"
                },
                "subRefs": [
                    {
                        "vimId": "vimId",
                        "datacenter": "datacenter"
                    },
                    {
                        "vimId": "vimId",
                        "datacenter": "datacenter"
                    }
                ]
            },
            "clusterNetwork": {
                "pods": {
                    "cidrBlocks": [
                        "cidrBlocks",
                        "cidrBlocks"
                    ]
                },
                "apiServerPort": 6,
                "services": {
                    "cidrBlocks": [
                        "cidrBlocks",
                        "cidrBlocks"
                    ]
                },
                "serviceDomain": "serviceDomain"
            },
            "publicKeyRef": {
                "uid": "uid",
                "apiVersion": "apiVersion",
                "kind": "kind",
                "resourceVersion": "resourceVersion",
                "fieldPath": "fieldPath",
                "name": "name",
                "namespace": "namespace"
            },
            "strategy": {
                "type": "type",
                "rollingUpdate": {
                    "maxSurge": "",
                    "maxUnavailable": ""
                }
            },
            "airgap": {
                "caCert": "caCert",
                "fqdn": "fqdn"
            }
        },
        "controlPlaneSpec": {
            "template": "template",
            "diskGiB": 5,
            "numCPUs": 7,
            "datastore": "datastore",
            "replicas": 3,
            "kubeadmConfigTemplate": {
                "clusterConfiguration": {
                    "controllerManager": {
                        "extraArgs": {
                            "key": "extraArgs"
                        },
                        "extraVolumes": [
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            },
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            }
                        ]
                    },
                    "kind": "kind",
                    "dns": {
                        "imageRepository": "imageRepository",
                        "imageTag": "imageTag"
                    },
                    "certificatesDir": "certificatesDir",
                    "featureGates": {
                        "key": true
                    },
                    "networking": {
                        "podSubnet": "podSubnet",
                        "serviceSubnet": "serviceSubnet",
                        "dnsDomain": "dnsDomain"
                    },
                    "scheduler": {
                        "extraArgs": {
                            "key": "extraArgs"
                        },
                        "extraVolumes": [
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            },
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            }
                        ]
                    },
                    "apiVersion": "apiVersion",
                    "controlPlaneEndpoint": "controlPlaneEndpoint",
                    "clusterName": "clusterName",
                    "apiServer": {
                        "extraArgs": {
                            "key": "extraArgs"
                        },
                        "timeoutForControlPlane": "timeoutForControlPlane",
                        "certSANs": [
                            "certSANs",
                            "certSANs"
                        ],
                        "extraVolumes": [
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            },
                            {
                                "mountPath": "mountPath",
                                "name": "name",
                                "readOnly": true,
                                "pathType": "pathType",
                                "hostPath": "hostPath"
                            }
                        ]
                    },
                    "imageRepository": "imageRepository",
                    "etcd": {
                        "external": {
                            "caFile": "caFile",
                            "endpoints": [
                                "endpoints",
                                "endpoints"
                            ],
                            "keyFile": "keyFile",
                            "certFile": "certFile"
                        },
                        "local": {
                            "peerCertSANs": [
                                "peerCertSANs",
                                "peerCertSANs"
                            ],
                            "extraArgs": {
                                "key": "extraArgs"
                            },
                            "dataDir": "dataDir",
                            "serverCertSANs": [
                                "serverCertSANs",
                                "serverCertSANs"
                            ],
                            "imageRepository": "imageRepository",
                            "imageTag": "imageTag"
                        }
                    },
                    "kubernetesVersion": "kubernetesVersion"
                }
            },
            "cloudMachineTemplate": {
                "type": "type",
                "vSphereMachine": {
                    "template": "template",
                    "cloneMode": "fullClone",
                    "numCoresPerSocket": 1,
                    "folder": "folder",
                    "datastore": "datastore",
                    "datacenter": "datacenter",
                    "storagePolicyName": "storagePolicyName",
                    "resourcePool": "resourcePool"
                }
            },
            "datacenter": "datacenter",
            "storagePolicyName": "storagePolicyName",
            "memoryMiB": 5,
            "labels": {
                "key": "labels"
            },
            "network": {
                "devices": [
                    {
                        "dhcp4": true,
                        "nameservers": [
                            "nameservers",
                            "nameservers"
                        ],
                        "dhcp6": true,
                        "networkName": "networkName",
                        "gateway6": "gateway6",
                        "gateway4": "gateway4",
                        "mtu": 2
                    },
                    {
                        "dhcp4": true,
                        "nameservers": [
                            "nameservers",
                            "nameservers"
                        ],
                        "dhcp6": true,
                        "networkName": "networkName",
                        "gateway6": "gateway6",
                        "gateway4": "gateway4",
                        "mtu": 2
                    }
                ]
            },
            "cloneMode": "fullClone",
            "numCoresPerSocket": 9,
            "folder": "folder",
            "tcaBomReleaseRef": {
                "name": "name"
            },
            "controlPlaneName": "controlPlaneName",
            "clusterName": "clusterName",
            "cloudProvider": {
                "vimId": "vimId"
            },
            "strategy": {
                "type": "type",
                "rollingUpdate": {
                    "maxSurge": "",
                    "maxUnavailable": ""
                }
            },
            "resourcePool": "resourcePool"
        },
        "nfOrchestrationTcaCPId": "nfOrchestrationTcaCPId"
    },
    "status": {
        "deleteAccepted": true,
        "vimId": "vimId",
        "stats": {
            "nodepools": {
                "total": 7,
                "ready": 4,
                "lastTransitionTime": "lastTransitionTime"
            },
            "addons": {
                "total": 7,
                "ready": 4,
                "lastTransitionTime": "lastTransitionTime"
            }
        },
        "clusterUrl": "clusterUrl",
        "resourceVersion": 2.027123023002322,
        "opstatus": "processing",
        "conditions": [
            {
                "severity": "Warning",
                "reason": "reason",
                "lastTransitionTime": "lastTransitionTime",
                "type": "Ready",
                "message": "message",
                "status": true
            },
            {
                "severity": "Warning",
                "reason": "reason",
                "lastTransitionTime": "lastTransitionTime",
                "type": "Ready",
                "message": "message",
                "status": true
            }
        ],
        "kubernetesVersion": "kubernetesVersion"
    }
}
metadata
Optional

metadata

spec
Optional

spec

status
Optional

status

string
lastUpdated
Optional

lastUpdated

string
creationDate
Optional

creationDate

string
creationUser
Optional

creationUser


400

Bad Request

Returns errorResponse of type(s) application/json
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors


500

Internal Server Error

Returns errorResponse of type(s) application/json
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors