search

rapidsai / frigate

Frigate is a tool for automatically generating documentation for your Helm charts
https://frigate.readthedocs.io
Other
83 stars 25 forks source link

Subcharts declared in subfolders under charts/ are ignored #49

Open consideRatio opened 2 years ago

consideRatio commented 2 years ago

Frigate currently only considers Chart.yaml declared dependencies, but ignores subcharts directly located under the charts/ folder. I don't run into issues about this, but it is a broken expectation on how frigate works if I would use frigate on a helm chart wish subcharts and not just chart dependencies.

https://github.com/rapidsai/frigate/blob/4153bf5d737894dd381402306456a7ba80d0de5f/frigate/gen.py#L58-L74

consideRatio commented 2 years ago

Note that subcharts under charts/ can be either .tgz files with a folder including a Chart.yaml, or directly folders with a Chart.yaml. Also, any .tgz file recognized to be associated with a dependency listed under Chart.yaml dependencies and to be of an outdated version, will be removed when helm dep up . is run (which is described in helm dep up --help).

ktaletsk commented 11 months ago

This behavior is a problem for me since I'm using Bitnami charts in my dependencies. They are packaged with a subchart in a charts/ folder, not as .tgz. This causes frigate to break.

For example, download Bitnami PostgreSQL chart: https://charts.jfrog.io/artifactory/api/helm/jfrog-charts/postgresql-13.1.0.tgz and then

frigate gen postgresql

produces the error:

FileNotFoundError: [Errno 2] No such file or directory: 'postgresql/charts/common-2.x.x.tgz'