Create KaaS

POST 
/projects/:projectId/providers/Aruba.Container/kaas

Create KaaS

Request

Path Parameters

projectId stringrequired

unique identifier of the project CMP

Query Parameters

api-version string
The requested API version
Default value: 1

application/json

Body

the cluster kubernetes to create

metadata

object

Metadata of the resource

name string

Name of the resource

location

object

Contains information about the Region of a resource

value string

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tags string[]nullable

List of tags for the resource

properties

object

preset boolean

Set this flag to true if you want the vpc and the subnet related to the kaas will be created automatically. Preset is available for all the kaas unless a vpc has been already created in the same project and location.

vpc

object

uri string

Uri of the resource

subnet

object

uri string

Uri of the resource

nodeCidr

object

address string

Address in CIDR notation. The IP range must be between 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16

name string

Name of the nodecidr

podCidr stringnullable

Details of the subnet podcidr

securityGroup

object

name string

Name of the security group

kubernetesVersion

object

value string

Value of the version. See metadata section of the API documentation for an updated list of admissable values.

nodePools

object[]

list of the nodepools of the kaas

Array [

name string

Nodepool name

nodes int32

Number of nodes

instance string

Configuration name of the nodes. See metadata section of the API documentation for an updated list of admissable values.

dataCenter string

Datacenter in which the nodes of the pool will be located. See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

minCount int32nullable

Min number of nodes for the node pool when autoscaling is enabled

maxCount int32nullable

Max number of nodes for the node pool when autoscaling is enabled

autoscaling boolean

Indicate if autoscaling is enabled for the node pool

]

ha booleannullable

If true, the the cluster will be replicated across 3 zones within the region selected. Please note that the Control Panel in HA cannot be disabled once the cluster has been created.

storage

object

maxCumulativeVolumeSize int32nullable

Storage limit for this Kubernetes cluster. The sum of the size of all the volumes used by the cluster must be less than this value, if specified. Default value is null and no limitation will be applied.

billingPlan

object

billingPeriod stringnullable

identity

object

clientId stringnullable

clientSecret stringnullable

autoscalerProfile nullable

apiServerAccessProfile

object

authorizedIpRanges string[]nullable

enablePrivateCluster boolean

text/json

Body

the cluster kubernetes to create

metadata

object

Metadata of the resource

name string

Name of the resource

location

object

Contains information about the Region of a resource

value string

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tags string[]nullable

List of tags for the resource

properties

object

preset boolean

Set this flag to true if you want the vpc and the subnet related to the kaas will be created automatically. Preset is available for all the kaas unless a vpc has been already created in the same project and location.

vpc

object

uri string

Uri of the resource

subnet

object

uri string

Uri of the resource

nodeCidr

object

address string

Address in CIDR notation. The IP range must be between 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16

name string

Name of the nodecidr

podCidr stringnullable

Details of the subnet podcidr

securityGroup

object

name string

Name of the security group

kubernetesVersion

object

value string

Value of the version. See metadata section of the API documentation for an updated list of admissable values.

nodePools

object[]

list of the nodepools of the kaas

Array [

name string

Nodepool name

nodes int32

Number of nodes

instance string

Configuration name of the nodes. See metadata section of the API documentation for an updated list of admissable values.

dataCenter string

Datacenter in which the nodes of the pool will be located. See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

minCount int32nullable

Min number of nodes for the node pool when autoscaling is enabled

maxCount int32nullable

Max number of nodes for the node pool when autoscaling is enabled

autoscaling boolean

Indicate if autoscaling is enabled for the node pool

]

ha booleannullable

If true, the the cluster will be replicated across 3 zones within the region selected. Please note that the Control Panel in HA cannot be disabled once the cluster has been created.

storage

object

maxCumulativeVolumeSize int32nullable

Storage limit for this Kubernetes cluster. The sum of the size of all the volumes used by the cluster must be less than this value, if specified. Default value is null and no limitation will be applied.

billingPlan

object

billingPeriod stringnullable

identity

object

clientId stringnullable

clientSecret stringnullable

autoscalerProfile nullable

apiServerAccessProfile

object

authorizedIpRanges string[]nullable

enablePrivateCluster boolean

