docs: Update v1beta1 to v1 examples (#6609)

aws · Aug 8, 2024 · 66019a6 · 66019a6
1 parent c66e3f5
commit 66019a6
Show file tree

Hide file tree

Showing 22 changed files with 168 additions and 155 deletions.
diff --git a/examples/v1beta1/100-cpu-limit.yaml → examples/v1/100-cpu-limit.yaml b/examples/v1beta1/100-cpu-limit.yaml → examples/v1/100-cpu-limit.yaml
@@ -2,7 +2,7 @@
 # Karpenter for this NodePool. Karpenter will not provision compute that
 # takes the pool over a total of 100 (virtual or physical) CPU cores.
 ---
-apiVersion: karpenter.sh/v1beta1
+apiVersion: karpenter.sh/v1
 kind: NodePool
 metadata:
   name: limitcpu100
@@ -28,24 +28,25 @@ spec:
           operator: Gt
           values: ["2"]
       nodeClassRef:
-        apiVersion: karpenter.k8s.aws/v1beta1
+        group: karpenter.k8s.aws
         kind: EC2NodeClass
         name: default
   limits:
     cpu: 100
 ---
-apiVersion: karpenter.k8s.aws/v1beta1
+apiVersion: karpenter.k8s.aws/v1
 kind: EC2NodeClass
 metadata:
   name: default
   annotations:
     kubernetes.io/description: "General purpose EC2NodeClass for running Amazon Linux 2 nodes"
 spec:
-  amiFamily: AL2 # Amazon Linux 2
   role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
   subnetSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
   securityGroupSelectorTerms:
     - tags:
-        karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
+        karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
+  amiSelectorTerms:
+    - alias: al2023@latest # Amazon Linux 2023
diff --git a/examples/v1beta1/al2-custom-ami.yaml → examples/v1/al2-custom-ami.yaml b/examples/v1beta1/al2-custom-ami.yaml → examples/v1/al2-custom-ami.yaml
@@ -2,7 +2,7 @@
 # AL2 AMIFamily. If your AMIs are built off https://github.com/awslabs/amazon-eks-ami and can be bootstrapped
 # by Karpenter, this may be a good fit for you.
 ---
-apiVersion: karpenter.sh/v1beta1
+apiVersion: karpenter.sh/v1
 kind: NodePool
 metadata:
   name: default
@@ -28,11 +28,11 @@ spec:
           operator: Gt
           values: ["2"]
       nodeClassRef:
-        apiVersion: karpenter.k8s.aws/v1beta1
+        group: karpenter.k8s.aws
         kind: EC2NodeClass
         name: al2
 ---
-apiVersion: karpenter.k8s.aws/v1beta1
+apiVersion: karpenter.k8s.aws/v1
 kind: EC2NodeClass
 metadata:
   name: al2

diff --git a/examples/v1beta1/al2-custom-userdata.yaml → examples/v1/al2-custom-userdata.yaml b/examples/v1beta1/al2-custom-userdata.yaml → examples/v1/al2-custom-userdata.yaml
@@ -2,7 +2,7 @@
 # The UserData defined in spec.UserData needs to be in the MIME-multipart format,
 # and will be prepended to a Karpenter managed section that will bootstrap the kubelet.
 ---
-apiVersion: karpenter.sh/v1beta1
+apiVersion: karpenter.sh/v1
 kind: NodePool
 metadata:
   name: default
@@ -28,25 +28,26 @@ spec:
           operator: Gt
           values: ["2"]
       nodeClassRef:
-        apiVersion: karpenter.k8s.aws/v1beta1
+        group: karpenter.k8s.aws
         kind: EC2NodeClass
         name: al2
 ---
-apiVersion: karpenter.k8s.aws/v1beta1
+apiVersion: karpenter.k8s.aws/v1
 kind: EC2NodeClass
 metadata:
   name: al2
   annotations:
     kubernetes.io/description: "EC2NodeClass for running Amazon Linux 2 nodes with custom user data"
 spec:
-  amiFamily: AL2 # Amazon Linux 2
   role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
   subnetSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
   securityGroupSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
+  amiSelectorTerms:
+    - alias: al2023@latest # Amazon Linux 2023
   userData: |
     MIME-Version: 1.0
     Content-Type: multipart/mixed; boundary="BOUNDARY"

diff --git a/examples/v1beta1/al2-kubelet-log-query.yaml → examples/v1/al2-kubelet-log-query.yaml b/examples/v1beta1/al2-kubelet-log-query.yaml → examples/v1/al2-kubelet-log-query.yaml
@@ -1,7 +1,7 @@
 # This example NodePool will provision instances using the AL2 EKS-Optimized AMI
 # and will be prepended to a Karpenter managed section that will bootstrap the kubelet.
 ---
-apiVersion: karpenter.sh/v1beta1
+apiVersion: karpenter.sh/v1
 kind: NodePool
 metadata:
   name: default
@@ -27,25 +27,26 @@ spec:
           operator: Gt
           values: ["2"]
       nodeClassRef:
-        apiVersion: karpenter.k8s.aws/v1beta1
+        group: karpenter.k8s.aws
         kind: EC2NodeClass
         name: al2
 ---
-apiVersion: karpenter.k8s.aws/v1beta1
+apiVersion: karpenter.k8s.aws/v1
 kind: EC2NodeClass
 metadata:
   name: al2
   annotations:
     kubernetes.io/description: "EC2NodeClass for running Amazon Linux 2 nodes with user data that enables the NodeLogQuery feature gate"
 spec:
-  amiFamily: AL2 # Amazon Linux 2
   role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
   subnetSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
   securityGroupSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
+  amiSelectorTerms:
+    - alias: al2023@latest # Amazon Linux 2023
   userData: |
     MIME-Version: 1.0
     Content-Type: multipart/mixed; boundary="BOUNDARY"

diff --git a/examples/v1beta1/al2023-custom-userdata.yaml → examples/v1/al2023-custom-userdata.yaml b/examples/v1beta1/al2023-custom-userdata.yaml → examples/v1/al2023-custom-userdata.yaml
@@ -1,6 +1,6 @@
 # This example NodePool will provision instances using the AL2023 EKS-Optimized AMI.
 ---
-apiVersion: karpenter.sh/v1beta1
+apiVersion: karpenter.sh/v1
 kind: NodePool
 metadata:
   name: default
@@ -26,25 +26,26 @@ spec:
           operator: Gt
           values: ["2"]
       nodeClassRef:
-        apiVersion: karpenter.k8s.aws/v1beta1
+        group: karpenter.k8s.aws
         kind: EC2NodeClass
         name: al2023
 ---
-apiVersion: karpenter.k8s.aws/v1beta1
+apiVersion: karpenter.k8s.aws/v1
 kind: EC2NodeClass
 metadata:
   name: al2023
   annotations:
     kubernetes.io/description: "EC2NodeClass for running Amazon Linux 2023 nodes with custom user data"
 spec:
-  amiFamily: AL2023 # Amazon Linux 2023
   role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
   subnetSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
   securityGroupSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
+  amiSelectorTerms:
+    - alias: al2023@latest # Amazon Linux 2023
   userData: |
     MIME-Version: 1.0
     Content-Type: multipart/mixed; boundary="//"

diff --git a/examples/v1beta1/bottlerocket.yaml → examples/v1/bottlerocket.yaml b/examples/v1beta1/bottlerocket.yaml → examples/v1/bottlerocket.yaml
@@ -1,7 +1,7 @@
 # This example NodePool will provision instances
 # running Bottlerocket OS
 ---
-apiVersion: karpenter.sh/v1beta1
+apiVersion: karpenter.sh/v1
 kind: NodePool
 metadata:
   name: default
@@ -27,25 +27,26 @@ spec:
           operator: Gt
           values: ["2"]
       nodeClassRef:
-        apiVersion: karpenter.k8s.aws/v1beta1
+        group: karpenter.k8s.aws
         kind: EC2NodeClass
         name: bottlerocket
 ---
-apiVersion: karpenter.k8s.aws/v1beta1
+apiVersion: karpenter.k8s.aws/v1
 kind: EC2NodeClass
 metadata:
   name: bottlerocket
   annotations:
     kubernetes.io/description: "EC2NodeClass for running Bottlerocket nodes"
 spec:
-  amiFamily: Bottlerocket
   role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
   subnetSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
   securityGroupSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
+  amiSelectorTerms:
+    - alias: bottlerocket@latest # Bottlerocket
   blockDeviceMappings:
     - deviceName: /dev/xvda
       ebs:

diff --git a/examples/v1beta1/br-custom-userdata.yaml → examples/v1/br-custom-userdata.yaml b/examples/v1beta1/br-custom-userdata.yaml → examples/v1/br-custom-userdata.yaml
@@ -2,7 +2,7 @@
 # running Bottlerocket OS and the user data settings specified in
 # this EC2NodeClass will be merged into Karpenter defaults.
 ---
-apiVersion: karpenter.sh/v1beta1
+apiVersion: karpenter.sh/v1
 kind: NodePool
 metadata:
   name: default
@@ -28,25 +28,26 @@ spec:
           operator: Gt
           values: ["2"]
       nodeClassRef:
-        apiVersion: karpenter.k8s.aws/v1beta1
+        group: karpenter.k8s.aws
         kind: EC2NodeClass
         name: bottlerocket
 ---
-apiVersion: karpenter.k8s.aws/v1beta1
+apiVersion: karpenter.k8s.aws/v1
 kind: EC2NodeClass
 metadata:
   name: bottlerocket
   annotations:
     kubernetes.io/description: "EC2NodeClass for running Bottlerocket nodes with custom user data"
 spec:
-  amiFamily: Bottlerocket
   role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
   subnetSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
   securityGroupSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
+  amiSelectorTerms:
+    - alias: bottlerocket@latest # Bottlerocket
   userData:  |
     [settings.kubernetes]
     kube-api-qps = 30
diff --git a/examples/v1/custom-family-with-alias.yaml b/examples/v1/custom-family-with-alias.yaml
@@ -0,0 +1,64 @@
+# This example NodePool provisions instances using an AMI that belongs to a custom AMIFamily with an Alisa
+# Keep in mind, that you're in charge of bootstrapping your worker nodes.
+---
+apiVersion: karpenter.sh/v1
+kind: NodePool
+metadata:
+  name: default
+  annotations:
+    kubernetes.io/description: "General purpose NodePool for generic workloads"
+spec:
+  template:
+    spec:
+      requirements:
+        - key: kubernetes.io/arch
+          operator: In
+          values: ["amd64"]
+        - key: kubernetes.io/os
+          operator: In
+          values: ["linux"]
+        - key: karpenter.sh/capacity-type
+          operator: In
+          values: ["on-demand"]
+        - key: karpenter.k8s.aws/instance-category
+          operator: In
+          values: ["c", "m", "r"]
+        - key: karpenter.k8s.aws/instance-generation
+          operator: Gt
+          values: ["2"]
+      nodeClassRef:
+        group: karpenter.k8s.aws
+        kind: EC2NodeClass
+        name: custom-family
+---
+apiVersion: karpenter.k8s.aws/v1
+kind: EC2NodeClass
+metadata:
+  name: custom-family
+  annotations:
+    kubernetes.io/description: "EC2NodeClass for running Custom AMIFamily with custom user data that doesn't conform to the other AMIFamilies"
+spec:
+  amiFamily: Custom
+  role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
+  subnetSelectorTerms:
+    - tags:
+        karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
+  securityGroupSelectorTerms:
+    - tags:
+        karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
+  amiSelectorTerms:
+    - alias: bottlerocket@latest
+  userData: |
+    MIME-Version: 1.0
+    Content-Type: multipart/mixed; boundary="BOUNDARY"
+
+    --BOUNDARY
+    Content-Type: text/x-shellscript; charset="us-ascii"
+
+    #!/bin/bash
+    echo "Running my custom set-up"
+    
+    # Have the kubelet label the node
+    /etc/eks/bootstrap.sh my-cluster --kubelet-extra-args='--node-labels=foo=bar'
+
+    --BOUNDARY
diff --git a/examples/v1beta1/custom-family.yaml → examples/v1/custom-family.yaml b/examples/v1beta1/custom-family.yaml → examples/v1/custom-family.yaml
@@ -1,7 +1,7 @@
 # This example NodePool provisions instances using an AMI that belongs to a custom AMIFamily
 # Keep in mind, that you're in charge of bootstrapping your worker nodes.
 ---
-apiVersion: karpenter.sh/v1beta1
+apiVersion: karpenter.sh/v1
 kind: NodePool
 metadata:
   name: default
@@ -27,11 +27,11 @@ spec:
           operator: Gt
           values: ["2"]
       nodeClassRef:
-        apiVersion: karpenter.k8s.aws/v1beta1
+        group: karpenter.k8s.aws
         kind: EC2NodeClass
         name: custom-family
 ---
-apiVersion: karpenter.k8s.aws/v1beta1
+apiVersion: karpenter.k8s.aws/v1
 kind: EC2NodeClass
 metadata:
   name: custom-family

diff --git a/examples/v1beta1/general-purpose.yaml → examples/v1/general-purpose.yaml b/examples/v1beta1/general-purpose.yaml → examples/v1/general-purpose.yaml
@@ -1,6 +1,6 @@
 # This example NodePool will provision general purpose instances
 ---
-apiVersion: karpenter.sh/v1beta1
+apiVersion: karpenter.sh/v1
 kind: NodePool
 metadata:
   name: general-purpose
@@ -26,22 +26,23 @@ spec:
           operator: Gt
           values: ["2"]
       nodeClassRef:
-        apiVersion: karpenter.k8s.aws/v1beta1
+        group: karpenter.k8s.aws
         kind: EC2NodeClass
         name: default
 ---
-apiVersion: karpenter.k8s.aws/v1beta1
+apiVersion: karpenter.k8s.aws/v1
 kind: EC2NodeClass
 metadata:
   name: default
   annotations:
     kubernetes.io/description: "General purpose EC2NodeClass for running Amazon Linux 2 nodes"
 spec:
-  amiFamily: AL2 # Amazon Linux 2
   role: "KarpenterNodeRole-${CLUSTER_NAME}" # replace with your cluster name
   subnetSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
   securityGroupSelectorTerms:
     - tags:
         karpenter.sh/discovery: "${CLUSTER_NAME}" # replace with your cluster name
+  amiSelectorTerms:
+    - alias: al2023@latest # Amazon Linux 2023