charts/charts/sabnzbd
2021-02-13 18:46:58 -05:00
..
templates [sabnzbd] use common chart (#125) 2020-11-09 07:22:51 -05:00
.helmignore [sabnzbd] add new chart (#290) 2020-07-25 13:35:57 -04:00
Chart.yaml bump charts to common v3 (#582) 2021-02-13 18:46:58 -05:00
OWNERS [multi-chart] bump charts to latest common library version (#192) 2020-11-23 16:20:41 +01:00
README.md [sabnzbd] add documentation on hostname-check (#321) 2020-12-08 13:15:55 -05:00
values.yaml bump charts to common v3 (#582) 2021-02-13 18:46:58 -05:00

Sabnzbd

This is a helm chart for Sabnzbd.

This chart is not maintained by the upstream project and any issues with the chart should be raised here

TL;DR;

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

Installing the Chart

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

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

IMPORTANT NOTE: when installing this chart for the first time you will get the follow message in your browser when trying to access Sabnzbd: Access denied - Hostname verification failed: sabnzbd.org/hostname-check

You can do one of two things to solve this issue:

  1. Update the sabnzbd.ini config file to your ingress name and/or loadBalancerIP to the host_whitelist field and restart the pod, or
  2. Forward the service to your local machine with kubectl port-forward service/sabnzbd -n default 8080:8080 and update the host_whitelist in the Sabnzbd Settings UI

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

Read through the charts values.yaml file. It has several commented out suggested values. Additionally you can take a look at the common library values.yaml for more (advanced) configuration options.

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

helm install sabnzbd \
  --set env.TZ="America/New_York" \
    k8s-at-home/sabnzbd

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

helm install sabnzbd k8s-at-home/sabnzbd --values values.yaml 
image:
  tag: ...

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.


Upgrading an existing Release to a new major version

A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions.

Upgrading from 2.x.x to 3.x.x

Due to migrating to a centralized common library some values in values.yaml have changed.

Examples:

  • service.port has been moved to service.port.port.
  • persistence.type has been moved to controllerType.

Refer to the library values.yaml for more configuration options.