37 lines
3.1 KiB
Markdown
37 lines
3.1 KiB
Markdown
# Lulz Ltd Common Library Chart
|
|
|
|
A [Helm Library Chart](https://helm.sh/docs/topics/library_charts/#helm) for grouping common logic between charts.
|
|
|
|
## Introduction
|
|
|
|
This chart provides a common template helpers which can be used to develop new charts using [Helm](https://helm.sh) package manager.
|
|
|
|
## Parameters
|
|
|
|
The following table lists the helpers available in the library which are scoped in different sections.
|
|
|
|
### Labels
|
|
|
|
| Helper identifier | Description | Expected Input |
|
|
|-----------------------------|-----------------------------------------------------------------------------|-------------------|
|
|
| `common.labels.matchLabels` | Labels to use on `deploy.spec.selector.matchLabels` and `svc.spec.selector` | `.` Chart context |
|
|
| `common.labels.standard` | Return Kubernetes standard labels | `.` Chart context |
|
|
|
|
### Names
|
|
|
|
| Helper identifier | Description | Expected Input |
|
|
|-----------------------------------|-----------------------------------------------------------------------|-------------------|
|
|
| `common.names.chart` | Chart name plus version | `.` Chart context |
|
|
| `common.names.fullname` | Create a default fully qualified app name. | `.` Chart context |
|
|
| `common.names.fullname.namespace` | Create a fully qualified app name adding the installation's namespace | `.` Chart context |
|
|
| `common.names.name` | Expand the name of the chart or use `.Values.nameOverride` | `.` Chart context |
|
|
| `common.names.namespace` | Allow the release namespace to be overridden | `.` Chart context |
|
|
|
|
### TplValues
|
|
|
|
| Helper identifier | Description | Expected Input |
|
|
|------------------------------------|---------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `common.tplvalues.render` | Renders a value that contains template | `dict "value" .Values.path.to.the.Value "context" $`, value is the value should rendered as template, context frequently is the chart context `$` or `.` |
|
|
| `common.tplvalues.merge` | Merge a list of values that contains template after rendering them. | `dict "values" (list .Values.path.to.the.Value1 .Values.path.to.the.Value2) "context" $` |
|
|
| `common.tplvalues.merge-overwrite` | Merge a list of values that contains template after rendering them. | `dict "values" (list .Values.path.to.the.Value1 .Values.path.to.the.Value2) "context" $` |
|