From 10cfeb8bd1bc001dc7c38eee57e65990a0194377 Mon Sep 17 00:00:00 2001 From: "Nicholas St. Germain" Date: Sun, 6 Sep 2020 17:10:34 -0500 Subject: [PATCH] fix copy/paste on readmes, standardize readme lines to approx 120 char per line, and allow commit messages to skip linting. [skip install] [skip lint] --- .github/workflows/lint-test.yaml | 14 ++++++-------- charts/lidarr/README.md | 20 ++++++++++++++------ charts/media-common/README.md | 3 ++- charts/media-common/ci/ct-values.yaml | 3 +-- charts/ombi/Chart.yaml | 2 +- charts/ombi/README.md | 18 +++++++++++++----- charts/organizr/README.md | 6 ++++-- charts/radarr/Chart.yaml | 2 +- charts/radarr/README.md | 18 +++++++++++++----- charts/sonarr/Chart.yaml | 2 +- charts/sonarr/README.md | 21 +++++++++++++++------ charts/tautulli/README.md | 6 ++++-- 12 files changed, 75 insertions(+), 40 deletions(-) diff --git a/.github/workflows/lint-test.yaml b/.github/workflows/lint-test.yaml index c758ac45..817e9a78 100644 --- a/.github/workflows/lint-test.yaml +++ b/.github/workflows/lint-test.yaml @@ -1,30 +1,28 @@ name: Lint and Test Charts - on: pull_request - jobs: lint-test: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v2 - - name: Fetch history - run: git fetch --prune --unshallow - + run: | + git fetch --prune --unshallow; + echo ::set-env name=commitmsg::$(git log --format=%B -n 1 ${{ github.event.after }}) - name: Run chart-testing (lint) id: lint uses: helm/chart-testing-action@v1.0.0 + if: !contains(env.commitmsg, '[skip lint]') with: command: lint config: ct.yaml - - name: Create kind cluster uses: helm/kind-action@v1.0.0 - if: steps.lint.outputs.changed == 'true' - + if: steps.lint.outputs.changed == 'true' && !contains(env.commitmsg, '[skip install]') - name: Run chart-testing (install) uses: helm/chart-testing-action@v1.0.0 + if: steps.lint.outputs.changed == 'true' && !contains(env.commitmsg, '[skip install]') with: command: install config: ct.yaml diff --git a/charts/lidarr/README.md b/charts/lidarr/README.md index 9912ba73..e9da5f59 100644 --- a/charts/lidarr/README.md +++ b/charts/lidarr/README.md @@ -20,16 +20,22 @@ helm install lidarr k8s-at-home/lidarr 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. +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 exposed to the pod as a separate filesystem. It 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: +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. +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: @@ -39,7 +45,8 @@ 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. +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 @@ -47,7 +54,8 @@ 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, +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 ``` @@ -66,6 +74,6 @@ 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`. +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/media-common/README.md b/charts/media-common/README.md index 54d98cb7..043d9a94 100644 --- a/charts/media-common/README.md +++ b/charts/media-common/README.md @@ -15,7 +15,8 @@ repository or tag, and not designed to be deployed directly. ## Configuration -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/media-common/values.yaml) file. It has several commented out suggested values. +Read through the [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 normally be nested as it is a dependency, for example: ```yaml diff --git a/charts/media-common/ci/ct-values.yaml b/charts/media-common/ci/ct-values.yaml index eca9249e..2e2ef0b2 100644 --- a/charts/media-common/ci/ct-values.yaml +++ b/charts/media-common/ci/ct-values.yaml @@ -1,7 +1,6 @@ image: - organization: itscontained + organization: linuxserver repository: radarr tag: latest service: port: 7878 -configPath: /var/lib/radarr diff --git a/charts/ombi/Chart.yaml b/charts/ombi/Chart.yaml index fd5ae271..8b2a34a0 100644 --- a/charts/ombi/Chart.yaml +++ b/charts/ombi/Chart.yaml @@ -10,7 +10,7 @@ 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/itscontained/ombi + - https://hub.docker.com/r/linuxserver/ombi maintainers: - name: DirtyCajunRice email: nick@cajun.pro diff --git a/charts/ombi/README.md b/charts/ombi/README.md index f9b878f7..a0f97813 100644 --- a/charts/ombi/README.md +++ b/charts/ombi/README.md @@ -20,16 +20,22 @@ helm install ombi k8s-at-home/ombi 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. +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: +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. +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: @@ -39,7 +45,8 @@ 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. +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 @@ -47,7 +54,8 @@ 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, +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 ``` diff --git a/charts/organizr/README.md b/charts/organizr/README.md index 93302cc3..46d0674f 100644 --- a/charts/organizr/README.md +++ b/charts/organizr/README.md @@ -24,7 +24,8 @@ 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. +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 @@ -32,7 +33,8 @@ 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, +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 ``` diff --git a/charts/radarr/Chart.yaml b/charts/radarr/Chart.yaml index 27353d80..7dfaaec5 100644 --- a/charts/radarr/Chart.yaml +++ b/charts/radarr/Chart.yaml @@ -10,7 +10,7 @@ home: https://github.com/k8s-at-home/charts/tree/master/charts/radarr icon: https://github.com/Radarr/Radarr/blob/aphrodite/Logo/512.png?raw=true sources: - https://github.com/Radarr/Radarr - - https://hub.docker.com/r/itscontained/radarr + - https://hub.docker.com/r/linuxserver/radarr maintainers: - name: DirtyCajunRice email: nick@cajun.pro diff --git a/charts/radarr/README.md b/charts/radarr/README.md index 77f5c441..d5ab90a0 100644 --- a/charts/radarr/README.md +++ b/charts/radarr/README.md @@ -20,16 +20,22 @@ helm install radarr k8s-at-home/radarr 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. +Chart versions 3.2.0 and earlier used separate PVCs for Downloads and Movies. This presented an issue where Radarr would +be unable to hard-link files between the /downloads and /movies directories when importing media. This is caused because +each PVC exposed to the pod as a separate filesystem. It 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: +This chart now uses a single PVC for Downloads and Movies. 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. +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: @@ -39,7 +45,8 @@ 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. +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 @@ -47,7 +54,8 @@ 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, +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 ``` diff --git a/charts/sonarr/Chart.yaml b/charts/sonarr/Chart.yaml index b81efc34..43b9dd02 100644 --- a/charts/sonarr/Chart.yaml +++ b/charts/sonarr/Chart.yaml @@ -10,7 +10,7 @@ home: https://github.com/k8s-at-home/charts/tree/master/charts/media-common/sona icon: https://github.com/Sonarr/Sonarr/blob/phantom-develop/Logo/512.png?raw=true sources: - https://github.com/Sonarr/Sonarr - - https://hub.docker.com/r/itscontained/sonarr + - https://hub.docker.com/r/linuxserver/sonarr maintainers: - name: DirtyCajunRice email: nick@cajun.pro diff --git a/charts/sonarr/README.md b/charts/sonarr/README.md index c80e8df3..d318e885 100644 --- a/charts/sonarr/README.md +++ b/charts/sonarr/README.md @@ -20,16 +20,22 @@ helm install sonarr k8s-at-home/sonarr 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. +Chart versions 3.2.0 and earlier used separate PVCs for Downloads and TV. This presented an issue where Sonarr would +be unable to hard-link files between the /downloads and /tv directories when importing media. This is caused because +each PVC exposed to the pod as a separate filesystem. It 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: +This chart now uses a single PVC for Downloads and TV. 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. +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: @@ -39,7 +45,8 @@ 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. +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 @@ -48,7 +55,8 @@ helm install sonarr \ 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, +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 ``` @@ -66,6 +74,7 @@ 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`. +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 f035b6dd..72605ec4 100644 --- a/charts/tautulli/README.md +++ b/charts/tautulli/README.md @@ -28,7 +28,8 @@ 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. +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 @@ -36,7 +37,8 @@ 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, +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 ```