mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-24 16:09:08 +00:00
[ombi] use common chart (#126)
* ombi: use common chart * remove app name in app.env example
This commit is contained in:
parent
93774a4ed6
commit
4566fda5ea
23
charts/ombi/.helmignore
Normal file
23
charts/ombi/.helmignore
Normal file
@ -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
|
@ -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
|
||||
|
@ -1,4 +1,4 @@
|
||||
approvers:
|
||||
- DirtyCajunRice
|
||||
- billimek
|
||||
reviewers:
|
||||
- DirtyCajunRice
|
||||
- billimek
|
||||
|
@ -1,69 +1,51 @@
|
||||
# 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:
|
||||
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.
|
||||
|
2
charts/ombi/ci/ct-values.yaml
Normal file
2
charts/ombi/ci/ct-values.yaml
Normal file
@ -0,0 +1,2 @@
|
||||
ingress:
|
||||
enabled: true
|
1
charts/ombi/templates/NOTES.txt
Normal file
1
charts/ombi/templates/NOTES.txt
Normal file
@ -0,0 +1 @@
|
||||
{{- include "common.notes.defaultNotes" . -}}
|
1
charts/ombi/templates/common.yaml
Normal file
1
charts/ombi/templates/common.yaml
Normal file
@ -0,0 +1 @@
|
||||
{{ include "common.all" . }}
|
@ -1,10 +1,20 @@
|
||||
# Default values for ombi.
|
||||
# Default values for Ombi.
|
||||
|
||||
ombi:
|
||||
image:
|
||||
organization: linuxserver
|
||||
repository: ombi
|
||||
image:
|
||||
repository: linuxserver/ombi
|
||||
pullPolicy: IfNotPresent
|
||||
tag: v4.0.471-ls10
|
||||
service:
|
||||
tag: version-v4.0.681
|
||||
|
||||
service:
|
||||
port:
|
||||
port: 3579
|
||||
|
||||
env: {}
|
||||
# TZ: UTC
|
||||
# PUID: 1001
|
||||
# PGID: 1001
|
||||
|
||||
persistence:
|
||||
config:
|
||||
enabled: true
|
||||
emptyDir: true
|
||||
|
Loading…
Reference in New Issue
Block a user