mirror of https://github.com/k8s-at-home/charts.git synced 2025-01-31 05:49:04 +00:00

History

k8s-at-home[bot] f29865981e Auto-generate chart README [no ci]		2021-09-15 19:51:25 +00:00
..
ci	[chart] Update Helm chart common to v4 (#1115 )	2021-08-12 14:34:18 +02:00
templates	[transmission] use env config (#830 )	2021-04-25 15:14:18 -04:00
.helmignore	[meta] Split incubator / stable charts (#688 )	2021-03-18 13:11:24 +01:00
Chart.yaml	chore(deps): update helm chart common to v4.0.1 (#1204 )	2021-09-15 21:51:01 +02:00
README_CHANGELOG.md.gotmpl	[chart] Update Helm chart common to v4 (#1115 )	2021-08-12 14:34:18 +02:00
README_CONFIG.md.gotmpl	[transmission] use env config (#830 )	2021-04-25 15:14:18 -04:00
README.md	Auto-generate chart README [no ci]	2021-09-15 19:51:25 +00:00
README.md.gotmpl	[all] Regenerate docs	2021-06-01 12:47:34 +02:00
values.yaml	[chart] Update Helm chart common to v4 (#1115 )	2021-08-12 14:34:18 +02:00

README.md

transmission

Transmission is a cross-platform BitTorrent client

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://library-charts.k8s-at-home.com	common	4.0.1

TL;DR

helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install transmission k8s-at-home/transmission

Installing the Chart

To install the chart with the release name transmission

helm install transmission k8s-at-home/transmission

Uninstalling the Chart

To uninstall the transmission deployment

helm uninstall transmission

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 transmission \
  --set env.TZ="America/New York" \
    k8s-at-home/transmission

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.

helm install transmission k8s-at-home/transmission -f values.yaml

Custom configuration

To view more environment variables see here

Values

Important: When deploying an application Helm chart you can add more values from our common library chart here

Key	Type	Default	Description
env	object	See below	environment variables. See image docs for more details.
env.TRANSMISSION_DOWNLOAD_DIR	string	`"/downloads/complete"`	Torrent download directory
env.TRANSMISSION_INCOMPLETE_DIR	string	`"/downloads/incomplete"`	Incomplete download directory
env.TRANSMISSION_INCOMPLETE_DIR_ENABLED	bool	`false`	Enable incomplete download directory
env.TRANSMISSION_RPC_PASSWORD	string	`"CHANGEME"`	Password to access the Web UI
env.TRANSMISSION_WATCH_DIR	string	`"/watch"`	Watch directory
env.TRANSMISSION_WATCH_DIR_ENABLED	bool	`false`	Enable watch directory
env.TRANSMISSION_WEB_HOME	string	`"/web"`	Path in container where the Web UI is located
env.TZ	string	`"UTC"`	Set the container timezone
image.pullPolicy	string	`"IfNotPresent"`	image pull policy
image.repository	string	`"ghcr.io/k8s-at-home/transmission"`	image repository
image.tag	string	`"v3.00"`	image tag
ingress.main	object	See values.yaml	Enable and configure ingress settings for the chart under this key.
initContainers	object	See values.yaml	Use an initContainer to download the Flood web ui Set UI with env `TRANSMISSION_WEB_HOME` set to `/config/flood-for-transmission/`
persistence	object	See values.yaml	Configure persistence settings for the chart under this key.
probes	object	See values.yaml	Configures the probes for the main Pod.
service	object	See values.yaml	Configures service settings for the chart.

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.

8.0.0

Changed

Upgraded the common library dependency to version 4.0.0. This introduced (potentially) breaking changes to initContainers and additionalContainers. Be sure to check out the library chart for the up-to-date values.

7.0.0

Changed

BREAKING: Upgraded the common library dependency to version 3.2.0. This introduces several breaking changes (service, ingress and persistence keys have been refactored). Be sure to check out the library chart for the up-to-date values.