charts/charts/lidarr
2020-08-31 16:42:20 -04:00
..
templates Fix errors when ingress.labels is missing (#310) 2020-08-05 13:31:38 -04:00
.helmignore [lidarr] add new chart (#190) 2020-04-02 10:15:53 -04:00
Chart.yaml cleanup and bump appVersions (#22) 2020-08-31 16:42:20 -04:00
OWNERS [lidarr] add new chart (#190) 2020-04-02 10:15:53 -04:00
README.md mass-rename of chart repo (#3) 2020-08-29 11:22:37 -04:00
values.yaml cleanup and bump appVersions (#22) 2020-08-31 16:42:20 -04:00

lidarr music download client

This is a helm chart for lidarr leveraging the Linuxserver.io image

TL;DR;

$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
$ helm install k8s-at-home/lidarr

Installing the Chart

To install the chart with the release name my-release:

helm install --name my-release k8s-at-home/lidarr

Upgrading

Chart versions 1.0.1 and earlier used separate PVCs for Downloads and Music. This presented an issue where Lidarr would be unable to hard-link files between the /downloads and /music directories when importing media. This is caused because each PVC is exposed to the pod as a separate filesystem. This resulted in Lidarr copying files rather than linking; using additional storage without the user's knowledge.

This chart now uses a single PVC for Downloads and Music. This means all of your media (and downloads) must be in, or be subdirectories of, a single directory. If upgrading from an earlier version of the chart, do the following:

  1. Uninstall your current release
  2. On your backing store, organize your media, ie. media/music, media/downloads
  3. If using a pre-existing PVC, create a single new PVC for all of your media
  4. Refer to the configuration for updates to the chart values
  5. Re-install the chart
  6. Update your settings in the app to point to the new PVC, which is mounted at /media. This can be done using Lidarr's Mass Editor under the Library tab. Simply select all artists in your library, and use the editor to change the Root Folder and hit save.

Uninstalling the Chart

To uninstall/delete the my-release deployment:

helm delete my-release --purge

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following tables lists the configurable parameters of the Sentry chart and their default values.

Parameter Description Default
image.repository Image repository linuxserver/lidarr
image.tag Image tag. Possible values listed here. 0.7.1.1381-ls7
image.pullPolicy Image pull policy IfNotPresent
strategyType Specifies the strategy used to replace old Pods by new ones Recreate
timezone Timezone the lidarr instance should run as, e.g. 'America/New_York' UTC
puid process userID the lidarr instance should run as 1001
pgid process groupID the lidarr instance should run as 1001
probes.liveness.initialDelaySeconds Specify liveness initialDelaySeconds parameter for the deployment 60
probes.liveness.failureThreshold Specify liveness failureThreshold parameter for the deployment 5
probes.liveness.timeoutSeconds Specify liveness timeoutSeconds parameter for the deployment 10
probes.readiness.initialDelaySeconds Specify readiness initialDelaySeconds parameter for the deployment 60
probes.readiness.failureThreshold Specify readiness failureThreshold parameter for the deployment 5
probes.readiness.timeoutSeconds Specify readiness timeoutSeconds parameter for the deployment 10
Service.type Kubernetes service type for the lidarr GUI ClusterIP
Service.port Kubernetes port where the lidarr GUI is exposed 8686
Service.annotations Service annotations for the lidarr GUI {}
Service.labels Custom labels {}
Service.loadBalancerIP Loadbalance IP for the lidarr GUI {}
Service.loadBalancerSourceRanges List of IP CIDRs allowed access to load balancer (if supported) None
ingress.enabled Enables Ingress false
ingress.annotations Ingress annotations {}
ingress.labels Custom labels {}
ingress.path Ingress path /
ingress.hosts Ingress accepted hostnames chart-example.local
ingress.tls Ingress TLS configuration []
persistence.config.enabled Use persistent volume to store configuration data true
persistence.config.size Size of persistent volume claim 1Gi
persistence.config.existingClaim Use an existing PVC to persist data nil
persistence.config.storageClass Type of persistent volume claim -
persistence.config.accessMode Persistence access mode ReadWriteOnce
persistence.config.skipuninstall Do not delete the pvc upon helm uninstall false
persistence.media.enabled Use persistent volume to store configuration data true
persistence.media.size Size of persistent volume claim 10Gi
persistence.media.existingClaim Use an existing PVC to persist data nil
persistence.media.storageClass Type of persistent volume claim -
persistence.media.accessMode Persistence access mode ReadWriteOnce
persistence.media.skipuninstall Do not delete the pvc upon helm uninstall false
persistence.extraExistingClaimMounts Optionally add multiple existing claims []
resources CPU/Memory resource requests/limits {}
nodeSelector Node labels for pod assignment {}
tolerations Toleration labels for pod assignment []
affinity Affinity settings for pod assignment {}
podAnnotations Key-value pairs to add as pod annotations {}
deploymentAnnotations Key-value pairs to add as deployment annotations {}

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

helm install --name my-release \
  --set timezone="America/New York" \
    k8s-at-home/lidarr

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

helm install --name my-release -f values.yaml stable/lidarr

NOTE

If you get Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ... it may be because you uninstalled the chart with skipuninstall enabled, you need to manually delete the pvc or use existingClaim.


Read through the values.yaml file. It has several commented out suggested values.