Skip to content

Commit 68235a2

Browse files
authored
Docs: Updated getting started guide to use AL2023 (#7753)
1 parent 3224a0c commit 68235a2

File tree

16 files changed

+25
-58
lines changed

16 files changed

+25
-58
lines changed

website/content/en/docs/getting-started/getting-started-with-karpenter/scripts/step01-config.sh

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,4 @@ export CLUSTER_NAME="${USER}-karpenter-demo"
33
export AWS_DEFAULT_REGION="us-west-2"
44
export AWS_ACCOUNT_ID="$(aws sts get-caller-identity --query Account --output text)"
55
export TEMPOUT="$(mktemp)"
6-
export ARM_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-arm64/recommended/image_id --query Parameter.Value --output text)"
7-
export AMD_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2/recommended/image_id --query Parameter.Value --output text)"
8-
export GPU_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-gpu/recommended/image_id --query Parameter.Value --output text)"
6+
export ALIAS_VERSION="$(aws ssm get-parameter --name "/aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2023/x86_64/standard/recommended/image_id" --query Parameter.Value | xargs aws ec2 describe-images --query 'Images[0].Name' --image-ids | sed -r 's/^.*(v[[:digit:]]+).*$/\1/')"

website/content/en/docs/getting-started/getting-started-with-karpenter/scripts/step02-create-cluster.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ iamIdentityMappings:
3737
3838
managedNodeGroups:
3939
- instanceType: m5.large
40-
amiFamily: AmazonLinux2
40+
amiFamily: AmazonLinux2023
4141
name: ${CLUSTER_NAME}-ng
4242
desiredCapacity: 2
4343
minSize: 1

website/content/en/docs/getting-started/getting-started-with-karpenter/scripts/step12-add-nodepool.sh

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,13 @@ kind: EC2NodeClass
3838
metadata:
3939
name: default
4040
spec:
41-
amiFamily: AL2 # Amazon Linux 2
4241
role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
42+
amiSelectorTerms:
43+
- alias: "al2023@${ALIAS_VERSION}"
4344
subnetSelectorTerms:
4445
- tags:
4546
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
4647
securityGroupSelectorTerms:
4748
- tags:
4849
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
49-
amiSelectorTerms:
50-
- id: "${ARM_AMI_ID}"
51-
- id: "${AMD_AMI_ID}"
52-
# - id: "${GPU_AMI_ID}" # <- GPU Optimized AMD AMI
53-
# - name: "amazon-eks-node-${K8S_VERSION}-*" # <- automatically upgrade when a new AL2 EKS Optimized AMI is released. This is unsafe for production workloads. Validate AMIs in lower environments before deploying them to production.
5450
EOF

website/content/en/docs/getting-started/migrating-from-cas/scripts/step01-env.sh

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,4 @@ OIDC_ENDPOINT="$(aws eks describe-cluster --name "${CLUSTER_NAME}" \
55
AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query 'Account' \
66
--output text)
77
K8S_VERSION=1.28
8-
ARM_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-arm64/recommended/image_id --query Parameter.Value --output text)"
9-
AMD_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2/recommended/image_id --query Parameter.Value --output text)"
10-
GPU_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-gpu/recommended/image_id --query Parameter.Value --output text)"
8+
ALIAS_VERSION="$(aws ssm get-parameter --name "/aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2023/x86_64/standard/recommended/image_id" --query Parameter.Value | xargs aws ec2 describe-images --query 'Images[0].Name' --image-ids | sed -r 's/^.*(v[[:digit:]]+).*$/\1/')"

website/content/en/docs/getting-started/migrating-from-cas/scripts/step10-create-nodepool.sh

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,12 @@ kind: EC2NodeClass
3838
metadata:
3939
name: default
4040
spec:
41-
amiFamily: AL2 # Amazon Linux 2
4241
role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
42+
amiSelectorTerms:
43+
- alias: "al2023@${ALIAS_VERSION}"
4344
subnetSelectorTerms:
4445
- tags:
4546
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
4647
securityGroupSelectorTerms:
4748
- tags:
4849
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
49-
amiSelectorTerms:
50-
- id: "${ARM_AMI_ID}"
51-
- id: "${AMD_AMI_ID}"
52-
# - id: "${GPU_AMI_ID}" # <- GPU Optimized AMD AMI
53-
# - name: "amazon-eks-node-${K8S_VERSION}-*" # <- automatically upgrade when a new AL2 EKS Optimized AMI is released. This is unsafe for production workloads. Validate AMIs in lower environments before deploying them to production.
54-
EOF

website/content/en/preview/concepts/nodeclasses.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,10 @@ spec:
429429

430430
### AL2
431431

