shydefoo / helm-dep-checker

Dependency checker for umbrella helm charts to ensure that common dependencies get installed once.

Helm dependency checker

TLDR

• depchecker will construct a graph using the dependencies of helm charts, starting from a root helm chart. It will then search for overlapping dependencies (meaning deps that will be installed more than once if the umbrella chart is deployed).
• depchecker returns to stdout the changes needed to be made to each chart's Chart.yaml and values.yaml.
• When no changes need to be made, it will print

2022/09/24 19:40:54 main.go:38: SUCCESS, NO CHANGES REQUIRED

• Charts and subcharts are compared using the Chart Name or Alias

• Clone git repo

• Generate sample umbrella charts using:

cat << EOF > /tmp/helm_struct.json
{
  "root": [
    "a",
    "b",
    "d"
  ],
  "a": [
    "c",
    "d"
  ],
  "b": [
    "d"
  ],
  "c": [
    "e",
    "f"
  ],
  "d": [
    "f"
  ],
  "e": [],
  "f": []
}
EOF
go run pkg/cmd/chart-generator/chart-generator.go

• Run dep-checker on helm chart dir to see output

go run pkg/cmd/depchecker/depchecker.go -p ./test-charts/my-charts

• Sample output

Dependencies to add to a/Chart.yaml:
- name: f
  version: 0.1.0
  repository: file:///Users/shide.foo/repos/shide/caraml-dep-checker/test-charts/my-charts/f
  condition: f.enabled
  tags: []
  enabled: true
  importvalues: []
  alias: ""

Modify to a/values.yaml to contain:
c:
  f:
    enabled: false
d:
  f:
    enabled: false
f:
  enabled: true

Dependencies to add to root/Chart.yaml:
- name: f
  version: 0.1.0
  repository: file:///Users/shide.foo/repos/shide/caraml-dep-checker/test-charts/my-charts/f
  condition: f.enabled
  tags: []
  enabled: true
  importvalues: []
  alias: ""

Modify to root/values.yaml to contain:
a:
  d:
    enabled: false
  f:
    enabled: false
b:
  d:
    enabled: false
d:
  enabled: true
  f:
    enabled: false
f:
  enabled: true


exit status 1

• Modify the charts according to the output of the script