Deploy Cluster

Deploy Cluster

Api to deploy Kubernetes Cluster for Telco Cloud Automation

Request
URI
POST
https://{api_host}/hybridity/api//infra/k8s/clusters
COPY
Request Body

create cluster

clusterRequest of type(s) application/json
Required 
{
    "clusterPassword": "string",
    "clusterTemplateId": "string",
    "clusterType": "string",
    "description": "string",
    "location": {
        "city": "string",
        "country": "string",
        "cityAscii": "string",
        "latitude": "string",
        "longitude": "string"
    },
    "clusterConfig": {
        "csi": [
            {
                "name": "string",
                "properties": {
                    "serverIP": "string",
                    "mountPath": "string",
                    "datastoreUrl": "string",
                    "region": "string",
                    "zone": "string"
                }
            }
        ],
        "tools": [
            {
                "name": "string",
                "properties": {
                    "extensionId": "string",
                    "password": "string",
                    "type": "string",
                    "url": "string",
                    "username": "string"
                }
            }
        ],
        "systemSettings": [
            {
                "name": "string",
                "properties": {
                    "host": "string",
                    "port": 0,
                    "protocol": "string"
                }
            }
        ]
    },
    "airgapConfig": {
        "type": "string",
        "extensionId": "string",
        "fqdn": "string",
        "ip": "string",
        "caCert": "string"
    },
    "proxyConfig": {
        "http_proxy": "http_proxy",
        "no_proxy": "no_proxy",
        "https_proxy": "https_proxy",
        "caCert": "caCert",
        "type": "extension",
        "extensionId": "extensionId"
    },
    "hcxCloudUrl": "string",
    "endpointIP": "string",
    "managementClusterId": "string",
    "masterNodes": [
        {
            "name": "string",
            "networks": [
                {
                    "label": "string",
                    "networkName": "string",
                    "mtu": 0,
                    "nameservers": [
                        "string"
                    ]
                }
            ],
            "placementParams": [
                {
                    "name": "string",
                    "type": "string"
                }
            ]
        }
    ],
    "name": "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
clusterPassword
Optional

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

string
clusterTemplateId
Required

clusterTemplateId

string
clusterType
Required

clusterType

Possible values are : MANAGEMENT, WORKLOAD,
string
description
Optional

description

location
location
Optional

location

clusterRequest_clusterConfig
clusterConfig
Optional

clusterConfig

clusterRequest_airgapConfig
airgapConfig
Optional

airgapConfig

proxyConfig
proxyConfig
Optional

proxyConfig

string
hcxCloudUrl
Required

hcxCloudUrl

string
endpointIP
Required

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.

string
managementClusterId
Optional

managementClusterId

array of clusterRequest_masterNodes
masterNodes
Required

Pool of nodes on which Kubernetes control plane can run.

string As ^[a-z][-a-z0-9]{0,44}[a-z0-9]$
name
Required

name

array of clusterRequest_placementParams
placementParams
Required

placementParams

string
vmTemplate
Required

vmTemplate

array of clusterRequest_workerNodes
workerNodes
Optional

workerNodes

Authentication
This operation uses the following authentication methods.
Responses
200

Successfully deployed cluster.

Returns clusterAPIResponse of type(s) application/json 
{
    "operationId": "operationId",
    "id": "id"
}
string
id
Optional

The id of the cluster.

string
operationId
Optional

The operation id for tracking the progress of the operation being performed on the cluster.


400

Bad Request

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

errors


500

Internal Server Error

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

errors


On This Page
Infra Operations
POST
Abort Cluster Operation
PUT
Change Cluster Password
POST
Create Cluster Node Pool
DELETE
Delete Node Pool
POST
Deploy Cluster
PUT
Edit Cluster
PUT
Edit Cluster Config
PUT
Edit Node Pool
POST
Genereate Spec
GET
Get Cluster Config
GET
Get Clusters
GET
Get Clusters Node Pools
GET
Get K8 Cluster Node Pool
GET
Get Node Pool Customization
POST
Kuberenetes Version Upgrade Matrix
PUT
Pause Node Pool
POST
Retry Cluster Operation
GET
Supported Kubernetes Versions
PUT
Sync Esx Info
PUT
Unpause Node Pool
PUT
Upgrade Cluster
PUT
Upgrade Cluster Addon
GET
Upgrade History
POST
Upgrade Node Pool
GET
Validate Upgrade Cluster
GET
Vsphere Csi Zone Support