karpenter icon indicating copy to clipboard operation
karpenter copied to clipboard

Add Karpenter High-Level Architecture Diagram

Open jonathan-innis opened this issue 1 year ago • 13 comments

Description

There have been a few requests from users to better understand how Karpenter runs under the hood and how the different controllers interact with each other. It might be nice to have a high-level architecture diagram that we could point users to when they ask how Karpenter works.

  • 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

jonathan-innis avatar Dec 19 '23 18:12 jonathan-innis

/kind documentation

jonathan-innis avatar Dec 19 '23 18:12 jonathan-innis

Some tips: https://www.k8s.dev/blog/2021/12/01/improve-your-documentation-with-mermaid.js-diagrams/

sftim avatar Dec 19 '23 19:12 sftim

and https://kubernetes.io/docs/contribute/style/diagram-guide/

sftim avatar Dec 19 '23 19:12 sftim

@jonathan-innis @sftim, I am interested in working on this issue but need guidance as I haven't gone through the code.

srijan-shukla avatar Dec 24 '23 20:12 srijan-shukla

@srijan-shukla and I discussed a bit offline. This one may be tough if you don't already have deep familiarity with the codebase. I'd recommend picking up some issues that fall under good-first-issues first to get better familiarity and then come back to this one after you've gotten your feet wet a bit.

jonathan-innis avatar Dec 26 '23 02:12 jonathan-innis

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Mar 25 '24 02:03 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle rotten
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot avatar Apr 24 '24 03:04 k8s-triage-robot

Thanks for the opportunity. I will be working on the architecture diagram

sanjeevrg89 avatar May 01 '24 17:05 sanjeevrg89

/assign @sanjeevrg89

jonathan-innis avatar May 01 '24 18:05 jonathan-innis

/lifecycle fresh

jonathan-innis avatar May 01 '24 18:05 jonathan-innis

/remove-lifecycle rotten

sftim avatar May 02 '24 11:05 sftim

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Jul 31 '24 11:07 k8s-triage-robot

/remove-lifecycle stale

jonathan-innis avatar Aug 19 '24 17:08 jonathan-innis