Generate Node Pools Deployment Spec

Generate Node Pools Deployment Spec

API to generate nodepools deployment spec

Request
URI
POST
https://{api_host}/tca/caas/api/v2/orgs/{orgId}/templates/{templateId}/nodepools/{nodepoolTemplateName}/resolve
COPY
Path Parameters
string
orgId
Optional

The identifier of the tenant

string
templateId
Required

Cluster template Id for which deploy spec to be generated

string
nodepoolTemplateName
Required

NodePool template name for which deploy spec to be generated

Request Body

Overrides for nodepool template. nodepool deploy spec is generated by merging the cluster template and overrides

nodePoolOverrides of type(s) application/json
Required
object
metadata
Optional

nodepool metadata

object
spec
Required

nodepool spec

Responses
200

Returns nodepool deployment spec

Returns nodepool of type(s) application/json 
{
    "metadata": {
        "resourceVersion": "number",
        "name": "string",
        "clusterName": "string",
        "mgmtClusterName": "string",
        "tcaCpId": "string",
        "createdByIntent": "string",
        "modifiedByIntent": "string",
        "annotations": {
            "templateName": "string",
            "templateNodepoolName": "string"
        }
    },
    "spec": {
        "autoscaler": {
            "enable": false,
            "maxSize0": 0,
            "minSize0": 0
        },
        "class": "string",
        "cloneMode": "string",
        "cloudMachineTemplate": {
            "type": "string",
            "vSphereMachine": {
                "cloneMode": "string",
                "datacenter": "string",
                "datastore": "string",
                "folder": "string",
                "numCoresPerSocket": 0,
                "resourcePool": "string",
                "storagePolicyName": "string",
                "template": "string"
            }
        },
        "clusterName": "string",
        "datacenter": "string",
        "datastore": "string",
        "diskGiB": 0,
        "folder": "string",
        "healthCheck": {
            "maxUnhealthy": "string",
            "nodeStartupTimeout": "string",
            "unhealthyConditions": [
                {
                    "status": "string",
                    "timeout": "string",
                    "type": "string"
                }
            ]
        },
        "kubeadmConfigTemplate": {
            "joinConfiguration": {
                "nodeRegistration": {}
            }
        },
        "memoryMiB": 0,
        "network": {
            "devices": [
                {
                    "dhcp4": false,
                    "dhcp6": false,
                    "gateway4": "string",
                    "gateway6": "string",
                    "ipAddressPools": [
                        {
                            "name": "string"
                        }
                    ],
                    "mtu": 0,
                    "nameservers": [
                        "string"
                    ],
                    "networkName": "string"
                }
            ]
        },
        "numCPUs": 0,
        "numCoresPerSocket": 0,
        "pause": false,
        "replicas": 0,
        "resourcePool": "string",
        "storagePolicyName": "string",
        "strategy": {
            "rollingUpdate": {
                "deletePolicy": "string"
            },
            "type": "string"
        },
        "tcaBomReleaseRef": {
            "name": "string"
        },
        "template": "string",
        "variables": [
            {
                "definitionFrom": "string",
                "name": "string"
            }
        ],
        "cloudProvider": {
            "vimId": "string"
        },
        "customisations": {
            "networkAdapters": [
                {
                    "networkName": "string",
                    "interfaceName": "string",
                    "mtu": "number"
                }
            ]
        }
    },
    "status": {
        "needUpgrade": false,
        "resourceVersion": "number",
        "opstatus": "string",
        "hostProfile": "string",
        "pause": false,
        "computeResource": {
            "name": "string",
            "type": "string"
        },
        "deleteAccepted": false,
        "conditions": [
            {
                "lastTransitionTime": "string",
                "status": "string",
                "type": "string",
                "reason": "string",
                "message": "string",
                "severity": "string"
            }
        ]
    },
    "lastUpdated": "string",
    "creationDate": "string",
    "creationTenantId": "string",
    "creationUser": "string",
    "intentQueued": false
}
object
metadata
Optional

metadata

object
spec
Optional

properties of NodePools

object
status
Optional

status

string
lastUpdated
Optional

lastUpdated

string
creationDate
Optional

creationDate

string
creationTenantId
Optional

creationTenantId

string
creationUser
Optional

creationUser

boolean
intentQueued
Optional

intentQueued


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

errors


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

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

errors


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

errors


On This Page
Cluster V2 Templates Operations
POST
Create Cluster Template
DELETE
Delete Cluster Template
GET
Download Cluster Template
POST
Generate Addons Deployment Spec
POST
Generate Cluster Deployment Spec
POST
Generate Node Pools Deployment Spec
GET
Get All Cluster Templates
GET
Get Cluster Template
POST
Transform Cluster Template
PUT
Update Cluster Template
POST
Upload Cluster Template