|
| 1 | +{{- define "custom.repository.organization" -}} |
| 2 | + k8s-at-home |
| 3 | +{{- end -}} |
| 4 | + |
| 5 | +{{- define "custom.repository.url" -}} |
| 6 | + https://github.com/k8s-at-home/charts |
| 7 | +{{- end -}} |
| 8 | + |
| 9 | +{{- define "custom.helm.url" -}} |
| 10 | + https://k8s-at-home.com/charts/ |
| 11 | +{{- end -}} |
| 12 | + |
| 13 | +{{- define "custom.helm.path" -}} |
| 14 | + {{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} |
| 15 | +{{- end -}} |
| 16 | + |
| 17 | +{{- define "custom.notes" -}} |
| 18 | + **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** |
| 19 | +{{- end -}} |
| 20 | + |
| 21 | +{{- define "custom.requirements" -}} |
| 22 | + ## Requirements |
| 23 | + |
| 24 | + {{ template "chart.kubeVersionLine" . }} |
| 25 | +{{- end -}} |
| 26 | + |
| 27 | +{{- define "custom.dependencies" -}} |
| 28 | + ## Dependencies |
| 29 | + |
| 30 | + {{ template "chart.requirementsTable" . }} |
| 31 | +{{- end -}} |
| 32 | + |
| 33 | +{{- define "custom.install.tldr" -}} |
| 34 | + ## TL;DR |
| 35 | + |
| 36 | + ```console |
| 37 | + helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} |
| 38 | + helm repo update |
| 39 | + helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} |
| 40 | + ``` |
| 41 | +{{- end -}} |
| 42 | + |
| 43 | +{{- define "custom.install" -}} |
| 44 | + ## Installing the Chart |
| 45 | + |
| 46 | + To install the chart with the release name `{{ template "chart.name" . }}` |
| 47 | + |
| 48 | + ```console |
| 49 | + helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} |
| 50 | + ``` |
| 51 | +{{- end -}} |
| 52 | + |
| 53 | +{{- define "custom.uninstall" -}} |
| 54 | + ## Uninstalling the Chart |
| 55 | + |
| 56 | + To uninstall the `{{ template "chart.name" . }}` deployment |
| 57 | + |
| 58 | + ```console |
| 59 | + helm uninstall {{ template "chart.name" . }} |
| 60 | + ``` |
| 61 | + |
| 62 | + The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. |
| 63 | +{{- end -}} |
| 64 | + |
| 65 | +{{- define "custom.configuration.header" -}} |
| 66 | + ## Configuration |
| 67 | +{{- end -}} |
| 68 | + |
| 69 | +{{- define "custom.configuration.readValues" -}} |
| 70 | + Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. |
| 71 | + Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common). |
| 72 | +{{- end -}} |
| 73 | + |
| 74 | +{{- define "custom.configuration.example.set" -}} |
| 75 | + Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. |
| 76 | + |
| 77 | + ```console |
| 78 | + helm install {{ template "chart.name" . }} \ |
| 79 | + --set env.TZ="America/New York" \ |
| 80 | + {{ template "custom.helm.path" . }} |
| 81 | + ``` |
| 82 | +{{- end -}} |
| 83 | + |
| 84 | +{{- define "custom.configuration.example.file" -}} |
| 85 | + Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. |
| 86 | + |
| 87 | + ```console |
| 88 | + helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml |
| 89 | + ``` |
| 90 | +{{- end -}} |
| 91 | + |
| 92 | +{{- define "custom.valuesSection" -}} |
| 93 | + ## Values |
| 94 | + |
| 95 | + **Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common) |
| 96 | + |
| 97 | + {{ template "chart.valuesTable" . }} |
| 98 | +{{- end -}} |
| 99 | + |
| 100 | +{{- define "custom.support" -}} |
| 101 | + ## Support |
| 102 | + |
| 103 | + - See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) |
| 104 | + - Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) |
| 105 | + - Ask a [question](https://github.com/k8s-at-home/organization/discussions) |
| 106 | + - Join our [Discord](https://discord.gg/sTMX7Vh) community |
| 107 | +{{- end -}} |
| 108 | + |
| 109 | +{{ template "chart.header" . }} |
| 110 | + |
| 111 | +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} |
| 112 | + |
| 113 | +{{ template "chart.description" . }} |
| 114 | + |
| 115 | +{{ template "custom.notes" . }} |
| 116 | + |
| 117 | +{{ template "chart.sourcesSection" . }} |
| 118 | + |
| 119 | +{{ template "custom.requirements" . }} |
| 120 | + |
| 121 | +{{ template "custom.dependencies" . }} |
| 122 | + |
| 123 | +{{ template "custom.install.tldr" . }} |
| 124 | + |
| 125 | +{{ template "custom.install" . }} |
| 126 | + |
| 127 | +{{ template "custom.uninstall" . }} |
| 128 | + |
| 129 | +{{ template "custom.configuration.header" . }} |
| 130 | + |
| 131 | +{{ template "custom.configuration.readValues" . }} |
| 132 | + |
| 133 | +{{ template "custom.configuration.example.set" . }} |
| 134 | + |
| 135 | +{{ template "custom.configuration.example.file" . }} |
| 136 | + |
| 137 | +{{ template "custom.custom.configuration" . }} |
| 138 | + |
| 139 | +{{ template "custom.valuesSection" . }} |
| 140 | + |
| 141 | +{{ template "custom.changelog" . }} |
| 142 | + |
| 143 | +{{ template "custom.support" . }} |
| 144 | + |
| 145 | +{{ template "helm-docs.versionFooter" . }} |
0 commit comments