aws / karpenter-provider-aws

Karpenter is a Kubernetes Node Autoscaler built for flexibility, performance, and simplicity.
https://karpenter.sh
Apache License 2.0
6.89k stars 970 forks source link

Add information for the preference when using Karpenter surfaces environment variables and CLI parameters together. #7153

Open schakraw16 opened 2 months ago

schakraw16 commented 2 months ago

Description

How can the docs be improved? https://karpenter.sh/docs/reference/settings/#:~:text=output%20(default%20%3D%20stdout)-,MEMORY_LIMIT,-%2D%2Dmemory%2Dlimit

In this document , it's mentioned that the Karpenter global settings on the controllers. These settings can be done by either Environment Variable OR CLI. Request is to create information which one will be taken into preference when both are used in the controller


jmdeal commented 1 month ago

I'm actually wondering if we should be documenting the CLI flags as an option at all. They do exist, but given that we don't distribute the binary I wonder if this just leaves room for confusion. Personally, I think it would be reasonable to only document the environment variables / the helm values that configure them. Thoughts @jonathan-innis @njtran?

FWIW though, the CLI flags take precedence.

schakraw16 commented 1 month ago

@jmdeal - Agree with you , since it's always causing confusion to the end users and customer , though we got answer for the same by the replication.