TrueChartsClone/.github/docs/development/common-libary.md

1.1 KiB

Common Library Chart

In Helm 3, their team introduced the concept of a Library chart.

A library chart is a type of Helm chart that defines chart primitives or definitions which can be shared by Helm templates in other charts. This allows users to share snippets of code that can be re-used across charts, avoiding repetition and keeping charts DRY.

The first version of our Common library was ported from k8s-at-home, which they introduced because they saw many charts requiring only a few select configuration options in their Helm charts.

Let's take for example, Sonarr, Sabnzbd, Overseerr. Each of these charts only require setting service, port, persistence, ingress and image since state and app configuration is handled by the application itself. In order to stay somewhat DRY (Don't Repeat Yourself) and keeping with Helm 3 usage for a Library chart, we saw this pattern and decided it was worth it for us to create a library. This means each one of these app charts has a dependency on what we call the common library.