Skip to content

Latest commit

 

History

History
127 lines (103 loc) · 6.58 KB

lke_node_pool.md

File metadata and controls

127 lines (103 loc) · 6.58 KB
Raw

lke_node_pool

Manage Linode LKE cluster node pools.

Minimum Required Fields

Field Type Required Description
api_token str Required The Linode account personal access token. It is necessary to run the module.
It can be exposed by the environment variable LINODE_API_TOKEN instead.
See details in Usage.

Examples

- name: Create a Linode LKE node pool
  linode.cloud.lke_node_pool:
    cluster_id: 12345
  
    tags: ['my-pool']
    count: 3
    type: g6-standard-2
    state: present
- name: Create a Linode LKE node pool with autoscaler
  linode.cloud.lke_node_pool:
    cluster_id: 12345
  
    tags: ['my-pool']
    count: 3
    type: g6-standard-2
    
    autoscaler:
        enabled: true
        min: 1
        max: 3

    state: present
- name: Delete a Linode LKE node pool
  linode.cloud.lke_node_pool:
    cluster_id: 12345
    tags: ['my-pool']
    state: absent

Parameters

Field Type Required Description
cluster_id int Required The ID of the LKE cluster that contains this node pool.
tags list Required An array of tags applied to this object. Tags must be unique as they are used by the lke_node_pool module to uniquely identify node pools. (Updatable)
state str Required The desired state of the target. (Choices: present, absent)
autoscaler (sub-options) dict Optional When enabled, the number of nodes autoscales within the defined minimum and maximum values. (Updatable)
count int Optional The number of nodes in the Node Pool. (Updatable)
disks (sub-options) list Optional This Node Pool’s custom disk layout. Each item in this array will create a new disk partition for each node in this Node Pool.
type str Optional The Linode Type for all of the nodes in the Node Pool. Required if state == present.
skip_polling bool Optional If true, the module will not wait for all nodes in the node pool to be ready. (Default: False)
wait_timeout int Optional The period to wait for the node pool to be ready in seconds. (Default: 600)
labels dict Optional Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects. (Updatable)
taints (sub-options) list Optional Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods. (Updatable)

autoscaler

Field Type Required Description
enabled bool Optional Whether autoscaling is enabled for this Node Pool. NOTE: Subsequent playbook runs will override nodes created by the cluster autoscaler. (Updatable)
max int Optional The maximum number of nodes to autoscale to. Defaults to the value provided by the count field. (Updatable)
min int Optional The minimum number of nodes to autoscale to. Defaults to the Node Pool’s count. (Updatable)

disks

Field Type Required Description
type str Required This custom disk partition’s filesystem type. (Choices: raw, ext4)
size int Required The size of this custom disk partition in MB.

taints

Field Type Required Description
key str Required The Kubernetes taint key. (Updatable)
value str Required The Kubernetes taint value. (Updatable)
effect str Required The Kubernetes taint effect. (Choices: NoSchedule, PreferNoSchedule, NoExecute; Updatable)

Return Values

  • node_pool - The Node Pool in JSON serialized form.

    • Sample Response: 
      {
  "autoscaler": {
    "enabled": true,
    "max": 12,
    "min": 3
  },
  "disk_encryption": "enabled",
  "count": 6,
  "disks": [
    {
      "size": 1024,
      "type": "ext-4"
    }
  ],
  "id": 456,
  "nodes": [
    {
      "id": "123456",
      "instance_id": 123458,
      "status": "ready"
    }
  ],
  "tags": [
    "example tag",
    "another example"
  ],
  "type": "g6-standard-4"
}
    • See the Linode API response documentation for a list of returned fields