mirror of https://github.com/k8s-at-home/charts.git synced 2025-01-23 15:39:02 +00:00

History

Vegetto 5e98e3c4c5 [helm-docs] Use helm docs for all charts [ci-skip] (#646 ) * 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>		2021-03-08 10:36:06 -05:00
..
templates	[template] Move template chart to outer folder (#518 )	2021-01-26 20:31:43 +01:00
.helmignore	Add Helm Docs (#595 )	2021-02-17 17:43:56 -05:00
Chart.yaml	Update Helm chart common to v3.1.0 (#633 )	2021-03-01 08:20:39 +01:00
README_CHANGELOG.md.gotmpl	Add Helm Docs (#595 )	2021-02-17 17:43:56 -05:00
README_CONFIG.md.gotmpl	Add Helm Docs (#595 )	2021-02-17 17:43:56 -05:00
README.md	[helm-docs] Use helm docs for all charts [ci-skip] (#646 )	2021-03-08 10:36:06 -05:00
README.md.gotmpl	[helm-docs] Use helm docs for all charts [ci-skip] (#646 )	2021-03-08 10:36:06 -05:00
values.yaml	bump charts to common v3 (#582 )	2021-02-13 18:46:58 -05:00

README.md

${CHARTNAME}

${CHARTNAME} helm package

This chart is not maintained by the upstream project and any issues with the chart should be raised here

Source Code

Requirements

Kubernetes: >=1.16.0-0

Dependencies

Repository	Name	Version
https://k8s-at-home.com/charts/	common	3.0.1

TL;DR

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}

helm install ${CHARTNAME} k8s-at-home/${CHARTNAME}

Uninstalling the Chart

To uninstall the ${CHARTNAME} deployment

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 file. It has several commented out suggested values. Other values may be used from the values.yaml from the common library.

Specify each parameter using the --set key=value[,key=value] argument to helm install.

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.

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

Key	Type	Default
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.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.