helm-charts/charts/other/app-template/README.md.gotmpl
2023-10-10 11:20:17 +02:00

46 lines
1.3 KiB
Go Template

{{- define "custom.helm.url" -}}
https://bjw-s.github.io/helm-charts/
{{- end -}}
{{ template "chart.header" . }}
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
{{ template "chart.description" . }}
{{ template "chart.sourcesSection" . }}
## Requirements
{{ template "chart.kubeVersionLine" . }}
## Dependencies
{{ template "chart.requirementsTable" . }}
## Installing the Chart
```bash
# Add the repository
helm repo add bjw-s {{template "custom.helm.url"}}
# Install the chart
helm install bjw-s app-template -f values.yaml
```
## Configuration
Read through the [values.yaml](../../library/common/values.yaml) file of the [common library](../../library/common/) chart. It has several commented out suggested values.
The [CI tests](../../library/common-test/ci) contain a number of scenarios that may prove useful as well.
## Upgrade instructions
Upgrade instructions can be found in the [documentation](https://bjw-s.github.io/helm-charts/docs/app-template/#upgrade-instructions).
## Support
- See the [Docs](http://bjw-s.github.io/helm-charts/docs/)
- Open an [issue](https://github.com/bjw-s/helm-charts/issues/new/choose)
- Join the k8s-at-home [Discord](https://discord.gg/k8s-at-home) community
{{ template "helm-docs.versionFooter" . }}