Create a new SKS Nodepool

POST /sks-cluster/{id}/nodepool

Path parameters

id string(uuid) Required

application/json

Body Required

anti-affinity-groups array[object]

Nodepool Anti-affinity Groups

Anti-affinity Group
Hide anti-affinity-groups attributes Show anti-affinity-groups attributes object
- name string
  
  Anti-affinity Group name
  
  Minimum length is 1, maximum length is 255.
- description string
  
  Anti-affinity Group description
  
  Maximum length is 255.
description string

Nodepool description

Maximum length is 255.
public-ip-assignment string
Configures public IP assignment of the Instances with:
- IPv4 (inet4) addressing only (default);
- both IPv4 and IPv6 (dual) addressing.
Values are inet4 or dual.
labels object
Hide labels attribute Show labels attribute object
- * string Additional properties
taints object
Hide taints attribute Show taints attribute object
- * object Additional properties
  
  Nodepool taint
  Hide * attributes Show * attributes object
  
  value string Required
  
  Nodepool taint value
  
  Minimum length is 1, maximum length is 255.
  
  effect string Required
  
  Nodepool taint effect
  
  Values are NoExecute, NoSchedule, or PreferNoSchedule.
security-groups array[object]

Nodepool Security Groups

Security Group
Hide security-groups attributes Show security-groups attributes object
- name string
  
  Security Group name
  
  Minimum length is 1, maximum length is 255.
- description string
  
  Security Group description
  
  Maximum length is 255.
- external-sources array[string]
  
  Security Group external sources
- rules array[object]
  
  Security Group rules
  
  Security Group rule
  Hide rules attributes Show rules attributes object
  
  description string
  
  Security Group rule description
  
  Maximum length is 255.
  
  start-port integer(int64)
  
  Start port of the range
  
  Minimum value is 1, maximum value is 65535.
  
  protocol string
  
  Network protocol
  
  Values are tcp, esp, icmp, udp, gre, ah, ipip, or icmpv6.
  
  icmp object
  
  ICMP details
  
  Hide icmp attributes Show icmp attributes object
  
  code integer(int64)
  
  Minimum value is -1, maximum value is 254.
  
  type integer(int64)
  
  Minimum value is -1, maximum value is 254.
  
  end-port integer(int64)
  
  End port of the range
  
  Minimum value is 1, maximum value is 65535.
  
  security-group object
  
  Security Group
  
  Hide security-group attributes Show security-group attributes object
  
  name string
  
  Security Group name
  
  Minimum length is 1, maximum length is 255.
  
  visibility string
  
  Whether this points to a public security group. This is only valid when in the context of a rule addition which uses a public security group as a source or destination.
  
  Values are private or public.
  
  network string
  
  CIDR-formatted network allowed
  
  flow-direction string
  
  Network flow direction to match
  
  Values are ingress or egress.
name string Required

Nodepool name, lowercase only

Minimum length is 1, maximum length is 255.
instance-type object Required

Compute instance type
private-networks array[object]

Nodepool Private Networks

Private Network
Hide private-networks attributes Show private-networks attributes object
- description string
  
  Private Network description
  
  Maximum length is 255.
- labels object
  Hide labels attribute Show labels attribute object
  
  * string Additional properties
- name string
  
  Private Network name
  
  Minimum length is 1, maximum length is 255.
- start-ip string(ipv4)
  
  Private Network start IP address
- vni integer(int64)
  
  Private Network VXLAN ID
  
  Minimum value is 0.
- netmask string(ipv4)
  
  Private Network netmask
- options object
  
  Private Network DHCP Options
  Hide options attributes Show options attributes object
  
  routers array[string(ipv4)]
  
  Routers
  
  dns-servers array[string(ipv4)]
  
  DNS Servers
  
  ntp-servers array[string(ipv4)]
  
  NTP Servers
  
  domain-search array[string]
  
  Domain search list, limited to 255 octets
- end-ip string(ipv4)
  
  Private Network end IP address
size integer(int64) Required

Number of instances

Minimum value is 0.
kubelet-image-gc object

Kubelet image GC options
Hide kubelet-image-gc attributes Show kubelet-image-gc attributes object
- high-threshold integer(int64)
  
  Minimum value is 0.
- low-threshold integer(int64)
  
  Minimum value is 0.
- min-age string
instance-prefix string

Prefix to apply to instances names (default: pool), lowercase only

