72 lines
2.3 KiB
Go Template
72 lines
2.3 KiB
Go Template
{{ define "chart.header" }}= {{ .Name }}
|
|
{{ end }}
|
|
{{ define "chart.versionBadge" }}
|
|
image::https://img.shields.io/badge/Version-{{ .Version | replace "-" "--" }}-informational?style=flat-square[Version: {{ .Version }}]{{end}}
|
|
{{ define "chart.typeBadge" }}
|
|
image::https://img.shields.io/badge/Version-{{ .Type }}-informational?style=flat-square[Type: {{ .Type }}]{{end}}
|
|
{{ define "chart.appVersionBadge" }}{{- if (ne .AppVersion "") }}
|
|
image::https://img.shields.io/badge/AppVersion-{{ .AppVersion }}-informational?style=flat-square[AppVersion: {{ .AppVersion }}]{{ end }}{{end}}
|
|
{{ define "chart.maintainersHeader" }}== Maintainers{{ end }}
|
|
{{ define "chart.maintainersTable" }}.Maintainers
|
|
|===
|
|
| Name | Email | Url
|
|
{{- range .Maintainers }}
|
|
|
|
| {{ .Name }}
|
|
| {{ if .Email }}<{{ .Email }}>{{ end }}
|
|
| {{ if .Url }}<{{ .Url }}>{{ end }}
|
|
{{- end }}
|
|
|===
|
|
{{ end }}
|
|
{{ define "chart.valuesHeader" }}== Values{{ end }}
|
|
{{ define "chart.valuesTable" }}.Values
|
|
|===
|
|
| Key | Type | Default | Description
|
|
{{- range .Values }}
|
|
|
|
| {{ .Key }}
|
|
| {{ .Type }}
|
|
| {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }}
|
|
| {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }}
|
|
{{- end }}
|
|
|===
|
|
{{ end }}
|
|
|
|
{{- define "chart.prerequirements" -}}{{- end -}}
|
|
|
|
{{ template "chart.header" . }}
|
|
{{ template "chart.deprecationWarning" . }}
|
|
|
|
{{ template "chart.badgesSection" . }}
|
|
{{ template "chart.maintainersSection" . }}
|
|
|
|
{{ template "chart.prerequirements" . }}
|
|
|
|
== Usage
|
|
|
|
Helm must be installed and setup to your kubernetes cluster to use the charts.
|
|
Refer to Helm's https://helm.sh/docs[documentation] to get started.
|
|
Once Helm has been set up correctly, fetch the charts as follows:
|
|
|
|
[source,bash]
|
|
----
|
|
helm pull oci://codeberg.org/wrenix/helm-charts/{{ template "chart.name" . }}
|
|
----
|
|
|
|
You can install a chart release using the following command:
|
|
|
|
[source,bash]
|
|
----
|
|
helm install {{ template "chart.name" . }}-release oci://codeberg.org/wrenix/helm-charts/{{ template "chart.name" . }} --values values.yaml
|
|
----
|
|
|
|
To uninstall a chart release use `helm`'s delete command:
|
|
|
|
[source,bash]
|
|
----
|
|
helm uninstall {{ template "chart.name" . }}-release
|
|
----
|
|
|
|
{{ template "chart.valuesSection" . }}
|
|
|
|
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]
|