k3s-io / helm-controller

Apache License 2.0
391 stars 85 forks source link

Missing documentation for HelmChart and other API objects #212

Closed SohamG closed 1 year ago

SohamG commented 1 year ago

I couldn't find documentation for all the available/significant keys for kind: HelmChart. Currently the best way seems to be to read the source code

Possible fix is to flesh out the example manifest file with all possible keys (a la values.yml)

brandond commented 1 year ago

Have you seen: https://docs.k3s.io/helm#helmchart-field-definitions

SohamG commented 1 year ago

Oh, my apologies. I am using RKE2 (also from Rancher labs) and the docs there sent me here, and so did some cursory google searches. Perhaps that link deserves a place in the readme.

Closing

brandond commented 1 year ago

Rke2 docs also cover the fields, although they may not be as up to date with some new additions. https://docs.rke2.io/helm#helmchart-field-definitions