Minimum length is 1, maximum length is 30.
deploy-target object

Deploy target
Hide deploy-target attributes Show deploy-target attributes object
- id string(uuid) Required
  
  Deploy Target ID
- name string
  
  Deploy Target name
  
  Minimum length is 1, maximum length is 255.
- type string
  
  Deploy Target type
  
  Values are edge or dedicated.
- description string
  
  Deploy Target description
  
  Maximum length is 255.
addons array[string]

Nodepool addons

Value is storage-lvm.
disk-size integer(int64) Required

Nodepool instances disk size in GiB

Minimum value is 20, maximum value is 51200.

Responses

200 application/json

200
Hide response attributes Show response attributes object
- id string(uuid)
  
  Operation ID
- reason string
  
  Operation failure reason
  
  Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.
- reference object
  
  Related resource reference
  
  Hide reference attributes Show reference attributes object
  
  id string(uuid)
  
  Reference ID
  
  link string
  
  Link to the referenced resource
  
  command string
  
  Command name
- message string
  
  Operation message
- state string
  
  Operation status
  
  Values are failure, pending, success, or timeout.

POST /sks-cluster/{id}/nodepool

curl \
 --request POST https://api-ch-gva-2.exoscale.com/v2/sks-cluster/{id}/nodepool \
 --header "Content-Type: application/json" \
 --data '{"anti-affinity-groups":[{"name":"string","description":"string"}],"description":"string","public-ip-assignment":"inet4","labels":{"additionalProperty1":"string","additionalProperty2":"string"},"taints":{"additionalProperty1":{"value":"string","effect":"NoExecute"},"additionalProperty2":{"value":"string","effect":"NoExecute"}},"security-groups":[{"name":"string","description":"string","external-sources":["string"],"rules":[{"description":"string","start-port":42,"protocol":"tcp","icmp":{"code":42,"type":42},"end-port":42,"security-group":{"name":"string","visibility":"private"},"network":"string","flow-direction":"ingress"}]}],"name":"string","instance-type":{},"private-networks":[{"description":"string","labels":{"additionalProperty1":"string","additionalProperty2":"string"},"name":"string","start-ip":"string","vni":42,"netmask":"string","options":{"routers":["string"],"dns-servers":["string"],"ntp-servers":["string"],"domain-search":["string"]},"end-ip":"string"}],"size":42,"kubelet-image-gc":{"high-threshold":42,"low-threshold":42,"min-age":"string"},"instance-prefix":"string","deploy-target":{"id":"string","name":"string","type":"edge","description":"string"},"addons":["storage-lvm"],"disk-size":42}'

Request examples

{
  "anti-affinity-groups": [
    {
      "name": "string",
      "description": "string"
    }
  ],
  "description": "string",
  "public-ip-assignment": "inet4",
  "labels": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "taints": {
    "additionalProperty1": {
      "value": "string",
      "effect": "NoExecute"
    },
    "additionalProperty2": {
      "value": "string",
      "effect": "NoExecute"
    }
  },
  "security-groups": [
    {
      "name": "string",
      "description": "string",
      "external-sources": [
        "string"
      ],
      "rules": [
        {
          "description": "string",
          "start-port": 42,
          "protocol": "tcp",
          "icmp": {
            "code": 42,
            "type": 42
          },
          "end-port": 42,
          "security-group": {
            "name": "string",
            "visibility": "private"
          },
          "network": "string",
          "flow-direction": "ingress"
        }
      ]
    }
  ],
  "name": "string",
  "instance-type": {},
  "private-networks": [
    {
      "description": "string",
      "labels": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "name": "string",
      "start-ip": "string",
      "vni": 42,
      "netmask": "string",
      "options": {
        "routers": [
          "string"
        ],
        "dns-servers": [
          "string"
        ],
        "ntp-servers": [
          "string"
        ],
        "domain-search": [
          "string"
        ]
      },
      "end-ip": "string"
    }
  ],
  "size": 42,
  "kubelet-image-gc": {
    "high-threshold": 42,
    "low-threshold": 42,
    "min-age": "string"
  },
  "instance-prefix": "string",
  "deploy-target": {
    "id": "string",
    "name": "string",
    "type": "edge",
    "description": "string"
  },
  "addons": [
    "storage-lvm"
  ],
  "disk-size": 42
}

Response examples (200)

{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}