mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-24 07:59:02 +00:00
5e98e3c4c5
* adguard-home to helm-docs * bitwanders to helm-docs * blocky to helm-docs * comcast to helm-docs * deconz to helm-docs * bump versions * remove trailing spaces * statping * digitalocean-dyndns * duplicate - helm-docs * icantbelieveitsnotvaletudo * intel-gpu-plugin to helm-docs * modem-stats to helm-docs * mosquitto helm-docs update * plex to helm-docs * powerdns to helm-docs * prometheus-nut-exporter to helm-docs * rtorrent-flood to helm docs * speedtest-prometheus to helm-docs * teslamate to helm-docs * traefik-forward-auth to helm-docs * uptimerobot-prometheus * common-test to helm-docs * version bump * fix traeffik version * Update links to docs Co-authored-by: angelnu <git@angelnucom>
117 lines
3.4 KiB
Markdown
117 lines
3.4 KiB
Markdown
# ${CHARTNAME}
|
|
|
|
 
|
|
|
|
${CHARTNAME} helm package
|
|
|
|
**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)**
|
|
|
|
## Source Code
|
|
|
|
* <https://github.com/${CHARTNAME}/${CHARTNAME}-docker>
|
|
* <https://github.com/k8s-at-home/charts/tree/master/charts/${CHARTNAME}>
|
|
|
|
## Requirements
|
|
|
|
Kubernetes: `>=1.16.0-0`
|
|
|
|
## Dependencies
|
|
|
|
| Repository | Name | Version |
|
|
|------------|------|---------|
|
|
| https://k8s-at-home.com/charts/ | common | 3.0.1 |
|
|
|
|
## TL;DR
|
|
|
|
```console
|
|
helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
|
helm repo update
|
|
helm install ${CHARTNAME} k8s-at-home/${CHARTNAME}
|
|
```
|
|
|
|
## Installing the Chart
|
|
|
|
To install the chart with the release name `${CHARTNAME}`
|
|
|
|
```console
|
|
helm install ${CHARTNAME} k8s-at-home/${CHARTNAME}
|
|
```
|
|
|
|
## Uninstalling the Chart
|
|
|
|
To uninstall the `${CHARTNAME}` deployment
|
|
|
|
```console
|
|
helm uninstall ${CHARTNAME}
|
|
```
|
|
|
|
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
|
|
## Configuration
|
|
|
|
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
|
|
```console
|
|
helm install ${CHARTNAME} \
|
|
--set env.TZ="America/New York" \
|
|
k8s-at-home/${CHARTNAME}
|
|
```
|
|
|
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
|
|
```console
|
|
helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} -f values.yaml
|
|
```
|
|
|
|
## Custom configuration
|
|
|
|
N/A
|
|
|
|
## Values
|
|
|
|
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|------|---------|-------------|
|
|
| env | object | `{}` | |
|
|
| image.pullPolicy | string | `"IfNotPresent"` | |
|
|
| image.repository | string | `"${CHARTNAME}/${CHARTNAME}"` | |
|
|
| image.tag | string | `"1.0.0"` | |
|
|
| ingress.enabled | bool | `false` | |
|
|
| service.port.port | int | `1880` | |
|
|
| strategy.type | string | `"Recreate"` | |
|
|
|
|
## Changelog
|
|
|
|
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog).
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
### [1.0.0]
|
|
|
|
#### Added
|
|
|
|
- N/A
|
|
|
|
#### Changed
|
|
|
|
- N/A
|
|
|
|
#### Removed
|
|
|
|
- N/A
|
|
|
|
[1.0.0]: #1.0.0
|
|
|
|
## Support
|
|
|
|
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
|
|
----------------------------------------------
|
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) |