From 4566fda5eab3296f3fb902e8b50abdb229a19b27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E1=97=AA=D1=94=CE=BD=CE=B9=CE=B7=20=E1=97=B7=CF=85=D0=BD?= =?UTF-8?q?=CA=9F?= Date: Mon, 9 Nov 2020 07:19:00 -0500 Subject: [PATCH] [ombi] use common chart (#126) * ombi: use common chart * remove app name in app.env example --- charts/ombi/.helmignore | 23 +++++++++ charts/ombi/Chart.yaml | 31 +++++-------- charts/ombi/OWNERS | 4 +- charts/ombi/README.md | 77 +++++++++++++++---------------- charts/ombi/ci/ct-values.yaml | 2 + charts/ombi/templates/NOTES.txt | 1 + charts/ombi/templates/common.yaml | 1 + charts/ombi/values.yaml | 26 +++++++---- 8 files changed, 96 insertions(+), 69 deletions(-) create mode 100644 charts/ombi/.helmignore create mode 100644 charts/ombi/ci/ct-values.yaml create mode 100644 charts/ombi/templates/NOTES.txt create mode 100644 charts/ombi/templates/common.yaml diff --git a/charts/ombi/.helmignore b/charts/ombi/.helmignore new file mode 100644 index 00000000..46fd8996 --- /dev/null +++ b/charts/ombi/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +# OWNERS file for Kubernetes +OWNERS diff --git a/charts/ombi/Chart.yaml b/charts/ombi/Chart.yaml index 124c0520..978841d5 100644 --- a/charts/ombi/Chart.yaml +++ b/charts/ombi/Chart.yaml @@ -1,31 +1,24 @@ apiVersion: v2 -name: ombi +appVersion: 4.0.681 description: Want a Movie or TV Show on Plex or Emby? Use Ombi! -type: application -version: 4.0.2 -appVersion: 4.0.471 +name: ombi +version: 5.0.0 keywords: - ombi + - plex + - emby + - sonarr + - radarr + - couchpotato home: https://github.com/k8s-at-home/charts/tree/master/charts/ombi icon: https://github.com/tidusjar/Ombi/blob/feature/v4/src/Ombi/wwwroot/images/ms-icon-310x310.png?raw=true sources: - https://github.com/tidusjar/Ombi - https://hub.docker.com/r/linuxserver/ombi maintainers: - - name: DirtyCajunRice - email: nick@cajun.pro - url: https://github.com/dirtycajunrice + - name: billimek + email: jeff@billimek.com dependencies: - - name: media-common + - name: common repository: https://k8s-at-home.com/charts/ - version: ^1.0.0 - alias: ombi -annotations: - artifacthub.io/links: | - - name: App Source - url: https://github.com/tidusjar/Ombi - - name: Default Docker Image - url: https://hub.docker.com/r/linuxserver/ombi - artifacthub.io/maintainers: | - - name: Nicholas St. Germain - email: nick@cajun.pro + version: ^1.0.4 diff --git a/charts/ombi/OWNERS b/charts/ombi/OWNERS index 2eb39f10..b90909f4 100644 --- a/charts/ombi/OWNERS +++ b/charts/ombi/OWNERS @@ -1,4 +1,4 @@ approvers: -- DirtyCajunRice +- billimek reviewers: -- DirtyCajunRice +- billimek diff --git a/charts/ombi/README.md b/charts/ombi/README.md index a0f97813..e07dc1fb 100644 --- a/charts/ombi/README.md +++ b/charts/ombi/README.md @@ -1,70 +1,52 @@ -# Ombi | Want a Movie or TV Show on Plex or Emby? Use Ombi! -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/ombi/) -* Deploys [Ombi](https://github.com/tidusjar/Ombi) +# Ombi -## TL;DR -```console +This is a helm chart for [Ombi](https://github.com/tidusjar/Ombi). + +## TL;DR; + +```shell $ helm repo add k8s-at-home https://k8s-at-home.com/charts/ $ helm install k8s-at-home/ombi ``` ## Installing the Chart -To install the chart with the release name `ombi`: + +To install the chart with the release name `my-release`: + ```console -helm install ombi k8s-at-home/ombi +helm install --name my-release k8s-at-home/ombi ``` -## Upgrading -Chart versions before 4.0.0 did not use media-common. Upgrading will require you to nest your values.yaml file under -a top-level `ombi:` key. - -Chart versions 1.0.1 and earlier used separate PVCs for Downloads and Music. This presented an issue where Ombi would -be unable to hard-link files between the /downloads and /music directories when importing media. This is caused because -each PVC exposed to the pod as a separate filesystem. It resulted in Ombi 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](#uninstalling-the-chart) 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](#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 Ombi'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 the `ombi` deployment: + +To uninstall/delete the `my-release` deployment: + ```console -helm uninstall ombi +helm delete my-release --purge ``` + 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) +Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/ombi/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 ombi \ - --set ombi.env.TZ="America/New York" \ + --set env.TZ="America/New York" \ k8s-at-home/ombi ``` -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. -For example, +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the +chart. For example, ```console helm install ombi k8s-at-home/ombi --values values.yaml ``` -These values will be nested as it is a dependency, for example ```yaml -ombi: - image: - tag: ... +image: + tag: ... ``` --- @@ -77,3 +59,18 @@ Error: rendered manifests contain a resource that already exists. Unable to cont 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 4.x.x to 5.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. diff --git a/charts/ombi/ci/ct-values.yaml b/charts/ombi/ci/ct-values.yaml new file mode 100644 index 00000000..f6ccc628 --- /dev/null +++ b/charts/ombi/ci/ct-values.yaml @@ -0,0 +1,2 @@ +ingress: + enabled: true diff --git a/charts/ombi/templates/NOTES.txt b/charts/ombi/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/ombi/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/ombi/templates/common.yaml b/charts/ombi/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/ombi/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/ombi/values.yaml b/charts/ombi/values.yaml index 3e630cc9..d3279ccf 100644 --- a/charts/ombi/values.yaml +++ b/charts/ombi/values.yaml @@ -1,10 +1,20 @@ -# Default values for ombi. +# Default values for Ombi. -ombi: - image: - organization: linuxserver - repository: ombi - pullPolicy: IfNotPresent - tag: v4.0.471-ls10 - service: +image: + repository: linuxserver/ombi + pullPolicy: IfNotPresent + tag: version-v4.0.681 + +service: + port: port: 3579 + +env: {} + # TZ: UTC + # PUID: 1001 + # PGID: 1001 + +persistence: + config: + enabled: true + emptyDir: true