From 4f99bc67fb77ade94a7679288498b52fc733becb Mon Sep 17 00:00:00 2001 From: "Nicholas St. Germain" Date: Sun, 6 Sep 2020 16:22:54 -0500 Subject: [PATCH] update readmes to original verbosity and address in separate pr --- charts/lidarr/README.md | 68 +++++++++++++++++++++++++++++++++++---- charts/ombi/README.md | 68 +++++++++++++++++++++++++++++++++++---- charts/organizr/README.md | 53 ++++++++++++++++++++++++++---- charts/radarr/README.md | 68 +++++++++++++++++++++++++++++++++++---- charts/sonarr/README.md | 68 +++++++++++++++++++++++++++++++++++---- charts/tautulli/README.md | 57 ++++++++++++++++++++++++++++---- 6 files changed, 346 insertions(+), 36 deletions(-) diff --git a/charts/lidarr/README.md b/charts/lidarr/README.md index d18e5bda..9912ba73 100644 --- a/charts/lidarr/README.md +++ b/charts/lidarr/README.md @@ -1,15 +1,71 @@ -# lidarr umbrella chart +# Lidarr | Looks and smells like Sonarr but made for music +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/lidarr/) +* Deploys [Lidarr](https://github.com/lidarr/Lidarr) -Umbrella chart that uses [media-common](https://github.com/k8s-at-home/charts/tree/master/charts/media-common) and adds -image information. +## TL;DR +```console +$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ +$ helm install k8s-at-home/lidarr +``` + +## Installing the Chart +To install the chart with the release name `lidarr`: +```console +helm install lidarr k8s-at-home/lidarr +``` + +## 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 `lidarr:` key. + +Chart versions 1.0.1 and earlier used separate PVCs for Downloads and Music. This presented an issue where Lidarr would be unable to hard-link files between the /downloads and /music directories when importing media. This is caused because each PVC is exposed to the pod as a separate filesystem. This resulted in Lidarr 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 Lidarr'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 `lidarr` deployment: +```console +helm uninstall lidarr +``` +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. -These values will be nested as it is a dependency, for example: +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +```console +helm install lidarr \ + --set lidarr.env.TZ="America/New York" \ + k8s-at-home/lidarr +``` +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, +```console +helm install lidarr k8s-at-home/lidarr --values values.yaml +``` + +These values will be nested as it is a dependency, for example ```yaml lidarr: image: tag: ... -``` \ No newline at end of file +``` + +--- +**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`. + +--- diff --git a/charts/ombi/README.md b/charts/ombi/README.md index dfce2ff2..f9b878f7 100644 --- a/charts/ombi/README.md +++ b/charts/ombi/README.md @@ -1,15 +1,71 @@ -# ombi umbrella chart +# 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) -Umbrella chart that uses [media-common](https://github.com/k8s-at-home/charts/tree/master/charts/media-common) and adds -image information. +## TL;DR +```console +$ 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`: +```console +helm install ombi 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 is exposed to the pod as a separate filesystem. This 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: +```console +helm uninstall ombi +``` +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. -These values will be nested as it is a dependency, for example: +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" \ + 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, +```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: ... -``` \ No newline at end of file +``` + +--- +**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`. + +--- diff --git a/charts/organizr/README.md b/charts/organizr/README.md index 877ad400..93302cc3 100644 --- a/charts/organizr/README.md +++ b/charts/organizr/README.md @@ -1,15 +1,56 @@ -# organizr umbrella chart +# Organizr | HTPC/Homelab Services Organizer - Written in PHP +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 [official image](https://hub.docker.com/r/organizr/organizr/) +* Deploys [Organizr](https://github.com/causefx/Organizr) -Umbrella chart that uses [media-common](https://github.com/k8s-at-home/charts/tree/master/charts/media-common) and adds -image information. +## TL;DR +```console +$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ +$ helm install k8s-at-home/organizr +``` + +## Installing the Chart +To install the chart with the release name `organizr`: +```console +helm install organizr k8s-at-home/organizr +``` + +## Uninstalling the Chart +To uninstall the `organizr` deployment: +```console +helm uninstall organizr +``` +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. -These values will be nested as it is a dependency, for example: +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +```console +helm install organizr \ + --set organizr.env.TZ="America/New York" \ + k8s-at-home/organizr +``` +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, +```console +helm install organizr k8s-at-home/organizr --values values.yaml +``` + +These values will be nested as it is a dependency, for example ```yaml organizr: image: tag: ... -``` \ No newline at end of file +``` + +--- +**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`. + +--- diff --git a/charts/radarr/README.md b/charts/radarr/README.md index 7c392760..77f5c441 100644 --- a/charts/radarr/README.md +++ b/charts/radarr/README.md @@ -1,15 +1,71 @@ -# radarr umbrella chart +# Radarr | A fork of Sonarr to work with movies à la Couchpotato +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/radarr/) +* Deploys [Radarr](https://github.com/Radarr/Radarr) -Umbrella chart that uses [media-common](https://github.com/k8s-at-home/charts/tree/master/charts/media-common) and adds -image information. +## TL;DR +```console +$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ +$ helm install k8s-at-home/radarr +``` + +## Installing the Chart +To install the chart with the release name `radarr`: +```console +helm install radarr k8s-at-home/radarr +``` + +## Upgrading +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 `radarr:` key. + +Chart versions 3.2.0 and earlier used separate PVCs for Downloads and Music. This presented an issue where Radarr would be unable to hard-link files between the /downloads and /music directories when importing media. This is caused because each PVC is exposed to the pod as a separate filesystem. This resulted in Radarr 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/movies, 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 Radarr's `Movie Editor` under the `Movies` 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 `radarr` deployment: +```console +helm uninstall radarr +``` +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. -These values will be nested as it is a dependency, for example: +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +```console +helm install radarr \ + --set radarr.env.TZ="America/New York" \ + k8s-at-home/radarr +``` +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, +```console +helm install radarr k8s-at-home/radarr --values values.yaml +``` + +These values will be nested as it is a dependency, for example ```yaml radarr: image: tag: ... -``` \ No newline at end of file +``` + +--- +**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`. + +--- diff --git a/charts/sonarr/README.md b/charts/sonarr/README.md index 347dfa99..c80e8df3 100644 --- a/charts/sonarr/README.md +++ b/charts/sonarr/README.md @@ -1,15 +1,71 @@ -# sonarr umbrella chart +# Sonarr | Smart PVR for newsgroup and bittorrent users +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) -Umbrella chart that uses [media-common](https://github.com/k8s-at-home/charts/tree/master/charts/media-common) and adds -image information. +## TL;DR +```console +$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ +$ helm install k8s-at-home/sonarr +``` + +## Installing the Chart +To install the chart with the release name `sonarr`: +```console +helm install sonarr k8s-at-home/sonarr +``` + +## Upgrading +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. + +Chart versions 3.2.0 and earlier used separate PVCs for Downloads and Music. This presented an issue where Sonarr would be unable to hard-link files between the /downloads and /music directories when importing media. This is caused because each PVC is exposed to the pod as a separate filesystem. This resulted in Sonarr 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/tv, 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 Sonarr's `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. + +## 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. -These values will be nested as it is a dependency, for example: +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: ... -``` \ No newline at end of file +``` + +--- +**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`. + +--- diff --git a/charts/tautulli/README.md b/charts/tautulli/README.md index 084556cd..f035b6dd 100644 --- a/charts/tautulli/README.md +++ b/charts/tautulli/README.md @@ -1,15 +1,60 @@ -# tautulli umbrella chart +# Tautulli | A Python based monitoring and tracking tool for Plex Media Server +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 [official image](https://hub.docker.com/r/tautulli/tautulli/) +* Deploys [Tautulli](https://github.com/Tautulli/Tautulli) -Umbrella chart that uses [media-common](https://github.com/k8s-at-home/charts/tree/master/charts/media-common) and adds -image information. +## TL;DR +```console +$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ +$ helm install k8s-at-home/tautulli +``` + +## Installing the Chart +To install the chart with the release name `tautulli`: +```console +helm install tautulli k8s-at-home/tautulli +``` + +## 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 `tautulli:` key. + +## Uninstalling the Chart +To uninstall the `tautulli` deployment: +```console +helm uninstall tautulli +``` +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. -These values will be nested as it is a dependency, for example: +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +```console +helm install tautulli \ + --set tautulli.env.TZ="America/New York" \ + k8s-at-home/tautulli +``` +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, +```console +helm install tautulli k8s-at-home/tautulli --values values.yaml +``` + +These values will be nested as it is a dependency, for example ```yaml tautulli: image: tag: ... -``` \ No newline at end of file +``` + +--- +**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`. + +---