mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-24 16:09:08 +00:00
72 lines
2.3 KiB
Go Template
72 lines
2.3 KiB
Go Template
{{- define "repository.organization" -}}
|
|
k8s-at-home
|
|
{{- end -}}
|
|
|
|
{{- define "repository.url" -}}
|
|
https://github.com/k8s-at-home/charts
|
|
{{- end -}}
|
|
|
|
{{- define "helm.url" -}}
|
|
https://k8s-at-home.com/charts/
|
|
{{- end -}}
|
|
|
|
{{- define "helm.path" -}}
|
|
{{ template "repository.organization" . }}/{{ template "chart.name" . }}
|
|
{{- end -}}
|
|
{{- define "badge.artifactHub" -}}
|
|
[![ArtifactHub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/{{ template "chart.name" . }})](https://artifacthub.io/packages/helm/{{ template "chart.name" . }})
|
|
{{- end -}}
|
|
{{- define "description.multiarch" -}}
|
|
The default values and container images used in this chart will allow for running in a multi-arch cluster (amd64, arm, arm64)
|
|
{{- end -}}
|
|
|
|
{{- define "install.tldr" -}}
|
|
## TL;DR
|
|
```console
|
|
$ helm repo add {{ template "repository.organization" . }} {{ template "helm.url" . }}
|
|
$ helm install {{ template "helm.path" . }}
|
|
```
|
|
{{- end -}}
|
|
|
|
{{- define "install" -}}
|
|
## Installing the Chart
|
|
To install the chart with the release name `{{ template "chart.name" . }}`:
|
|
```console
|
|
helm install {{ template "chart.name" . }} {{ template "helm.path" . }}
|
|
```
|
|
{{- end -}}
|
|
|
|
{{- define "uninstall" -}}
|
|
## Uninstalling the Chart
|
|
To uninstall the `{{ template "chart.name" . }}` deployment:
|
|
```console
|
|
helm uninstall {{ template "chart.name" . }}
|
|
```
|
|
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
|
{{- end -}}
|
|
|
|
{{- define "configuration.header" -}}
|
|
## Configuration
|
|
{{- end -}}
|
|
|
|
{{- define "configuration.readValues" -}}
|
|
Read through the [values.yaml]({{ template "repository.url" . }}/blob/master/charts/{{ template "chart.name" . }}/values.yaml)
|
|
file. It has several commented out suggested values.
|
|
{{- end -}}
|
|
|
|
{{- define "configuration.example.set" -}}
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
|
```console
|
|
helm install {{ template "chart.name" . }} \
|
|
--set env.TZ="America/New York" \
|
|
{{ template "helm.path" . }}
|
|
```
|
|
{{- end -}}
|
|
|
|
{{- define "configuration.example.file" -}}
|
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
For example,
|
|
```console
|
|
helm install {{ template "chart.name" . }} {{ template "helm.path" . }} --values values.yaml
|
|
```
|
|
{{- end -}} |