[Feature Request] Restructuring and introducion best practices for the helm chart

kubeovn / kube-ovn

A Bridge between SDN and Cloud Native (Project under CNCF)

https://kubeovn.github.io/docs/stable/en/

Apache License 2.0

1.99k stars 450 forks source link

[Feature Request] Restructuring and introducion best practices for the helm chart #4330

Open oujonny opened 4 months ago

oujonny commented 4 months ago

Description

Currently, the helm chart is quite a mess in my point of view. Mostly it is about the structure and naming of all the values.

I suggest the following improvements:

define all variables in lowerCamelCase
combine all configuration-related vars into one map (to access later for example ".Values.config.logDir" )
introduce variables for all the Kubernetes-related things for each component (image, labels, annotations, strategy, affinities etc..)
Document the variables with helm-docs

In general, I'm a big fan of the charts from Bitnami or Grafana for example.

I'm open to contribute those improvements with a PR :)

Who will benefit from this feature?

Everyone who uses helm for the installation.

Anything else?

No response

oilbeater commented 4 months ago

@oujonny Thanks, looking forward to you contribution!

github-actions[bot] commented 2 months ago

Issues go stale after 60d of inactivity. Please comment or re-open the issue if you are still interested in getting this issue fixed.

oujonny commented 2 months ago

Thank's to @SkalaNetworks the PR for this issue is in progress. I will keep the issue until it get's merged.

SkalaNetworks commented 2 months ago

I recommend starting to use it to see the limitations. I made the Helm chart follow most standards, but there's still some old keys that need to be refactored. Ideally, as it is the case for Cilium, the Helm chart becomes the main installation method and replaces the bash script install entirely. I'm using my branch in production and so far so good. I implemented some stuff that isn't native to the current Helm Chart, like NAD creation.

SkalaNetworks commented 2 months ago

God I just noticed I replaced all the selectorLabels with standard Kubernetes selector labels documented in the well-known list. This is cleaner in practice, but I just noticed the CLI plugin for Kube-OVN relies on them and now it doesn't work :)

github-actions[bot] commented 1 day ago

Issues go stale after 60d of inactivity. Please comment or re-open the issue if you are still interested in getting this issue fixed.