Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CRD troubleshooting guide needs updating for Beta CRDs #5876

Open
jsamuel1 opened this issue Mar 15, 2024 · 4 comments
Open

CRD troubleshooting guide needs updating for Beta CRDs #5876

jsamuel1 opened this issue Mar 15, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@jsamuel1
Copy link
Contributor

Description

How can the docs be improved?
https://karpenter.sh/docs/troubleshooting/#helm-error-when-installing-the-karpenter-crd-chart

The CRD's in the examples in the troubleshooting guide are the Alpha names.
This guide should be updated to have the Beta (ec2nodeclasses/etc) crd names instead, for fast copy/paste troubleshooting.
@jsamuel1 jsamuel1 added documentation Improvements or additions to documentation needs-triage Issues that need to be triaged labels Mar 15, 2024
@jsamuel1
Copy link
Contributor Author

example 1 becomes:

kubectl label crd ec2nodeclasses.karpenter.k8s.aws nodepools.karpenter.sh nodeclaims.karpenter.sh app.kubernetes.io/managed-by=Helm --overwrite

@jsamuel1
Copy link
Contributor Author

example 2 becomes:

kubectl annotate crd ec2nodeclasses.karpenter.k8s.aws nodepools.karpenter.sh nodeclaims.karpenter.sh meta.helm.sh/release-name=karpenter-crd --overwrite
kubectl annotate crd aec2nodeclasses.karpenter.k8s.aws nodepools.karpenter.sh nodeclaims.karpenter.sh meta.helm.sh/release-namespace=karpenter --overwrite

@jonathan-innis
Copy link
Contributor

@jsamuel1 Would you be interested in opening a PR to make this change?

@jonathan-innis jonathan-innis removed the needs-triage Issues that need to be triaged label Mar 17, 2024
jsamuel1 added a commit to jsamuel1/karpenter-provider-aws that referenced this issue Mar 17, 2024
@jsamuel1
CRD troubleshooting guide needs updating for Beta CRDs aws#5876
a424cbe
@jsamuel1 jsamuel1 mentioned this issue Mar 17, 2024
Merged
jonathan-innis added a commit that referenced this issue Mar 20, 2024
@jsamuel1 @jonathan-innis
CRD troubleshooting guide needs updating for Beta CRDs #5876 (#5881)
46ec68e 
Co-authored-by: Jonathan Innis <[email protected]>
engedaam pushed a commit to engedaam/karpenter that referenced this issue Mar 21, 2024
@jsamuel1 @jonathan-innis @engedaam
CRD troubleshooting guide needs updating for Beta CRDs aws#5876 (aws#…
d354bc3 
…5881)

Co-authored-by: Jonathan Innis <[email protected]>
@luong-komorebi
Copy link

reminder: @jonathan-innis this issue can be closed as @jsamuel1 has made these changes to the repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jsamuel1 @luong-komorebi @jonathan-innis