helm-media-servarr

SABnzbd Helm Chart

This Helm chart installs SABnzbd, a program to download binary files from Usenet servers.

This README covers the basics of customising and installation

SABnzbd

Installation

Install this helm chart using the following command:

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

helm install sabnzbd media-servarr/sabnzbd

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/sabnzbd/

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 values
  - name: 'apiKey'
    value: 'apiKey'
  - name: 'nzbKey'
    value: 'nzbKey'

  # reference pre-existing Secret
  # - name: 'apiKey'
  #   ref: 'sabnzbd-api'
  # - name: 'nzbKey'
  #   ref: 'sabnzbd-api'
  # - name: 'newsreaderServerPassword'
  #   ref: 'sabnzbd-newsreader'

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

If setting up a ConfigMap, you can also store any newsreader server passwords here, for example

Application Configuration

By default, base configuration is defined using a ConfigMap - defined by default in ./values.yaml in application.config.

You can also add servers here, as shown under the [servers] block

application:
  port: 8080 # default UI port
  urlBase: 'sabnzbd' # default web base path
  config:
    contents: |
      [misc]
      language = en
      queue_limit = 20
      port = 8080
      api_key = $apiKey
      nzb_key = $nzbKey
      download_dir = Downloads/incomplete
      complete_dir = Downloads/complete
      # url_base = /sabnzbd # Set a base url
      # [servers]
      # [[yournewsreader.example.org]]
      # name = yournewsreader.example.org
      # displayname = yourNewsReader
      # host = yournewsreader.example.org
      # port = 563
      # username = username
      # password = $newsreaderServerPassword
      # connections = 8
      # ssl = 1
      # ssl_verify = 2
      # enable = 1
      # priority = 0

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

Only one volume is mounted by default:

For an external downloads volume, add a downloads volume and update download_dir / complete_dir in the config to point at it:

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

A PersistentVolumeClaim is provisioned for config by default. Any additional volumes you declare default to emptyDir: {} unless configured otherwise in your values.yaml.

persistentVolumeClaims:
  sabnzbd-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

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

Exportarr’s SABnzbd support authenticates with the nzb key (not the apiKey). The base chart’s default is to pass this chart’s apiKey, so for SABnzbd you must point metrics.apiref at the release’s nzbKey (or an equivalent Secret you manage):

metrics:
  enabled: true
  apiref:
    secret: '-sabnzbd'  # this chart's own Secret
    keyname: 'nzbKey'
  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 9707.

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 sabnzbd media-servarr/sabnzbd -f myvalues.yaml

Uninstallation

To uninstall/delete the sabnzbd deployment:

helm uninstall sabnzbd

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.