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.

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

Clearer Install Instructions, Including for existing EKS Clusters #7452

Open
antmatts opened this issue Nov 27, 2024 · 2 comments
Open

Clearer Install Instructions, Including for existing EKS Clusters #7452

antmatts opened this issue Nov 27, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good-first-issue Good for newcomers

Comments

@antmatts
Copy link

Description

How can the docs be improved?
While trying to install Karpenter in a recently created EKS cluster, I'm finding conflicting installation instructions that I feel could be better clarified as I'm have to reference multiple guides just to install Karpenter and I'm unsure what is correct and still valid.

  • Currently, there are only two sets of instructions provided on how to install Karpenter, Getting Started with Karpenter and Migrating from Cluster Autoscaler. However, I'm just trying to install Karpenter on an existing EKS cluster where Cluster Autoscaler has never been installed. The Getting Started with Karpenter guide won't work as it assumes you are creating a new cluster from scratch and the eksctl command provided will fail if the cluster already exits. That leaves the Migrating from Cluster Autoscaler guide, which seems counter as I'm not migrating away from Cluster Autoscaler.
  • Step 6 of the v1 Migration Upgrade Procedure Guide references # Service account annotation can be dropped when using pod identity; however, neither of the Getting Started guides references this and still directs you to use/update the aws-auth ConfigMap. This should be included in Getting Started as this can be setup from the start and doesn't require an upgrade to implement (3. Create a Cluster and Update aws-auth ConfigMap).
  • Getting Started with Karpenter | Deploy Karpenter only provides guidance on installing Karpenter by making a local copy of the Karpenter Manifest and modifying it to specify an existing NodeGroup to use. Uncertain why there are no instructions on how to also install Karpenter using Helm like Getting Started with Karpenter | Install Karpenter; and an alternative method to use a Fargate Profile instead of existing NodeGroup if there aren't any. I also noticed the following kubectl create commands are failing on a new 1.31 EKS cluster as the resources already exist so they can't be created again:
kubectl create -f \
    "https://raw.githubusercontent.com/aws/karpenter-provider-aws/v${KARPENTER_VERSION}/pkg/apis/crds/karpenter.sh_nodepools.yaml"
kubectl create -f \
    "https://raw.githubusercontent.com/aws/karpenter-provider-aws/v${KARPENTER_VERSION}/pkg/apis/crds/karpenter.k8s.aws_ec2nodeclasses.yaml"
kubectl create -f \
    "https://raw.githubusercontent.com/aws/karpenter-provider-aws/v${KARPENTER_VERSION}/pkg/apis/crds/karpenter.sh_nodeclaims.yaml"

I instead ran them as kubectl apply to update the existing resources as I'm unable to validate what versions are included with EKS 1.31 by default.

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment
@antmatts antmatts added documentation Improvements or additions to documentation needs-triage Issues that need to be triaged labels Nov 27, 2024
@jonathan-innis jonathan-innis added good-first-issue Good for newcomers and removed needs-triage Issues that need to be triaged labels Dec 10, 2024
@jonathan-innis
Copy link
Contributor

@antmatts We'd love help getting our docs more up-to-date. In general, given the issues that come in and the features that we are working on, it's tough for us to keep-up with it all. We'd love help making our docs clearer so if you have something that you want to propose a change for, I'd recommend opening a PR!

@antmatts
Copy link
Author

@jonathan-innis I've been fighting to get this setup on an existing cluster, but finally got it working. Making some notes and can help put something together. Just to confirm, what do you mean by PR in this context?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good-first-issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants