Skip to content

Commit

Permalink
docs: detail how to discover alias versions
Browse files Browse the repository at this point in the history
  • Loading branch information
@jmdeal
jmdeal committed Aug 28, 2024
1 parent c401593 commit edad17f
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 3 deletions.
26 changes: 25 additions & 1 deletion website/content/en/docs/concepts/nodeclasses.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -731,6 +731,30 @@ alias: [email protected]
```
The Windows family does not support pinning, so only `latest` is supported.

The following commands can be used to determine the versions availble for an alias in your region:

{{< tabpane text=true right=false >}}
{{% tab "AL2023" %}}
```bash
export K8S_VERSION="{{< param "latest_k8s_version" >}}"
aws ssm get-parameters-by-path --path "/aws/service/eks/optimized-ami/$K8S_VERSION/amazon-linux-2023/" --recursive | jq -cr '.Parameters[].Name' | grep -v "recommended" | awk -F '/' '{print $10}' | sed -r 's/.*(v[[:digit:]]+)$/\1/' | sort | uniq
```
{{% /tab %}}
{{% tab "AL2" %}}
```bash
export K8S_VERSION="{{< param "latest_k8s_version" >}}"
aws ssm get-parameters-by-path --path "/aws/service/eks/optimized-ami/$K8S_VERSION/amazon-linux-2/" --recursive | jq -cr '.Parameters[].Name' | grep -v "recommended" | awk -F '/' '{print $8}' | sed -r 's/.*(v[[:digit:]]+)$/\1/' | sort | uniq
```
{{% /tab %}}
{{% tab "Bottlerocket" %}}
```bash
export K8S_VERSION="{{< param "latest_k8s_version" >}}"
aws ssm get-parameters-by-path --path "/aws/service/bottlerocket/aws-k8s-$K8S_VERSION" --recursive | jq -cr '.Parameters[].Name' | grep -v "latest" | awk -F '/' '{print $7}' | sort | uniq
```
{{% /tab %}}
{{< /tabpane >}}


To select an AMI by name, use the `name` field in the selector term. To select an AMI by id, use the `id` field in the selector term. To select AMIs that are not owned by `amazon` or the account that Karpenter is running in, use the `owner` field - you can use a combination of account aliases (e.g. `self` `amazon`, `your-aws-account-name`) and account IDs.

If owner is not set for `name`, it defaults to `self,amazon`, preventing Karpenter from inadvertently selecting an AMI that is owned by a different account. Tags don't require an owner as tags can only be discovered by the user who created them.
Expand Down Expand Up @@ -1534,4 +1558,4 @@ NodeClasses have the following status conditions:
| AMIsReady | AMIs are discovered |
| Ready | Top level condition that indicates if the nodeClass is ready. If any of the underlying conditions is `False` then this condition is set to `False` and `Message` on the condition indicates the dependency that was not resolved. |

If a NodeClass is not ready, NodePools that reference it through their `nodeClassRef` will not be considered for scheduling.
If a NodeClass is not ready, NodePools that reference it through their `nodeClassRef` will not be considered for scheduling.
25 changes: 24 additions & 1 deletion website/content/en/preview/concepts/nodeclasses.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -731,6 +731,29 @@ alias: [email protected]
```
The Windows family does not support pinning, so only `latest` is supported.

The following commands can be used to determine the versions availble for an alias in your region:

{{< tabpane text=true right=false >}}
{{% tab "AL2023" %}}
```bash
export K8S_VERSION=1.30
aws ssm get-parameters-by-path --path "/aws/service/eks/optimized-ami/$K8S_VERSION/amazon-linux-2023/" --recursive | jq -cr '.Parameters[].Name' | grep -v "recommended" | awk -F '/' '{print $10}' | sed -r 's/.*(v[[:digit:]]+)$/\1/' | sort | uniq
```
{{% /tab %}}
{{% tab "AL2" %}}
```bash
export K8S_VERSION=1.30
aws ssm get-parameters-by-path --path "/aws/service/eks/optimized-ami/$K8S_VERSION/amazon-linux-2/" --recursive | jq -cr '.Parameters[].Name' | grep -v "recommended" | awk -F '/' '{print $8}' | sed -r 's/.*(v[[:digit:]]+)$/\1/' | sort | uniq
```
{{% /tab %}}
{{% tab "Bottlerocket" %}}
```bash
export K8S_VERSION=1.30
aws ssm get-parameters-by-path --path "/aws/service/bottlerocket/aws-k8s-$K8S_VERSION" --recursive | jq -cr '.Parameters[].Name' | grep -v "latest" | awk -F '/' '{print $7}' | sort | uniq
```
{{% /tab %}}
{{< /tabpane >}}

