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]

This commit is contained in:
Nicholas St. Germain 2020-09-06 17:10:34 -05:00
parent 4f99bc67fb
commit 10cfeb8bd1
No known key found for this signature in database
GPG Key ID: 7221152119DAB1E6
12 changed files with 75 additions and 40 deletions

View File

@ -1,30 +1,28 @@
name: Lint and Test Charts name: Lint and Test Charts
on: pull_request on: pull_request
jobs: jobs:
lint-test: lint-test:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: Fetch history - 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) - name: Run chart-testing (lint)
id: lint id: lint
uses: helm/chart-testing-action@v1.0.0 uses: helm/chart-testing-action@v1.0.0
if: !contains(env.commitmsg, '[skip lint]')
with: with:
command: lint command: lint
config: ct.yaml config: ct.yaml
- name: Create kind cluster - name: Create kind cluster
uses: helm/kind-action@v1.0.0 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) - name: Run chart-testing (install)
uses: helm/chart-testing-action@v1.0.0 uses: helm/chart-testing-action@v1.0.0
if: steps.lint.outputs.changed == 'true' && !contains(env.commitmsg, '[skip install]')
with: with:
command: install command: install
config: ct.yaml config: ct.yaml

View File

@ -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 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. 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 1. [Uninstall](#uninstalling-the-chart) your current release
2. On your backing store, organize your media, ie. media/music, media/downloads 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 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 4. Refer to the [configuration](#configuration) for updates to the chart values
5. Re-install the chart 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 ## Uninstalling the Chart
To uninstall the `lidarr` deployment: 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. The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration ## 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, Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```console ```console
@ -47,7 +54,8 @@ helm install lidarr \
--set lidarr.env.TZ="America/New York" \ --set lidarr.env.TZ="America/New York" \
k8s-at-home/lidarr 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 ```console
helm install lidarr k8s-at-home/lidarr --values values.yaml helm install lidarr k8s-at-home/lidarr --values values.yaml
``` ```
@ -66,6 +74,6 @@ If you get
```console ```console
Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` 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`.
--- ---

View File

@ -15,7 +15,8 @@ repository or tag, and not designed to be deployed directly.
## Configuration ## 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: These values will normally be nested as it is a dependency, for example:
```yaml ```yaml

View File

@ -1,7 +1,6 @@
image: image:
organization: itscontained organization: linuxserver
repository: radarr repository: radarr
tag: latest tag: latest
service: service:
port: 7878 port: 7878
configPath: /var/lib/radarr

View File

@ -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 icon: https://github.com/tidusjar/Ombi/blob/feature/v4/src/Ombi/wwwroot/images/ms-icon-310x310.png?raw=true
sources: sources:
- https://github.com/tidusjar/Ombi - https://github.com/tidusjar/Ombi
- https://hub.docker.com/r/itscontained/ombi - https://hub.docker.com/r/linuxserver/ombi
maintainers: maintainers:
- name: DirtyCajunRice - name: DirtyCajunRice
email: nick@cajun.pro email: nick@cajun.pro

View File

@ -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 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. 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 1. [Uninstall](#uninstalling-the-chart) your current release
2. On your backing store, organize your media, ie. media/music, media/downloads 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 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 4. Refer to the [configuration](#configuration) for updates to the chart values
5. Re-install the chart 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 ## Uninstalling the Chart
To uninstall the `ombi` deployment: 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. The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration ## 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, Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```console ```console
@ -47,7 +54,8 @@ helm install ombi \
--set ombi.env.TZ="America/New York" \ --set ombi.env.TZ="America/New York" \
k8s-at-home/ombi 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 ```console
helm install ombi k8s-at-home/ombi --values values.yaml helm install ombi k8s-at-home/ombi --values values.yaml
``` ```

View File

@ -24,7 +24,8 @@ helm uninstall organizr
The command removes all the Kubernetes components associated with the chart and deletes the release. The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration ## 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, Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```console ```console
@ -32,7 +33,8 @@ helm install organizr \
--set organizr.env.TZ="America/New York" \ --set organizr.env.TZ="America/New York" \
k8s-at-home/organizr 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 ```console
helm install organizr k8s-at-home/organizr --values values.yaml helm install organizr k8s-at-home/organizr --values values.yaml
``` ```

View File

@ -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 icon: https://github.com/Radarr/Radarr/blob/aphrodite/Logo/512.png?raw=true
sources: sources:
- https://github.com/Radarr/Radarr - https://github.com/Radarr/Radarr
- https://hub.docker.com/r/itscontained/radarr - https://hub.docker.com/r/linuxserver/radarr
maintainers: maintainers:
- name: DirtyCajunRice - name: DirtyCajunRice
email: nick@cajun.pro email: nick@cajun.pro

View File

@ -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 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. 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 1. [Uninstall](#uninstalling-the-chart) your current release
2. On your backing store, organize your media, ie. media/movies, media/downloads 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 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 4. Refer to the [configuration](#configuration) for updates to the chart values
5. Re-install the chart 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 ## Uninstalling the Chart
To uninstall the `radarr` deployment: 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. The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration ## 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, Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```console ```console
@ -47,7 +54,8 @@ helm install radarr \
--set radarr.env.TZ="America/New York" \ --set radarr.env.TZ="America/New York" \
k8s-at-home/radarr 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 ```console
helm install radarr k8s-at-home/radarr --values values.yaml helm install radarr k8s-at-home/radarr --values values.yaml
``` ```

View File

@ -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 icon: https://github.com/Sonarr/Sonarr/blob/phantom-develop/Logo/512.png?raw=true
sources: sources:
- https://github.com/Sonarr/Sonarr - https://github.com/Sonarr/Sonarr
- https://hub.docker.com/r/itscontained/sonarr - https://hub.docker.com/r/linuxserver/sonarr
maintainers: maintainers:
- name: DirtyCajunRice - name: DirtyCajunRice
email: nick@cajun.pro email: nick@cajun.pro

View File

@ -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 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. 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 1. [Uninstall](#uninstalling-the-chart) your current release
2. On your backing store, organize your media, ie. media/tv, media/downloads 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 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 4. Refer to the [configuration](#configuration) for updates to the chart values
5. Re-install the chart 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 ## Uninstalling the Chart
To uninstall the `sonarr` deployment: 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. The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration ## 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, Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```console ```console
@ -48,7 +55,8 @@ helm install sonarr \
k8s-at-home/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 ```console
helm install sonarr k8s-at-home/sonarr --values values.yaml helm install sonarr k8s-at-home/sonarr --values values.yaml
``` ```
@ -66,6 +74,7 @@ If you get
```console ```console
Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` 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`.
--- ---

View File

@ -28,7 +28,8 @@ helm uninstall tautulli
The command removes all the Kubernetes components associated with the chart and deletes the release. The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration ## 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, Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```console ```console
@ -36,7 +37,8 @@ helm install tautulli \
--set tautulli.env.TZ="America/New York" \ --set tautulli.env.TZ="America/New York" \
k8s-at-home/tautulli 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 ```console
helm install tautulli k8s-at-home/tautulli --values values.yaml helm install tautulli k8s-at-home/tautulli --values values.yaml
``` ```