Skip to content

docs: fix k8s pool callouts #2929

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 21, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/resources/k8s_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,31 +39,37 @@ The following arguments are supported:
- `cluster_id` - (Required) The ID of the Kubernetes cluster on which this pool will be created.

- `name` - (Required) The name for the pool.

~> **Important:** Updates to this field will recreate a new resource.

- `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.

~> **Important:** Updates to this field will recreate a new resource.

- `size` - (Required) The size of the pool.

~> **Important:** This field will only be used at creation if autoscaling is enabled.

- `min_size` - (Defaults to `1`) The minimum size of the pool, used by the autoscaling feature.

- `max_size` - (Defaults to `size`) The maximum size of the pool, used by the autoscaling feature.

- `tags` - (Optional) The tags associated with the pool.
> 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")

-> 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"`)

- `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.

~> **Important:** Updates to this field will recreate a new resource.

- `autoscaling` - (Defaults to `false`) Enables the autoscaling feature for this pool.

~> **Important:** When enabled, an update of the `size` will not be taken into account.

- `autohealing` - (Defaults to `false`) Enables the autohealing feature for this pool.

- `container_runtime` - (Defaults to `containerd`) The container runtime of the pool.

~> **Important:** Updates to this field will recreate a new resource.

- `kubelet_args` - (Optional) The Kubelet arguments to be used by this pool
Expand All @@ -79,13 +85,15 @@ The following arguments are supported:
- `root_volume_size_in_gb` - (Optional) The size of the system volume of the nodes in gigabyte

- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#regions) in which the pool should be created.

~> **Important:** Updates to this field will recreate a new resource.

- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) in which the pool should be created.

- `wait_for_pool_ready` - (Defaults to `false`) Whether to wait for the pool to be ready.

- `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).

~> **Important:** Updates to this field will recreate a new resource.

## Attributes Reference
Expand Down
Loading