[sonarr] use common chart (#122)

This commit is contained in:
ᗪєνιη ᗷυнʟ 2020-11-08 13:00:49 -05:00 committed by GitHub
parent aacd8ceac0
commit 5cfe91e0f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 120 additions and 81 deletions

View File

@ -1,31 +1,21 @@
apiVersion: v2 apiVersion: v2
name: sonarr appVersion: 3.0.4.993
description: Smart PVR for newsgroup and bittorrent users description: Smart PVR for newsgroup and bittorrent users
type: application name: sonarr
version: 6.0.2 version: 7.0.0
appVersion: 3.0.3.913
keywords: keywords:
- sonarr - sonarr
- torrent
- usenet
home: https://github.com/k8s-at-home/charts/tree/master/charts/media-common/sonarr home: https://github.com/k8s-at-home/charts/tree/master/charts/media-common/sonarr
icon: https://github.com/Sonarr/Sonarr/blob/phantom-develop/Logo/512.png?raw=true icon: https://github.com/Sonarr/Sonarr/blob/phantom-develop/Logo/512.png?raw=true
sources: sources:
- https://github.com/Sonarr/Sonarr - https://github.com/Sonarr/Sonarr
- https://hub.docker.com/r/linuxserver/sonarr - https://hub.docker.com/r/linuxserver/sonarr
maintainers: maintainers:
- name: DirtyCajunRice - name: billimek
email: nick@cajun.pro email: jeff@billimek.com
url: https://github.com/dirtycajunrice
dependencies: dependencies:
- name: media-common - name: common
repository: https://k8s-at-home.com/charts/ repository: https://k8s-at-home.com/charts/
version: ^1.0.0 version: ^1.0.4
alias: sonarr
annotations:
artifacthub.io/links: |
- name: App Source
url: https://github.com/Sonarr/Sonarr
- name: Default Docker Image
url: https://hub.docker.com/r/linuxserver/sonarr
artifacthub.io/maintainers: |
- name: Nicholas St. Germain
email: nick@cajun.pro

View File

@ -1,4 +1,4 @@
approvers: approvers:
- DirtyCajunRice - billimek
reviewers: reviewers:
- DirtyCajunRice - billimek

View File

@ -1,22 +1,82 @@
# Sonarr | Smart PVR for newsgroup and bittorrent users # Sonarr
Umbrella chart that
* Uses [media-common](https://github.com/k8s-at-home/charts/tree/master/charts/media-common) as a base
* Adds docker image information leveraging the [Linuxserver.io image](https://hub.docker.com/r/linuxserver/sonarr/)
* Deploys [Sonarr](https://github.com/sonarr/Sonarr)
## TL;DR This is a helm chart for [Sonarr](https://github.com/Sonarr/Sonarr).
```console
## TL;DR;
```shell
$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ $ helm repo add k8s-at-home https://k8s-at-home.com/charts/
$ helm install k8s-at-home/sonarr $ helm install k8s-at-home/sonarr
``` ```
## Installing the Chart ## Installing the Chart
To install the chart with the release name `sonarr`:
To install the chart with the release name `my-release`:
```console ```console
helm install sonarr k8s-at-home/sonarr helm install --name my-release k8s-at-home/sonarr
``` ```
## Upgrading ## Uninstalling the Chart
To uninstall/delete the `my-release` deployment:
```console
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](https://github.com/k8s-at-home/charts/blob/master/charts/sonarr/values.yaml)
file. It has several commented out suggested values.
Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options.
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```console
helm install sonarr \
--set sonarr.env.TZ="America/New York" \
k8s-at-home/sonarr
```
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the
chart. For example,
```console
helm install sonarr k8s-at-home/sonarr --values values.yaml
```
```yaml
image:
tag: ...
```
---
**NOTE**
If you get
```console
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 6.x.x to 7.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.
### Upgrading from 5.x.x to 6.x.x
Chart versions before 6.0.0 did not use media-common. Upgrading will require you to nest your values.yaml file under Chart versions before 6.0.0 did not use media-common. Upgrading will require you to nest your values.yaml file under
a top-level `sonarr:` key. a top-level `sonarr:` key.
@ -36,45 +96,3 @@ be subdirectories of, a single directory. If upgrading from an earlier version o
6. Update your settings in the app to point to the new PVC, which is mounted at /media. This can be done using Sonarr's 6. Update your settings in the app to point to the new PVC, which is mounted at /media. This can be done using Sonarr's
`Series Editor` under the `Series` tab. Simply select all series in your library, and use the editor to change the `Series Editor` under the `Series` tab. Simply select all series in your library, and use the editor to change the
`Root Folder` and hit save. `Root Folder` and hit save.
## Uninstalling the Chart
To uninstall the `sonarr` deployment:
```console
helm uninstall sonarr
```
The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration
Read through the media-common [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/media-common/values.yaml)
file. It has several commented out suggested values.
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```console
helm install sonarr \
--set sonarr.env.TZ="America/New York" \
k8s-at-home/sonarr
```
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the
chart. For example,
```console
helm install sonarr k8s-at-home/sonarr --values values.yaml
```
These values will be nested as it is a dependency, for example
```yaml
sonarr:
image:
tag: ...
```
---
**NOTE**
If you get
```console
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`.
---

View File

@ -0,0 +1,2 @@
ingress:
enabled: true

View File

@ -0,0 +1 @@
{{- include "common.notes.defaultNotes" . -}}

View File

@ -0,0 +1 @@
{{ include "common.all" . }}

View File

@ -1,10 +1,37 @@
# Default values for sonarr. # Default values for Sonarr.
sonarr:
image: image:
organization: linuxserver repository: linuxserver/sonarr
repository: sonarr
pullPolicy: IfNotPresent pullPolicy: IfNotPresent
tag: 3.0.3.913-ls40 tag: version-3.0.4.993
service: service:
port:
port: 8989 port: 8989
env: {}
# TZ: UTC
# PUID: 1001
# PGID: 1001
persistence:
config:
enabled: true
emptyDir: true
media:
enabled: true
emptyDir: true
mountPath: /media
## Persistent Volume Storage Class
## If defined, storageClassName: <storageClass>
## If set to "-", storageClassName: "", which disables dynamic provisioning
## If undefined (the default) or set to null, no storageClassName spec is
## set, choosing the default provisioner. (gp2 on AWS, standard on
## GKE, AWS & OpenStack)
# storageClass: "-"
# accessMode: ReadWriteOnce
# size: 1Gi
## Do not delete the pvc upon helm uninstall
# skipuninstall: false
# existingClaim: ""