History

Kjeld Schouten-Lebbing 17d52b7d1c Docs rework fase 2 (#182 ) * move faq to seperate file * Slight tweaking and adding license file(s) to wiki * Update README.md * Port git guide from UnityStation * Rename Ingress to Reverse Proxy Fixes #183 * Prefer central templates * Add initial information about Storage * Port Chart structure info from TrueNAS/charts readme * Create and document standardised Chart.yaml layout * update tautulli version * Add custom liveness probes for sonarr, radarr, lidarr and readarr * Add Maintainers Wanted page * Update existing Chart.yaml files		2021-02-25 17:09:50 +01:00
..
docs	777 on new scripts (+2 squashed commit)	2021-02-23 18:21:54 +01:00
templates	777 on new scripts (+2 squashed commit)	2021-02-23 18:21:54 +01:00
.helmignore	777 on new scripts (+2 squashed commit)	2021-02-23 18:21:54 +01:00
Chart.yaml	Docs rework fase 2 (#182 )	2021-02-25 17:09:50 +01:00
README.md	777 on new scripts (+2 squashed commit)	2021-02-23 18:21:54 +01:00
README.md.gotmpl	777 on new scripts (+2 squashed commit)	2021-02-23 18:21:54 +01:00
app-readme.md	777 on new scripts (+2 squashed commit)	2021-02-23 18:21:54 +01:00
app-readme.md.gotmpl	777 on new scripts (+2 squashed commit)	2021-02-23 18:21:54 +01:00
values.yaml	777 on new scripts (+2 squashed commit)	2021-02-23 18:21:54 +01: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.