master-group/charts
2
0
Fork 0
mirror of https://github.com/k8s-at-home/charts.git synced 2025-02-03 07:49:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readmes to original verbosity and address in separate pr

Browse Source
This commit is contained in:
Nicholas St. Germain 2020-09-06 16:22:54 -05:00
parent 6d5c992852
commit 4f99bc67fb
No known key found for this signature in database
GPG Key ID: 7221152119DAB1E6
6 changed files with 346 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
charts/lidarr/README.md
View File

@ -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: ...
```
---
**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`.
---

66
charts/ombi/README.md
View File

@ -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: ...
```
---
**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`.
---

51
charts/organizr/README.md
View File

@ -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: ...
```
---
**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`.
---

66
charts/radarr/README.md
View File

@ -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: ...
```
---
**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`.
---

66
charts/sonarr/README.md
View File

@ -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: ...
```
---
**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`.
---

55
charts/tautulli/README.md
View File

@ -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: ...
```
---
**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`.
---