Apache CloudStack 4.20.0.0 Root Admin API Reference
createKubernetesCluster
Creates a Kubernetes cluster
Request parameters
| Parameter Name | Description | Required |
| name | name for the Kubernetes cluster | true |
| zoneid | availability zone in which Kubernetes cluster to be launched | true |
| account | an optional account for the virtual machine. Must be used with domainId. | false |
| clustertype | type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged. | false |
| controlnodes | number of Kubernetes cluster control nodes, default is 1 | false |
| description | description for the Kubernetes cluster | false |
| dockerregistrypassword | password for the docker image private registry | false |
| dockerregistryurl | URL for the docker image private registry | false |
| dockerregistryusername | user name for the docker image private registry | false |
| domainid | an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. | false |
| externalloadbalanceripaddress | external load balancer IP address while using shared network with Kubernetes HA cluster | false |
| keypair | name of the ssh key pair used to login to the virtual machines | false |
| kubernetesversionid | Kubernetes version with which cluster to be launched | false |
| masternodes | number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter. | false |
| networkid | Network in which Kubernetes cluster is to be launched | false |
| noderootdisksize | root disk size in GB for each node | false |
| projectid | Deploy cluster for the project | false |
| serviceofferingid | the ID of the service offering for the virtual machines in the cluster. | false |
| size | number of Kubernetes cluster worker nodes | false |
Response Tags
| Response Name | Description |
| id | the id of the Kubernetes cluster |
| account | the account associated with the Kubernetes cluster |
| associatednetworkname | the name of the network of the Kubernetes cluster |
| autoscalingenabled | Whether autoscaling is enabled for the cluster |
| clustertype | the type of the cluster |
| consoleendpoint | URL end point for the Kubernetes cluster dashboard UI |
| controlnodes | the control nodes count for the Kubernetes cluster |
| cpunumber | the cpu cores of the Kubernetes cluster |
| created | the date when this Kubernetes cluster was created |
| description | the description of the Kubernetes cluster |
| domain | the name of the domain in which the Kubernetes cluster exists |
| domainid | the ID of the domain in which the Kubernetes cluster exists |
| domainpath | path of the domain to which the Kubernetes cluster belongs |
| endpoint | URL end point for the Kubernetes cluster |
| ipaddress | Public IP Address of the cluster |
| ipaddressid | Public IP Address ID of the cluster |
| keypair | keypair details |
| kubernetesversionid | the ID of the Kubernetes version for the Kubernetes cluster |
| kubernetesversionname | the name of the Kubernetes version for the Kubernetes cluster |
| masternodes | the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter. |
| maxsize | Maximum size of the cluster |
| memory | the memory the Kubernetes cluster |
| minsize | Minimum size of the cluster |
| name | the name of the Kubernetes cluster |
| networkid | the ID of the network of the Kubernetes cluster |
| project | the project name of the Kubernetes cluster |
| projectid | the project id of the Kubernetes cluster |
| serviceofferingid | the ID of the service offering of the Kubernetes cluster |
| serviceofferingname | the name of the service offering of the Kubernetes cluster |
| size | the size (worker nodes count) of the Kubernetes cluster |
| state | the state of the Kubernetes cluster |
| templateid | the ID of the template of the Kubernetes cluster |
| virtualmachines | the list of virtualmachine associated with this Kubernetes cluster |
| zoneid | the name of the zone of the Kubernetes cluster |
| zonename | the name of the zone of the Kubernetes cluster |