docs: document use of Lt/Gt #2467
Merged
+360
−324
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for karpenter-docs-prod ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| @@ -289,6 +289,35 @@ Specify AMIs explicitly by ID: | |||
|
|
|||
| Prior to the introduction of `spec.providerRef`, parameters for the AWS Cloud Provider could be specified within the Provisioner itself through the `spec.provider` field. This field in the Provisioners has now been deprecated, and all fields previously specified through the ProvisionerSpec can now be specified in the `AWSNodeTemplate` CRD instead. See the [upgrade guide for more information](../../upgrade-guide). New parameters can only be specified in the `AWSNodeTemplate` CRD. | |||
|
|
|||
| ## AWS Specific Labels | |||
|
|
|||
| The AWS cloud provider adds several labels to nodes that describe the node resources to make filtering instance types easier. These work at either the provisioner level as requirements or the pod level as node selectors or node affinities. The complete list and which instance type they are applied to are available in the [Instance Types](../instance-types/) documentation. A sampling of these include: | |||
There was a problem hiding this comment.
Suggested change
| The AWS cloud provider adds several labels to nodes that describe the node resources to make filtering instance types easier. These work at either the provisioner level as requirements or the pod level as node selectors or node affinities. The complete list and which instance type they are applied to are available in the [Instance Types](../instance-types/) documentation. A sampling of these include: | |
| The AWS cloud provider adds several labels to nodes that describe the node resources to make filtering instance types easier. These work at either the provisioner level as requirements or the pod level as node selectors or node affinities. The complete list, including the instance types they are applied to, is available in the [Instance Types](../instance-types/) documentation. A sampling of these include: | |
| - `karpenter.k8s.aws/instance-memory` | ||
| - `karpenter.k8s.aws/instance-gpu-name` | ||
|
|
||
| The `karpenter.k8s.aws/instance-cpu` and `karpenter.k8s.aws/instance-memory` values are numeric which also allows constructing requirements for them using the `Gt` and `Lt` operators. The standard rules for `Gt` and `Lt` apply, there can be only one value and it must be an integer. This can be useful to select nodes of a particular "shape". For example the following filters out all instance types with more than 8 CPUs or more than 16 GiB of memory: |
There was a problem hiding this comment.
Suggested change
| The `karpenter.k8s.aws/instance-cpu` and `karpenter.k8s.aws/instance-memory` values are numeric which also allows constructing requirements for them using the `Gt` and `Lt` operators. The standard rules for `Gt` and `Lt` apply, there can be only one value and it must be an integer. This can be useful to select nodes of a particular "shape". For example the following filters out all instance types with more than 8 CPUs or more than 16 GiB of memory: | |
| The `karpenter.k8s.aws/instance-cpu` and `karpenter.k8s.aws/instance-memory` values are numeric which allows constructing requirements using the `Gt` and `Lt` operators. | |
| The following standard rules for `Gt` and `Lt` apply: | |
| 1. There can be only one value in the requirement | |
| 2. The value must be an integer | |
| These requirements can be useful to select nodes of a particular "shape". For example the following filters out all instance types with more than 8 CPUs or more than 16 GiB of memory: | |
tzneal
force-pushed
the
document-lt-gt
branch
from
b8fc139 to
0365d69
Compare
Document and show some examples of using the AWS specific labels, specifically using Lt/Gt. Fixes aws#2456
tzneal
force-pushed
the
document-lt-gt
branch
from
0365d69 to
c9cbe6e
Compare
|
Hide whitespace on diff, I changed the fileformat to Unix style. |
| 1. There can be only one value in the requirement | ||
| 2. The value must be an integer | ||
|
|
||
| These requirements can be useful to select nodes of a particular "shape". For example the following filters out all instance types with more than 8 CPUs or more than 16 GiB of memory:: |
There was a problem hiding this comment.
Suggested change
| These requirements can be useful to select nodes of a particular "shape". For example the following filters out all instance types with more than 8 CPUs or more than 16 GiB of memory:: | |
| These requirements can be useful to select nodes of a particular "shape". For example the following filters out all instance types with more than 8 CPUs or more than 16 GiB of memory: |
| Karpenter supports accelerators, such as GPUs. | ||
|
|
||
|
|
||
| Additionally, include a resource requirement in the workload manifest. This will cause the GPU dependent pod will be scheduled onto the appropriate node. |
There was a problem hiding this comment.
Suggested change
| Additionally, include a resource requirement in the workload manifest. This will cause the GPU dependent pod will be scheduled onto the appropriate node. | |
| Additionally, include a resource requirement in the workload manifest. This will cause the GPU dependent pod to be scheduled onto the appropriate node. |
| Select AMIs by an arbitrary AWS tag key/value pair: | ||
| ``` | ||
| amiSelector: | ||
| MySubnetTag: value |
There was a problem hiding this comment.
@tzneal
subnet, for AMI?!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2456
Description
Document and show some examples of using the AWS specific labels,
specifically using Lt/Gt.
How was this change tested?
Does this change impact docs?
Release Note
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.