helm-media-servarr

Readarr Helm Chart

[!WARNING] The Readarr project has been retired However, there is a third-party metadata service named rreading-glasses to allow you to continue to use this version

This Helm chart installs Readarr, a book collection manager, in a Kubernetes cluster.

This README covers the basics of customising and installation

• Installation
• Configuration
  • Secrets
  • Application Configuration
  • Volumes
  • Ingress
  • Metrics
  • Advanced
• Upgrading
• Uninstallation
• Support

Installation

Install this helm chart using the following command:

helm repo add media-servarr https://media-servarr.shw.al/charts

helm install readarr media-servarr/readarr

Pointing the host media-servarr.local to your kubernetes cluster will then allow you to access the application at the default location of http://media-servarr.local/readarr/

Configuration

Here are some examples of configuration you may want to override (and include in installation with -f myvalues.yaml).

Secrets

To set up secrets, like API keys, use the following format. Use openssl rand -hex 16 to generate a key and replace the default value.

secrets:
  # inline value
  - name: 'apiKey'
    value: 'your-api-key-here'
  # reference pre-existing Secret
  # - name: 'apiKey'
  #   ref: 'my-existing-secret'

When ref is set, the chart reads key name from the Secret named by ref in the same namespace.

By not setting this value, and leaving it blank, readarr will automatically generate a key on start.

Application Configuration

By default, base configuration is defined using a ConfigMap - defined by default in ./values.yaml in application.config. You can change values in the contents, such as the url base in your custom values.yaml

application:
  port: 8787 # default UI port
  urlBase: 'readarr' # default web base path
  config:
    filename: 'config.xml'
    contents: |
      <Config>
        ...
        <UrlBase>readarr</UrlBase>
        <ApiKey>$apiKey</ApiKey>
        <Port>8787</Port>
        ...
      </Config>
    secrets: [ 'apiKey' ]
    mountPath: '/config/config.xml'

You can prevent a ConfigMap being created and the configuration being managed as a kubernetes resource by defining the config as null. For example:

application:
  ...
  config: null

Volumes

Three volumes are available by default:

• config - General config data, where the sqlite database exists, for example
• downloads - Downloads folder for monitoring
• ebooks - Location of ebooks

deployment:
  ...
  volumes:
    config: # The key will be the volume name
      persistentVolumeClaim:
        claimName: 'readarr-config'
    downloads:
      nfs:
        server: 'fileserver.local'
        path: '/srv/downloads/'
    ebooks:
      nfs:
        server: 'fileserver.local'
        path: '/srv/media/ebooks/'

By default, a PersistentVolumeClaim will be provisioned for the config, but emptyDir: {} will be used for downloads, and ebooks, unless otherwise specified in your values.yaml

persistentVolumeClaims:
  readarr-config:
    accessMode: 'ReadWriteOnce'
    requestStorage: '1Gi'
    storageClassName: 'manual'
    # volumeName: 'existing-pv-name'  # optional: bind this PVC to a specific pre-existing PV
    selector:
      matchLabels:
        type: 'local'

Ingress

Ingress can be enabled, and you can customise the default host, path, and TLS settings:

ingress:
  enabled: true
  host: 'example.com'
  tls:
    # Your TLS settings...

Metrics

Since Readarr is retired, expect Exportarr’s Readarr support to receive no further updates. It may still work against the current release, but is unlikely to track future upstream changes.

Enabling metrics enables a sidecar container being attached for exportarr - and a ServiceMonitor CRD to be consumed by the kube-prometheus package.

By default, Exportarr reads the apiKey from this chart’s Secret. If you need Exportarr to read a different Secret/key, set metrics.apiref.

metrics:
  enabled: true
  apiref:
    secret: 'my-existing-secret'
    keyname: 'apiKey'
  env: []

It is recommended to install kube-prometheus chart first for the CRD to be supported. It is not included as a dependency by default in this package!

Unless changed with metrics.port.number you can then consume metrics over port 9705.

Advanced

Other supported deployment configuration include deployment.nodeSelector, deployment.tolerations, and deployment.affinity

You can also adjust container ports, environment variables (such as adding PGID and PUID) and define a serviceAccount.

Have a look at the parent charts default values.yaml for a comprehensive list of available config.

Upgrading

To upgrade the deployment:

helm upgrade readarr media-servarr/readarr -f myvalues.yaml

Uninstallation

To uninstall/delete the readarr deployment:

helm uninstall readarr

Support

For support, issues, or feature requests, please file an issue on the chart’s repository issue tracker.

This site is open source. Improve this page.