search

kubernetes-sigs / karpenter

Karpenter is a Kubernetes Node Autoscaler built for flexibility, performance, and simplicity.
Apache License 2.0
616 stars 205 forks source link

Add Karpenter High-Level Architecture Diagram #894

Open jonathan-innis opened 10 months ago

jonathan-innis commented 10 months ago

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.

jonathan-innis commented 10 months ago

/kind documentation

sftim commented 10 months ago

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

sftim commented 10 months ago

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

srijan-shukla commented 10 months ago

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

jonathan-innis commented 10 months ago

@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.

k8s-triage-robot commented 7 months ago

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

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

You can:

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

/lifecycle stale

k8s-triage-robot commented 6 months ago

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:

You can:

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

/lifecycle rotten

sanjeevrg89 commented 6 months ago

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

jonathan-innis commented 6 months ago

/assign @sanjeevrg89

jonathan-innis commented 6 months ago

/lifecycle fresh

sftim commented 6 months ago

/remove-lifecycle rotten

k8s-triage-robot commented 3 months ago

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

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

You can:

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

/lifecycle stale

jonathan-innis commented 2 months ago

/remove-lifecycle stale