Skip to content

Commit 7ea0db6

Browse files
authored
docs: fix display of callouts (#2929)
1 parent 8929c7e commit 7ea0db6

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/resources/k8s_pool.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,31 +39,37 @@ The following arguments are supported:
3939
- `cluster_id` - (Required) The ID of the Kubernetes cluster on which this pool will be created.
4040

4141
- `name` - (Required) The name for the pool.
42+
4243
~> **Important:** Updates to this field will recreate a new resource.
4344

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

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

4849
- `size` - (Required) The size of the pool.
50+
4951
~> **Important:** This field will only be used at creation if autoscaling is enabled.
5052

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

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

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

5861
- `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+
5963
~> **Important:** Updates to this field will recreate a new resource.
6064

6165
- `autoscaling` - (Defaults to `false`) Enables the autoscaling feature for this pool.
66+
6267
~> **Important:** When enabled, an update of the `size` will not be taken into account.
6368

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

6671
- `container_runtime` - (Defaults to `containerd`) The container runtime of the pool.
72+
6773
~> **Important:** Updates to this field will recreate a new resource.
6874

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

8187
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#regions) in which the pool should be created.
88+
8289
~> **Important:** Updates to this field will recreate a new resource.
8390

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

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

8895
- `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+
8997
~> **Important:** Updates to this field will recreate a new resource.
9098

9199
## Attributes Reference

0 commit comments

Comments
 (0)