Apache CloudStack 4.21.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 |
| asnumber | the AS Number of the network | false |
| clustertype | type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged. | false |
| cniconfigdetails | used to specify the parameters values for the variables in userdata. Example: cniconfigdetails[0].key=accesskey&cniconfigdetails[0].value=s389ddssaa&cniconfigdetails[1].key=secretkey&cniconfigdetails[1].value=8dshfsss | false |
| cniconfigurationid | the ID of the Userdata | 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. Hosts dedicated to the specified domain will be used for deploying the cluster | false |
| etcdnodes | (Optional) Number of Kubernetes cluster etcd nodes, default is 0.In case the number is greater than 0, etcd nodes are separate from master nodes and are provisioned accordingly | false |
| externalloadbalanceripaddress | external load balancer IP address while using shared network with Kubernetes HA cluster | false |
| hypervisor | the hypervisor on which the CKS cluster is to be deployed. This is required if the zone in which the CKS cluster is being deployed has clusters with different hypervisor types. | 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 |
| nodeofferings | (Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter | false |
| noderootdisksize | root disk size in GB for each node | false |
| nodetemplates | (Optional) Node Type to Template ID mapping. If provided, it overrides the default template: System VM template | 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 |
| cniconfigname | Name of CNI Configuration associated with the cluster |
| cniconfigurationid | ID of CNI Configuration associated with the cluster |
| consoleendpoint | URL end point for the Kubernetes cluster dashboard UI |
| controlnodes | the control nodes count for the Kubernetes cluster |
| controlofferingid | the ID of the service offering of the control nodes on the Kubernetes cluster |
| controlofferingname | the name of the service offering of the control nodes on 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 |
| etcdips | Public IP Addresses of the etcd nodes |
| etcdnodes | the number of the etcd nodes on the Kubernetes cluster |
| etcdofferingid | the ID of the service offering of the etcd nodes on the Kubernetes cluster |
| etcdofferingname | the name of the service offering of the etcd nodes on 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 |
| workerofferingid | the ID of the service offering of the worker nodes on the Kubernetes cluster |
| workerofferingname | the name of the service offering of the worker nodes on the Kubernetes cluster |
| zoneid | the name of the zone of the Kubernetes cluster |
| zonename | the name of the zone of the Kubernetes cluster |