432+
{{% alert title="AL2 support dropped at Kubernetes 1.33" color="warning" %}}
433+
Kubernetes version 1.32 is the last version for which Amazon EKS will release Amazon Linux 2 (AL2) AMIs.
434+
{{% /alert %}}
435+
432436
{{% alert title="Note" color="primary" %}}
433437
Note that Karpenter will automatically generate a call to the `/etc/eks/bootstrap.sh` script as part of its generated UserData. When using `amiFamily: AL2` you should not call this script yourself in `.spec.userData`. If you need to, use the [Custom AMI family]({{< ref "./nodeclasses/#custom" >}}) instead.
434438
{{% /alert %}}

website/content/en/preview/getting-started/getting-started-with-karpenter/scripts/step01-config.sh

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,4 @@ export CLUSTER_NAME="${USER}-karpenter-demo"
33
export AWS_DEFAULT_REGION="us-west-2"
44
export AWS_ACCOUNT_ID="$(aws sts get-caller-identity --query Account --output text)"
55
export TEMPOUT="$(mktemp)"
6-
export ARM_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-arm64/recommended/image_id --query Parameter.Value --output text)"
7-
export AMD_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2/recommended/image_id --query Parameter.Value --output text)"
8-
export GPU_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-gpu/recommended/image_id --query Parameter.Value --output text)"
6+
export ALIAS_VERSION="$(aws ssm get-parameter --name "/aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2023/x86_64/standard/recommended/image_id" --query Parameter.Value | xargs aws ec2 describe-images --query 'Images[0].Name' --image-ids | sed -r 's/^.*(v[[:digit:]]+).*$/\1/')"

website/content/en/preview/getting-started/getting-started-with-karpenter/scripts/step02-create-cluster.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ iamIdentityMappings:
3737
3838
managedNodeGroups:
3939
- instanceType: m5.large
40-
amiFamily: AmazonLinux2
40+
amiFamily: AmazonLinux2023
4141
name: ${CLUSTER_NAME}-ng
4242
desiredCapacity: 2
4343
minSize: 1

website/content/en/preview/getting-started/getting-started-with-karpenter/scripts/step12-add-nodepool.sh

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,13 @@ kind: EC2NodeClass
3838
metadata:
3939
name: default
4040
spec:
41-
amiFamily: AL2 # Amazon Linux 2
4241
role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
42+
amiSelectorTerms:
43+
- alias: "al2023@${ALIAS_VERSION}"
4344
subnetSelectorTerms:
4445
- tags:
4546
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
4647
securityGroupSelectorTerms:
4748
- tags:
4849
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
49-
amiSelectorTerms:
50-
- id: "${ARM_AMI_ID}"
51-
- id: "${AMD_AMI_ID}"
52-
# - id: "${GPU_AMI_ID}" # <- GPU Optimized AMD AMI
53-
# - name: "amazon-eks-node-${K8S_VERSION}-*" # <- automatically upgrade when a new AL2 EKS Optimized AMI is released. This is unsafe for production workloads. Validate AMIs in lower environments before deploying them to production.
5450
EOF

website/content/en/preview/getting-started/migrating-from-cas/scripts/step01-env.sh

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,4 @@ OIDC_ENDPOINT="$(aws eks describe-cluster --name "${CLUSTER_NAME}" \
55
AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query 'Account' \
66
--output text)
77
K8S_VERSION=1.28
8-
ARM_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-arm64/recommended/image_id --query Parameter.Value --output text)"
9-
AMD_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2/recommended/image_id --query Parameter.Value --output text)"
10-
GPU_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-gpu/recommended/image_id --query Parameter.Value --output text)"
8+
ALIAS_VERSION="$(aws ssm get-parameter --name "/aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2023/x86_64/standard/recommended/image_id" --query Parameter.Value | xargs aws ec2 describe-images --query 'Images[0].Name' --image-ids | sed -r 's/^.*(v[[:digit:]]+).*$/\1/')"

website/content/en/preview/getting-started/migrating-from-cas/scripts/step10-create-nodepool.sh

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,13 @@ kind: EC2NodeClass
3838
metadata:
3939
name: default
4040
spec:
41-
amiFamily: AL2 # Amazon Linux 2
4241
role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
42+
amiSelectorTerms:
43+
- alias: "al2023@${ALIAS_VERSION}"
4344
subnetSelectorTerms:
4445
- tags:
4546
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
4647
securityGroupSelectorTerms:
4748
- tags:
4849
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
49-
amiSelectorTerms:
50-
- id: "${ARM_AMI_ID}"
51-
- id: "${AMD_AMI_ID}"
52-
# - id: "${GPU_AMI_ID}" # <- GPU Optimized AMD AMI
53-
# - name: "amazon-eks-node-${K8S_VERSION}-*" # <- automatically upgrade when a new AL2 EKS Optimized AMI is released. This is unsafe for production workloads. Validate AMIs in lower environments before deploying them to production.
5450
EOF