application/*+json

Body

the cluster kubernetes to create

metadata

object

Metadata of the resource

name string

Name of the resource

location

object

Contains information about the Region of a resource

value string

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tags string[]nullable

List of tags for the resource

properties

object

preset boolean

Set this flag to true if you want the vpc and the subnet related to the kaas will be created automatically. Preset is available for all the kaas unless a vpc has been already created in the same project and location.

vpc

object

uri string

Uri of the resource

subnet

object

uri string

Uri of the resource

nodeCidr

object

address string

Address in CIDR notation. The IP range must be between 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16

name string

Name of the nodecidr

podCidr stringnullable

Details of the subnet podcidr

securityGroup

object

name string

Name of the security group

kubernetesVersion

object

value string

Value of the version. See metadata section of the API documentation for an updated list of admissable values.

nodePools

object[]

list of the nodepools of the kaas

Array [

name string

Nodepool name

nodes int32

Number of nodes

instance string

Configuration name of the nodes. See metadata section of the API documentation for an updated list of admissable values.

dataCenter string

Datacenter in which the nodes of the pool will be located. See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

minCount int32nullable

Min number of nodes for the node pool when autoscaling is enabled

maxCount int32nullable

Max number of nodes for the node pool when autoscaling is enabled

autoscaling boolean

Indicate if autoscaling is enabled for the node pool

]

ha booleannullable

If true, the the cluster will be replicated across 3 zones within the region selected. Please note that the Control Panel in HA cannot be disabled once the cluster has been created.

storage

object

maxCumulativeVolumeSize int32nullable

Storage limit for this Kubernetes cluster. The sum of the size of all the volumes used by the cluster must be less than this value, if specified. Default value is null and no limitation will be applied.

billingPlan

object

billingPeriod stringnullable

identity

object

clientId stringnullable

clientSecret stringnullable

autoscalerProfile nullable

apiServerAccessProfile

object

authorizedIpRanges string[]nullable

enablePrivateCluster boolean

Responses

201

Created

text/plain

Schema

Schema

metadata

object

id stringnullable

uri stringnullable

name stringnullable

location

object

code stringnullable

country stringnullable

city stringnullable

name stringnullable

value stringnullable

project

object

id stringnullable

folderId stringnullable

tags string[]nullable

category

object

name stringnullable

provider stringnullable

typology

object

id stringnullable

name stringnullable

creationDate date-timenullable

createdBy stringnullable

ownerId stringnullable

updateDate date-timenullable

updatedBy stringnullable

version stringnullable

createdUser stringnullable

updatedUser stringnullable

linkedResources

object[]

nullable

Array [

uri stringnullable

strictCorrelation boolean

]

managedBy stringnullable

annotations

object

nullable

property name* anynullable

status

object

state stringnullable

creationDate date-timenullable

disableStatusInfo

object

isDisabled boolean

reasons string[]

previousStatus

object

state stringnullable

creationDate date-timenullable

failureReason stringnullable

error

object

reason stringnullable

message stringnullable

reservedTo stringnullable

properties

object

linkedResources

object[]

nullable

Array [

uri stringnullable

strictCorrelation boolean

]

preset boolean

vpc

object

uri stringnullable

subnet

object

uri stringnullable

kubernetesVersion

object

value stringnullable

endOfSupportDate date-timenullable

sellStartDate date-timenullable

sellEndDate date-timenullable

recommended boolean

upgradeTo

object

value stringnullable

scheduledAt date-timenullable

nodePools

object[]

nullable

Array [

name stringnullable

nodes int32nullable

autoscaling boolean

creationDate date-timenullable

instance

object

ram stringnullable

price doublenullable

cpu stringnullable

name stringnullable

diskSizeGb stringnullable

dataCenter

object

For more information, check the documentation.

name stringnullable

minCount int32nullable

maxCount int32nullable

]

podcidr

object

address stringnullable

nodecidr

object

address stringnullable

name stringnullable

uri stringnullable

securityGroup

object

name stringnullable

uri stringnullable

ha booleannullable

storage

object

maxCumulativeVolumeSize int32nullable

billingPlan

object

billingPeriod stringnullable

managementIp stringnullable

openstackProject

object

OpenstackProject

id stringnullable

identity

object

clientId stringnullable

apiServerAccessProfile

object

authorizedIpRanges string[]nullable

enablePrivateCluster boolean

data

object

private

object

phase

object

name stringnullable

startDate date-timenullable

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string",
      "folderId": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "ownerId": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string",
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "managedBy": "string",
    "annotations": {}
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string",
    "error": {
      "reason": "string",
      "message": "string"
    },
    "reservedTo": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "preset": true,
    "vpc": {
      "uri": "string"
    },
    "subnet": {
      "uri": "string"
    },
    "kubernetesVersion": {
      "value": "string",
      "endOfSupportDate": "2024-07-29T15:51:28.071Z",
      "sellStartDate": "2024-07-29T15:51:28.071Z",
      "sellEndDate": "2024-07-29T15:51:28.071Z",
      "recommended": true,
      "upgradeTo": {
        "value": "string",
        "scheduledAt": "2024-07-29T15:51:28.071Z"
      }
    },
    "nodePools": [
      {
        "name": "string",
        "nodes": 0,
        "autoscaling": true,
        "creationDate": "2024-07-29T15:51:28.071Z",
        "instance": {
          "ram": "string",
          "price": 0,
          "cpu": "string",
          "name": "string",
          "diskSizeGb": "string"
        },
        "dataCenter": {
          "name": "string"
        },
        "minCount": 0,
        "maxCount": 0
      }
    ],
    "podcidr": {
      "address": "string"
    },
    "nodecidr": {
      "address": "string",
      "name": "string",
      "uri": "string"
    },
    "securityGroup": {
      "name": "string",
      "uri": "string"
    },
    "ha": true,
    "storage": {
      "maxCumulativeVolumeSize": 0
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "managementIp": "string",
    "openstackProject": {
      "id": "string"
    },
    "identity": {
      "clientId": "string"
    },
    "apiServerAccessProfile": {
      "authorizedIpRanges": [
        "string"
      ],
      "enablePrivateCluster": true
    }
  },
  "data": {
    "private": {
      "phase": {
        "name": "string",
        "startDate": "2024-07-29T15:51:28.071Z"
      }
    }
  }
}

application/json

Schema

Schema

metadata

object

id stringnullable

uri stringnullable

name stringnullable

location

object

code stringnullable

country stringnullable

city stringnullable

name stringnullable

value stringnullable

project

object

id stringnullable

folderId stringnullable

tags string[]nullable

category

object

name stringnullable

provider stringnullable

typology

object

id stringnullable

name stringnullable

creationDate date-timenullable

createdBy stringnullable

ownerId stringnullable

updateDate date-timenullable

updatedBy stringnullable

version stringnullable

createdUser stringnullable

updatedUser stringnullable

linkedResources

object[]

nullable

Array [

uri stringnullable

strictCorrelation boolean

]

managedBy stringnullable

annotations

object

nullable

property name* anynullable

status

object

state stringnullable

creationDate date-timenullable

disableStatusInfo

object

isDisabled boolean

reasons string[]

previousStatus

object

state stringnullable

creationDate date-timenullable

failureReason stringnullable

error

object

reason stringnullable

message stringnullable

reservedTo stringnullable

properties

object

linkedResources

object[]

nullable

Array [

uri stringnullable

strictCorrelation boolean

]

preset boolean

vpc

object

uri stringnullable

subnet

object

uri stringnullable

kubernetesVersion

object

value stringnullable

endOfSupportDate date-timenullable

sellStartDate date-timenullable

sellEndDate date-timenullable

recommended boolean

upgradeTo

object

value stringnullable

scheduledAt date-timenullable

nodePools

object[]

nullable

Array [

name stringnullable

nodes int32nullable

autoscaling boolean

creationDate date-timenullable

instance

object

ram stringnullable

price doublenullable

cpu stringnullable

name stringnullable

diskSizeGb stringnullable

dataCenter

object

For more information, check the documentation.

name stringnullable

minCount int32nullable

maxCount int32nullable

]

podcidr

object

address stringnullable

nodecidr

object

address stringnullable

name stringnullable

uri stringnullable

securityGroup

object

name stringnullable

uri stringnullable

ha booleannullable

storage

object

maxCumulativeVolumeSize int32nullable

billingPlan

object

billingPeriod stringnullable

managementIp stringnullable

openstackProject

object

OpenstackProject

id stringnullable

identity

object

clientId stringnullable

apiServerAccessProfile

object

authorizedIpRanges string[]nullable

enablePrivateCluster boolean

data

object

private

object

phase

object

name stringnullable

startDate date-timenullable

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string",
      "folderId": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "ownerId": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string",
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "managedBy": "string",
    "annotations": {}
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string",
    "error": {
      "reason": "string",
      "message": "string"
    },
    "reservedTo": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "preset": true,
    "vpc": {
      "uri": "string"
    },
    "subnet": {
      "uri": "string"
    },
    "kubernetesVersion": {
      "value": "string",
      "endOfSupportDate": "2024-07-29T15:51:28.071Z",
      "sellStartDate": "2024-07-29T15:51:28.071Z",
      "sellEndDate": "2024-07-29T15:51:28.071Z",
      "recommended": true,
      "upgradeTo": {
        "value": "string",
        "scheduledAt": "2024-07-29T15:51:28.071Z"
      }
    },
    "nodePools": [
      {
        "name": "string",
        "nodes": 0,
        "autoscaling": true,
        "creationDate": "2024-07-29T15:51:28.071Z",
        "instance": {
          "ram": "string",
          "price": 0,
          "cpu": "string",
          "name": "string",
          "diskSizeGb": "string"
        },
        "dataCenter": {
          "name": "string"
        },
        "minCount": 0,
        "maxCount": 0
      }
    ],
    "podcidr": {
      "address": "string"
    },
    "nodecidr": {
      "address": "string",
      "name": "string",
      "uri": "string"
    },
    "securityGroup": {
      "name": "string",
      "uri": "string"
    },
    "ha": true,
    "storage": {
      "maxCumulativeVolumeSize": 0
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "managementIp": "string",
    "openstackProject": {
      "id": "string"
    },
    "identity": {
      "clientId": "string"
    },
    "apiServerAccessProfile": {
      "authorizedIpRanges": [
        "string"
      ],
      "enablePrivateCluster": true
    }
  },
  "data": {
    "private": {
      "phase": {
        "name": "string",
        "startDate": "2024-07-29T15:51:28.071Z"
      }
    }
  }
}

text/json

Schema

Schema

metadata

object

id stringnullable

uri stringnullable

name stringnullable

location

object

code stringnullable

country stringnullable

city stringnullable

name stringnullable

value stringnullable

project

object

id stringnullable

folderId stringnullable

tags string[]nullable

category

object

name stringnullable

provider stringnullable

typology

object

id stringnullable

name stringnullable

creationDate date-timenullable

createdBy stringnullable

ownerId stringnullable

updateDate date-timenullable

updatedBy stringnullable

version stringnullable

createdUser stringnullable

updatedUser stringnullable

linkedResources

object[]

nullable

Array [

uri stringnullable

strictCorrelation boolean

]

managedBy stringnullable

annotations

object

nullable

property name* anynullable

status

object

state stringnullable

creationDate date-timenullable

disableStatusInfo

object

isDisabled boolean

reasons string[]

previousStatus

object

state stringnullable

creationDate date-timenullable

failureReason stringnullable

error

object

reason stringnullable

message stringnullable

reservedTo stringnullable

properties

object

linkedResources

object[]

nullable

Array [

uri stringnullable

strictCorrelation boolean

]

preset boolean

vpc

object

uri stringnullable

subnet

object

uri stringnullable

kubernetesVersion

object

value stringnullable

endOfSupportDate date-timenullable

sellStartDate date-timenullable

sellEndDate date-timenullable

recommended boolean

upgradeTo

object

value stringnullable

scheduledAt date-timenullable

nodePools

object[]

nullable

Array [

name stringnullable

nodes int32nullable

autoscaling boolean

creationDate date-timenullable

instance

object

ram stringnullable

price doublenullable

cpu stringnullable

name stringnullable

diskSizeGb stringnullable

dataCenter

object

For more information, check the documentation.

name stringnullable

minCount int32nullable

maxCount int32nullable

]

podcidr

object

address stringnullable

nodecidr

object

address stringnullable

name stringnullable

uri stringnullable

securityGroup

object

name stringnullable

uri stringnullable

ha booleannullable

storage

object

maxCumulativeVolumeSize int32nullable

billingPlan

object

billingPeriod stringnullable

managementIp stringnullable

openstackProject

object

OpenstackProject

id stringnullable

identity

object

clientId stringnullable

apiServerAccessProfile

object

authorizedIpRanges string[]nullable

enablePrivateCluster boolean

data

object

private

object

phase

object

name stringnullable

startDate date-timenullable

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string",
      "folderId": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "ownerId": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string",
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "managedBy": "string",
    "annotations": {}
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string",
    "error": {
      "reason": "string",
      "message": "string"
    },
    "reservedTo": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "preset": true,
    "vpc": {
      "uri": "string"
    },
    "subnet": {
      "uri": "string"
    },
    "kubernetesVersion": {
      "value": "string",
      "endOfSupportDate": "2024-07-29T15:51:28.071Z",
      "sellStartDate": "2024-07-29T15:51:28.071Z",
      "sellEndDate": "2024-07-29T15:51:28.071Z",
      "recommended": true,
      "upgradeTo": {
        "value": "string",
        "scheduledAt": "2024-07-29T15:51:28.071Z"
      }
    },
    "nodePools": [
      {
        "name": "string",
        "nodes": 0,
        "autoscaling": true,
        "creationDate": "2024-07-29T15:51:28.071Z",
        "instance": {
          "ram": "string",
          "price": 0,
          "cpu": "string",
          "name": "string",
          "diskSizeGb": "string"
        },
        "dataCenter": {
          "name": "string"
        },
        "minCount": 0,
        "maxCount": 0
      }
    ],
    "podcidr": {
      "address": "string"
    },
    "nodecidr": {
      "address": "string",
      "name": "string",
      "uri": "string"
    },
    "securityGroup": {
      "name": "string",
      "uri": "string"
    },
    "ha": true,
    "storage": {
      "maxCumulativeVolumeSize": 0
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "managementIp": "string",
    "openstackProject": {
      "id": "string"
    },
    "identity": {
      "clientId": "string"
    },
    "apiServerAccessProfile": {
      "authorizedIpRanges": [
        "string"
      ],
      "enablePrivateCluster": true
    }
  },
  "data": {
    "private": {
      "phase": {
        "name": "string",
        "startDate": "2024-07-29T15:51:28.071Z"
      }
    }
  }
}

400

Bad Request

text/plain

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Internal Server Error

Loading...