Skip to main content

Create_Cluster_Payload

environment_namestringrequired

Name of the environment containing the resource.

keypair_namestringrequired

Name of the SSH keypair attached to the VM.

kubernetes_versionstringrequired

Kubernetes version installed on the cluster.

master_flavor_namestringrequired

Flavor used for the master nodes.

namestringrequired

Resource name.

Max length: 20 characters

master_countinteger

Minimum master count is 2; 1 is rejected.

Possible values: >= 2 and <= 3

node_countinteger

Total number of worker nodes in the cluster.

node_flavor_namestring

Flavor used for the worker nodes.

deployment_modestring

Cluster deployment mode (single-node, HA, etc.).

Possible values: [full, standard]

Default: full
Example: full
node_groups object[]

Worker-node groups in the cluster.

  • Array [
  • flavor_namestringrequired

    Name of the flavor (machine type), see List flavors.

    namestringrequired

    Resource name.

    Max length: 20 characters

    rolestringrequired

    Role assigned to the user.

    Possible values: [worker]

    Default: worker
    Example: worker
    countinteger

    Number of items returned in the current page.

    Possible values: >= 1

    min_countinteger

    Minimum number of nodes the group will scale down to.

    Possible values: >= 1

    max_countinteger

    Maximum number of nodes the group will scale up to.

    Possible values: <= 20

    firewall_idsinteger[]

    IDs of the firewalls to apply to all nodes in this node group

  • ]
  • Create_Cluster_Payload
    {
    "environment_name": "string",
    "keypair_name": "string",
    "kubernetes_version": "string",
    "master_flavor_name": "string",
    "name": "string",
    "master_count": 0,
    "node_count": 0,
    "node_flavor_name": "string",
    "deployment_mode": "full",
    "node_groups": [
    {
    "flavor_name": "string",
    "name": "string",
    "role": "worker",
    "count": 0,
    "min_count": 0,
    "max_count": 0,
    "firewall_ids": [
    0
    ]
    }
    ]
    }