Skip to content

Commit 76ff5ff

Browse files
DOC-2250: Added docs for ami template values (#679)
* DOC-2250: Added docs for ami template values * Added note in template * Update docs/resources/cluster_eks.md Co-authored-by: Amanda Churi Filanowski <[email protected]> * Update spectrocloud/schemas/eks_template.go Co-authored-by: Amanda Churi Filanowski <[email protected]> --------- Co-authored-by: Amanda Churi Filanowski <[email protected]>
1 parent 494ead6 commit 76ff5ff

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

docs/resources/cluster_eks.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ description: |-
99

1010
Resource for managing EKS clusters in Spectro Cloud through Palette.
1111

12+
~> When creating a **Palette EKS cluster** with `machine_pool.eks_launch_template`: If you do **not set** `machine_pool.eks_launch_template.ami_id`, Palette will automatically perform **EKS AMI updates**. This will trigger a **cluster repave**, since the system replaces the underlying AMI as part of the update process. To avoid unexpected repaves, explicitly set the `ami_id` in the launch template when defining the `machine_pool`.
13+
14+
1215
## Example Usage
1316

1417
```terraform
@@ -199,7 +202,7 @@ Optional:
199202
Optional:
200203

201204
- `additional_security_groups` (Set of String) Additional security groups to attach to the instance.
202-
- `ami_id` (String) The ID of the custom Amazon Machine Image (AMI).
205+
- `ami_id` (String) The ID of the custom Amazon Machine Image (AMI). If you do not set an `ami_id`, Palette will repave the cluster when it automatically updates the EKS AMI.
203206
- `root_volume_iops` (Number) The number of input/output operations per second (IOPS) for the root volume.
204207
- `root_volume_throughput` (Number) The throughput of the root volume in MiB/s.
205208
- `root_volume_type` (String) The type of the root volume.

spectrocloud/schemas/eks_template.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ func AwsLaunchTemplate() *schema.Schema {
1212
"ami_id": {
1313
Type: schema.TypeString,
1414
Optional: true,
15-
Description: "The ID of the custom Amazon Machine Image (AMI).",
15+
Description: "The ID of the custom Amazon Machine Image (AMI). If you do not set an `ami_id`, Palette will repave the cluster when it automatically updates the EKS AMI.",
1616
},
1717
"root_volume_type": {
1818
Type: schema.TypeString,

templates/resources/cluster_eks.md.tmpl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ description: |-
99

1010
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
1111

12+
~> When creating a **Palette EKS cluster** with `machine_pool.eks_launch_template`: If you do **not set** `machine_pool.eks_launch_template.ami_id`, Palette will automatically perform **EKS AMI updates**. This will trigger a **cluster repave**, since the system replaces the underlying AMI as part of the update process. To avoid unexpected repaves, explicitly set the `ami_id` in the launch template when defining the `machine_pool`.
13+
14+
1215
## Example Usage
1316

1417
```terraform

0 commit comments

Comments
 (0)