docs: add tool to generate instance type docs #1946
Merged
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. |
tzneal
force-pushed
the
add-instance-type-docs
branch
from
7a3d4f9 to
5a107ac
Compare
bwagner5
reviewed
Jun 16, 2022
| fmt.Fprintln(f, "<!-- this document is generated from hack/docs/instancetypes_gen_docs.go -->") | ||
| fmt.Fprintln(f, `AWS instance types offer varying resources and can be selected by labels. In particular the | ||
| ephemeral-storage is the default value for an AL2 family assuming no specific block device mappings have been configured.`) | ||
|
|
There was a problem hiding this comment.
Might be worth calling out the the resources have overhead taken out. Although it looks like ephemeral storage does not and maybe not CPU either? https://github.com/aws/karpenter/blob/205c4db5743f1f6824253e92304a5df2f875c90c/pkg/cloudprovider/aws/amifamily/al2.go#L94
Might also be worth calling out that pods are assuming the aws-eni-limited-pod-density = true
There was a problem hiding this comment.
SGTM. Good catch on overhead! I calculated the value with overhead subtracted and then ignored it 😆
Displays both labels and the resources that we use for bin-packing after overhead calculations.
tzneal
force-pushed
the
add-instance-type-docs
branch
from
5a107ac to
a5df3d8
Compare
bwagner5
approved these changes
Jun 16, 2022
This was referenced Jul 13, 2022
3 tasks
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 # 1329
Description
Displays both labels and the resources that we use for bin-packing after overhead calculations.
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.