website/content/en/v1.2/getting-started/getting-started-with-karpenter/scripts/step01-config.sh

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,4 @@ export CLUSTER_NAME="${USER}-karpenter-demo"
33
export AWS_DEFAULT_REGION="us-west-2"
44
export AWS_ACCOUNT_ID="$(aws sts get-caller-identity --query Account --output text)"
55
export TEMPOUT="$(mktemp)"
6-
export ARM_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-arm64/recommended/image_id --query Parameter.Value --output text)"
7-
export AMD_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2/recommended/image_id --query Parameter.Value --output text)"
8-
export GPU_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-gpu/recommended/image_id --query Parameter.Value --output text)"
6+
export ALIAS_VERSION="$(aws ssm get-parameter --name "/aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2023/x86_64/standard/recommended/image_id" --query Parameter.Value | xargs aws ec2 describe-images --query 'Images[0].Name' --image-ids | sed -r 's/^.*(v[[:digit:]]+).*$/\1/')"

website/content/en/v1.2/getting-started/getting-started-with-karpenter/scripts/step02-create-cluster.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ iamIdentityMappings:
3737
3838
managedNodeGroups:
3939
- instanceType: m5.large
40-
amiFamily: AmazonLinux2
40+
amiFamily: AmazonLinux2023
4141
name: ${CLUSTER_NAME}-ng
4242
desiredCapacity: 2
4343
minSize: 1

website/content/en/v1.2/getting-started/getting-started-with-karpenter/scripts/step12-add-nodepool.sh

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,13 @@ kind: EC2NodeClass
3838
metadata:
3939
name: default
4040
spec:
41-
amiFamily: AL2 # Amazon Linux 2
4241
role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
42+
amiSelectorTerms:
43+
- alias: "al2023@${ALIAS_VERSION}"
4344
subnetSelectorTerms:
4445
- tags:
4546
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
4647
securityGroupSelectorTerms:
4748
- tags:
4849
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
49-
amiSelectorTerms:
50-
- id: "${ARM_AMI_ID}"
51-
- id: "${AMD_AMI_ID}"
52-
# - id: "${GPU_AMI_ID}" # <- GPU Optimized AMD AMI
53-
# - name: "amazon-eks-node-${K8S_VERSION}-*" # <- automatically upgrade when a new AL2 EKS Optimized AMI is released. This is unsafe for production workloads. Validate AMIs in lower environments before deploying them to production.
5450
EOF

website/content/en/v1.2/getting-started/migrating-from-cas/scripts/step01-env.sh

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,4 @@ OIDC_ENDPOINT="$(aws eks describe-cluster --name "${CLUSTER_NAME}" \
55
AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query 'Account' \
66
--output text)
77
K8S_VERSION=1.28
8-
ARM_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-arm64/recommended/image_id --query Parameter.Value --output text)"
9-
AMD_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2/recommended/image_id --query Parameter.Value --output text)"
10-
GPU_AMI_ID="$(aws ssm get-parameter --name /aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2-gpu/recommended/image_id --query Parameter.Value --output text)"
8+
ALIAS_VERSION="$(aws ssm get-parameter --name "/aws/service/eks/optimized-ami/${K8S_VERSION}/amazon-linux-2023/x86_64/standard/recommended/image_id" --query Parameter.Value | xargs aws ec2 describe-images --query 'Images[0].Name' --image-ids | sed -r 's/^.*(v[[:digit:]]+).*$/\1/')"

website/content/en/v1.2/getting-started/migrating-from-cas/scripts/step10-create-nodepool.sh

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,13 @@ kind: EC2NodeClass
3838
metadata:
3939
name: default
4040
spec:
41-
amiFamily: AL2 # Amazon Linux 2
4241
role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
42+
amiSelectorTerms:
43+
- alias: "al2023@${ALIAS_VERSION}"
4344
subnetSelectorTerms:
4445
- tags:
4546
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
4647
securityGroupSelectorTerms:
4748
- tags:
4849
karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
49-
amiSelectorTerms:
50-
- id: "${ARM_AMI_ID}"
51-
- id: "${AMD_AMI_ID}"
52-
# - id: "${GPU_AMI_ID}" # <- GPU Optimized AMD AMI
53-
# - name: "amazon-eks-node-${K8S_VERSION}-*" # <- automatically upgrade when a new AL2 EKS Optimized AMI is released. This is unsafe for production workloads. Validate AMIs in lower environments before deploying them to production.
5450
EOF

0 commit comments

Comments
 (0)