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

Creating new Karpenter FAQ #1016

Merged
merged 6 commits into from
Jan 14, 2022
Merged

Creating new Karpenter FAQ #1016

merged 6 commits into from
Jan 14, 2022

Conversation

chrisnegus
Copy link
Member

@chrisnegus chrisnegus commented Dec 17, 2021

1. Issue, if available:

2. Description of changes:
The first commit for this PR is the original Karpenter FAQ from the previous release that was dropped for v0.5. I'm starting with the old version so that you can see the changes I'm making going forward. This is a work in progress for now. Do not merge!

3. Does this change impact docs?

  • Yes, PR includes docs updates
  • Yes, issue opened: link to issue
  • No

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@chrisnegus chrisnegus self-assigned this Dec 17, 2021
@netlify
Copy link

netlify bot commented Dec 17, 2021

❌ Deploy Preview for karpenter-docs-prod failed.

🔨 Explore the source changes: 5298e5b

🔍 Inspect the deploy log: https://app.netlify.com/sites/karpenter-docs-prod/deploys/61e1e8515deb180008b84f42

@chrisnegus chrisnegus marked this pull request as draft December 17, 2021 19:20
@chrisnegus chrisnegus added the documentation Improvements or additions to documentation label Dec 17, 2021
@chrisnegus
Copy link
Member Author

/hold

@chrisnegus chrisnegus changed the title [WIP] Restoring original FAQ to update [WIP] Creating new Karpenter FAQ Dec 17, 2021
@chrisnegus
Copy link
Member Author

chrisnegus commented Dec 28, 2021

I added a bunch of questions to the FAQ, based on discussions with @rothgar . I put "NEEDS INFO" in a few places where I need some help. I cut some useful information from the section on Deprovisioning, but I plan to add content that is useful into the "Deprovisioning nodes" page.

@chrisnegus chrisnegus requested a review from ellistarn December 28, 2021 22:42
@olemarkus
Copy link
Contributor

Hm. Many of these questions will be manager specific. E.g upgrades works differently on kOps and Karpenter. Any thoughts on how to show these nuances?


## Upgrading
### How do I upgrade Karpenter?
!!! NEEDS INFO !!!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
!!! NEEDS INFO !!!
Karpenter is a controller that runs in your cluster, but it is not tied to a specific Kubernetes version like the cluster autoscaler is. It is recommended you use existing upgrade mechanisms you have to upgrade your core add-ons in Kubernetes to keep Karpenter upgraded to stay up to date on bug fixes and new features.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we provide an example? Do I re-apply the helm chart? Do I patch the deployment? Does it matter if I'm running the controller on EC2 or Fargate? Should I schedule during off-hours?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need more information here.


* Set the [ALB target type]({{< ref "https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.3/guide/ingress/annotations/#target-type" >}}) to IP mode for the pods
* Set [readiness gate]({{< ref "https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.3/deploy/pod_readiness_gate/" >}}) on the namespace.
The default is round robin at node level.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this depend on 1/ the TargetType and 2/ the traffic policy (cluster or local)?

@@ -0,0 +1,122 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm seeing a lot of AWS Specific FAQs in here. Can we scope this to AWS?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only 6 of the 27 questions explicitly call out AWS. I'm going to go through all the comments to get this doc in a sane state. Then we can talk through how we might change the scope.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the mean time, any time I find an FAQ question that is duplicated in the concepts section, I'll add a link to it from here. That should help reduce the amount of drift between the two docs.

Copy link
Member Author

@chrisnegus chrisnegus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've responded to all the comments I could at this point. If others agree, I'd like to have this merged and we can iterate on the published document.

@@ -0,0 +1,122 @@
---
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only 6 of the 27 questions explicitly call out AWS. I'm going to go through all the comments to get this doc in a sane state. Then we can talk through how we might change the scope.

website/content/en/docs/faq.md Show resolved Hide resolved
website/content/en/docs/faq.md Outdated Show resolved Hide resolved
website/content/en/docs/faq.md Outdated Show resolved Hide resolved
website/content/en/docs/faq.md Outdated Show resolved Hide resolved
website/content/en/docs/faq.md Show resolved Hide resolved
website/content/en/docs/faq.md Outdated Show resolved Hide resolved

## Upgrading
### How do I upgrade Karpenter?
!!! NEEDS INFO !!!
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need more information here.

website/content/en/docs/faq.md Outdated Show resolved Hide resolved
@@ -0,0 +1,122 @@
---
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the mean time, any time I find an FAQ question that is duplicated in the concepts section, I'll add a link to it from here. That should help reduce the amount of drift between the two docs.

@chrisnegus chrisnegus linked an issue Jan 14, 2022 that may be closed by this pull request
@geoffcline geoffcline marked this pull request as ready for review January 14, 2022 21:53
@geoffcline geoffcline changed the title [WIP] Creating new Karpenter FAQ Creating new Karpenter FAQ Jan 14, 2022
@chrisnegus
Copy link
Member Author

Hm. Many of these questions will be manager specific. E.g upgrades works differently on kOps and Karpenter. Any thoughts on how to show these nuances?

I removed the question that was specific to the Kubernetes upgrades.

@geoffcline geoffcline merged commit 6444f54 into aws:main Jan 14, 2022
@felix-zhe-huang
Copy link
Contributor

This merge breaks the webpage. The faq.md is using some wrong Ref path.

Screen Shot 2022-01-15 at 12 05 38 PM

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Restore the FAQs page to docs
8 participants