To select an AMI by name, use the `name` field in the selector term. To select an AMI by id, use the `id` field in the selector term. To select AMIs that are not owned by `amazon` or the account that Karpenter is running in, use the `owner` field - you can use a combination of account aliases (e.g. `self` `amazon`, `your-aws-account-name`) and account IDs.

If owner is not set for `name`, it defaults to `self,amazon`, preventing Karpenter from inadvertently selecting an AMI that is owned by a different account. Tags don't require an owner as tags can only be discovered by the user who created them.
Expand Down Expand Up @@ -1534,4 +1557,4 @@ NodeClasses have the following status conditions:
| AMIsReady | AMIs are discovered |
| Ready | Top level condition that indicates if the nodeClass is ready. If any of the underlying conditions is `False` then this condition is set to `False` and `Message` on the condition indicates the dependency that was not resolved. |

If a NodeClass is not ready, NodePools that reference it through their `nodeClassRef` will not be considered for scheduling.
If a NodeClass is not ready, NodePools that reference it through their `nodeClassRef` will not be considered for scheduling.
25 changes: 24 additions & 1 deletion website/content/en/v1.0/concepts/nodeclasses.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -731,6 +731,29 @@ alias: [email protected]
```
The Windows family does not support pinning, so only `latest` is supported.

The following commands can be used to determine the versions availble for an alias in your region:

{{< tabpane text=true right=false >}}
{{% tab "AL2023" %}}
```bash
export K8S_VERSION=1.30
aws ssm get-parameters-by-path --path "/aws/service/eks/optimized-ami/$K8S_VERSION/amazon-linux-2023/" --recursive | jq -cr '.Parameters[].Name' | grep -v "recommended" | awk -F '/' '{print $10}' | sed -r 's/.*(v[[:digit:]]+)$/\1/' | sort | uniq
```
{{% /tab %}}
{{% tab "AL2" %}}
```bash
export K8S_VERSION=1.30
aws ssm get-parameters-by-path --path "/aws/service/eks/optimized-ami/$K8S_VERSION/amazon-linux-2/" --recursive | jq -cr '.Parameters[].Name' | grep -v "recommended" | awk -F '/' '{print $8}' | sed -r 's/.*(v[[:digit:]]+)$/\1/' | sort | uniq
```
{{% /tab %}}
{{% tab "Bottlerocket" %}}
```bash
export K8S_VERSION=1.30
aws ssm get-parameters-by-path --path "/aws/service/bottlerocket/aws-k8s-$K8S_VERSION" --recursive | jq -cr '.Parameters[].Name' | grep -v "latest" | awk -F '/' '{print $7}' | sort | uniq
```
{{% /tab %}}
{{< /tabpane >}}

To select an AMI by name, use the `name` field in the selector term. To select an AMI by id, use the `id` field in the selector term. To select AMIs that are not owned by `amazon` or the account that Karpenter is running in, use the `owner` field - you can use a combination of account aliases (e.g. `self` `amazon`, `your-aws-account-name`) and account IDs.

If owner is not set for `name`, it defaults to `self,amazon`, preventing Karpenter from inadvertently selecting an AMI that is owned by a different account. Tags don't require an owner as tags can only be discovered by the user who created them.
Expand Down Expand Up @@ -1534,4 +1557,4 @@ NodeClasses have the following status conditions:
| AMIsReady | AMIs are discovered |
| Ready | Top level condition that indicates if the nodeClass is ready. If any of the underlying conditions is `False` then this condition is set to `False` and `Message` on the condition indicates the dependency that was not resolved. |

If a NodeClass is not ready, NodePools that reference it through their `nodeClassRef` will not be considered for scheduling.
If a NodeClass is not ready, NodePools that reference it through their `nodeClassRef` will not be considered for scheduling.

0 comments on commit edad17f

Please sign in to comment.