charts/charts/stable/readarr
2021-06-17 22:16:41 +00:00
..
templates [meta] Split incubator / stable charts (#688) 2021-03-18 13:11:24 +01: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 v3.2.0 (#1031) 2021-06-17 18:16:03 -04:00
README_CHANGELOG.md.gotmpl [*arr] Migrate to common v3 (#969) 2021-06-10 14:40:31 -04:00
README_CONFIG.md.gotmpl [meta] Split incubator / stable charts (#688) 2021-03-18 13:11:24 +01:00
README.md Auto-generate chart README [no ci] 2021-06-17 22:16:41 +00:00
README.md.gotmpl [all] Regenerate docs 2021-06-01 12:47:34 +02:00
values.yaml [*arr] Migrate to common v3 (#969) 2021-06-10 14:40:31 -04:00

readarr

Version: 5.2.0 AppVersion: v0.1.0.715

A fork of Radarr to work with Books & AudioBooks

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 3.2.0

TL;DR

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

Installing the Chart

To install the chart with the release name readarr

helm install readarr k8s-at-home/readarr

Uninstalling the Chart

To uninstall the readarr deployment

helm uninstall readarr

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

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

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

Custom configuration

Readarr is still in early development, and this chart will install a nightly build of Readarr. See the project readme for more information. Take back-up's if you decide to use this on an existing library as the project is considered unstable

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.
env.TZ string "UTC" Set the container timezone
image.pullPolicy string "IfNotPresent" image pull policy
image.repository string "ghcr.io/k8s-at-home/readarr" image repository
image.tag string "v0.1.0.715" image tag
ingress.main object See values.yaml Enable and configure ingress settings for the chart under this key.
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.

5.0.0

Changed

  • BREAKING: Upgraded the common library dependency to version 3.0.2. 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.
  • Changed image tag to v0.1.0.715.

4.0.0

Changed

  • Breaking: swap linuxserver.io images for k8s@home image

1.0.0

Added

  • N/A

Changed

  • N/A

Removed

  • N/A

Support


Autogenerated from chart metadata using helm-docs v1.5.0