Skip to content

DOC-2250: Added docs for ami template values #679

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.

Sign up for GitHub

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
SivaanandM merged 4 commits into from
Sep 18, 2025
Merged

DOC-2250: Added docs for ami template values #679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cc1a003
DOC-2250: Added docs for ami template values
SivaanandM Sep 18, 2025
9e09624
Added note in template
SivaanandM Sep 18, 2025
552a395
Update docs/resources/cluster_eks.md
SivaanandM Sep 18, 2025
01d8f61
Update spectrocloud/schemas/eks_template.go
SivaanandM Sep 18, 2025
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
5 changes: 4 additions & 1 deletion docs/resources/cluster_eks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ description: |-

Resource for managing EKS clusters in Spectro Cloud through Palette.

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


## Example Usage

```terraform
Expand Down Expand Up @@ -199,7 +202,7 @@ Optional:
Optional:

- `additional_security_groups` (Set of String) Additional security groups to attach to the instance.
- `ami_id` (String) The ID of the custom Amazon Machine Image (AMI).
- `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.
- `root_volume_iops` (Number) The number of input/output operations per second (IOPS) for the root volume.
- `root_volume_throughput` (Number) The throughput of the root volume in MiB/s.
- `root_volume_type` (String) The type of the root volume.
Expand Down
2 changes: 1 addition & 1 deletion spectrocloud/schemas/eks_template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ func AwsLaunchTemplate() *schema.Schema {
"ami_id": {
Type: schema.TypeString,
Optional: true,
Description: "The ID of the custom Amazon Machine Image (AMI).",
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.",
},
"root_volume_type": {
Type: schema.TypeString,
Expand Down
3 changes: 3 additions & 0 deletions templates/resources/cluster_eks.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ description: |-

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

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


## Example Usage

```terraform
Expand Down