You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/resources/k8s_pool.md
+9-1Lines changed: 9 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -39,31 +39,37 @@ The following arguments are supported:
39
39
-`cluster_id` - (Required) The ID of the Kubernetes cluster on which this pool will be created.
40
40
41
41
-`name` - (Required) The name for the pool.
42
+
42
43
~> **Important:** Updates to this field will recreate a new resource.
43
44
44
45
-`node_type` - (Required) The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). `external` is a special node type used to provision from other Cloud providers.
45
46
46
47
~> **Important:** Updates to this field will recreate a new resource.
47
48
48
49
-`size` - (Required) The size of the pool.
50
+
49
51
~> **Important:** This field will only be used at creation if autoscaling is enabled.
50
52
51
53
-`min_size` - (Defaults to `1`) The minimum size of the pool, used by the autoscaling feature.
52
54
53
55
-`max_size` - (Defaults to `size`) The maximum size of the pool, used by the autoscaling feature.
54
56
55
57
-`tags` - (Optional) The tags associated with the pool.
56
-
> Note: As mentionned in [this document](https://github.com/scaleway/scaleway-cloud-controller-manager/blob/master/docs/tags.md#taints), taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")
58
+
59
+
-> Note: As mentionned in [this document](https://github.com/scaleway/scaleway-cloud-controller-manager/blob/master/docs/tags.md#taints), taints of a pool's nodes are applied using tags. (e.g.: `"taint=taintName=taintValue:Effect"`)
57
60
58
61
-`placement_group_id` - (Optional) The [placement group](https://www.scaleway.com/en/developers/api/instance/#path-placement-groups-create-a-placement-group) the nodes of the pool will be attached to.
62
+
59
63
~> **Important:** Updates to this field will recreate a new resource.
60
64
61
65
-`autoscaling` - (Defaults to `false`) Enables the autoscaling feature for this pool.
66
+
62
67
~> **Important:** When enabled, an update of the `size` will not be taken into account.
63
68
64
69
-`autohealing` - (Defaults to `false`) Enables the autohealing feature for this pool.
65
70
66
71
-`container_runtime` - (Defaults to `containerd`) The container runtime of the pool.
72
+
67
73
~> **Important:** Updates to this field will recreate a new resource.
68
74
69
75
-`kubelet_args` - (Optional) The Kubelet arguments to be used by this pool
@@ -79,13 +85,15 @@ The following arguments are supported:
79
85
-`root_volume_size_in_gb` - (Optional) The size of the system volume of the nodes in gigabyte
80
86
81
87
-`zone` - (Defaults to [provider](../index.md#zone)`zone`) The [zone](../guides/regions_and_zones.md#regions) in which the pool should be created.
88
+
82
89
~> **Important:** Updates to this field will recreate a new resource.
83
90
84
91
-`region` - (Defaults to [provider](../index.md#region)`region`) The [region](../guides/regions_and_zones.md#regions) in which the pool should be created.
85
92
86
93
-`wait_for_pool_ready` - (Defaults to `false`) Whether to wait for the pool to be ready.
87
94
88
95
-`public_ip_disabled` - (Defaults to `false`) Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached [Private Network](vpc_private_network.md) set up with a [Public Gateway](vpc_public_gateway.md).
96
+
89
97
~> **Important:** Updates to this field will recreate a new resource.
0 commit comments