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"
                }
            }
        ],
        "tools": [
            {
                "name": "string",
                "properties": {
                    "extensionId": "string",
                    "password": "string",
                    "type": "string",
                    "url": "string",
                    "username": "string"
                }
            }
        ],
        "systemSettings": [
            {
                "name": "string",
                "properties": {
                    "host": "string",
                    "port": 0,
                    "protocol": "string"
                }
            }
        ]
    },
    "hcxCloudUrl": "string",
    "endpointIP": "string",
    "managementClusterId": "string",
    "masterNodes": [
        {
            "name": "string",
            "networks": [
                {
                    "label": "string",
                    "networkName": "string",
                    "nameservers": [
                        "string"
                    ]
                }
            ],
            "placementParams": [
                {
                    "name": "string",
                    "type": "string"
                }
            ]
        }
    ],
    "name": "string",
    "placementParams": [
        {
            "name": "string",
            "type": "string"
        }
    ],
    "vmTemplate": "string",
    "workerNodes": [
        {
            "name": "string",
            "networks": [
                {
                    "label": "string",
                    "networkName": "string",
                    "nameservers": [
                        "string"
                    ]
                }
            ],
            "placementParams": [
                {
                    "name": "string",
                    "type": "string"
                }
            ]
        }
    ]
}
string
clusterPassword
Optional

clusterPassword

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

string
hcxCloudUrl
Required

hcxCloudUrl

string
endpointIP
Required

endpointIP

string
managementClusterId
Optional

managementClusterId

array of clusterRequest_masterNodes
masterNodes
Required

masterNodes

string As [a-z0-9]([-a-z0-9]*[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 
{
    "id": "string",
    "operationId": "string"
}
string
id
Optional

id

string
operationId
Optional

operationId


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


On This Page
Infra Operations
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
GET
Get Cluster Config
GET
Get Clusters Node Pools
GET
Get K8 Cluster Node Pool
POST
Kuberenetes Version Upgrade Matrix
POST
Retry Cluster Operation
GET
Supported Kubernetes Versions
PUT
Upgrade Cluster
GET
Upgrade History
POST
Upgrade Node Pool
GET
Validate Upgrade Cluster