Skip to content

Commit

Permalink
Change how volume types are defaulted (#30)
Browse files Browse the repository at this point in the history
## Description

Charts do not need to define default volumes - this is done now in the
template file, fixing an issue where you had to otherwise nullify this
in your own values.yaml file.

#28

## Type of change

- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] Non-breaking change which adds functionality
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] Documentation update
  • Loading branch information
drinkataco authored Oct 6, 2024
2 parents 19a4c3f + 03bf1d4 commit 2dcac5a
Show file tree
Hide file tree
Showing 42 changed files with 58 additions and 124 deletions.
2 changes: 1 addition & 1 deletion Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ apiVersion: 'v2'
name: 'media-servarr-base'
description: 'Base chart for media-servarr charts'
type: 'application'
version: 0.5.0
version: 0.5.1
icon: 'https://github.com/drinkataco/media-servarr/blob/main/icon.png'
4 changes: 2 additions & 2 deletions charts/bazarr/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ keywords:
- 'bazarr'
kubeversion: ">=1.24.0-0"
type: 'application'
version: 0.4.3
version: 0.4.4
appVersion: '1.4.3'
icon: 'https://github.com/drinkataco/media-servarr/blob/main/charts/bazarr/icon.png'
dependencies:
- name: 'media-servarr-base'
version: 0.5.0
version: 0.5.1
repository: "file://../.."
maintainers:
- name: 'media-servarr'
Expand Down
6 changes: 1 addition & 5 deletions charts/bazarr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,7 @@ deployment:
name: 'bazarr-config'
```

By default, a PersistentVolumeClaim will be provisioned for the `config`

It is highly recommended that you do not use NFS for your config volume - because of the loose implementation of NFS protocol that causes issue with file locking causing detrimental effects if using a SQlite database.

You can define basic persistent volume claims in code to help you get started. You just need to pass to the pvc name (which is the key) is an empty object (`{}`)
By default, a PersistentVolumeClaim will be provisioned for the `config` named `bazarr-config`.

```yaml
persistentVolumeClaims:
Expand Down
4 changes: 2 additions & 2 deletions charts/flaresolverr/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ keywords:
- 'bypass'
kubeVersion: ">=1.24.0-0"
type: 'application'
version: 0.4.3
version: 0.4.4
appVersion: 'v3.3.21'
icon: 'https://github.com/drinkataco/media-servarr/blob/main/charts/flaresolverr/icon.png'
dependencies:
- name: 'media-servarr-base'
version: 0.5.0
version: 0.5.1
repository: "file://../.."
maintainers:
- name: 'media-servarr'
Expand Down
4 changes: 2 additions & 2 deletions charts/homarr/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ keywords:
- 'homarr'
kubeversion: ">=1.24.0-0"
type: 'application'
version: 0.5.2
version: 0.5.3
appVersion: '0.15.3'
icon: 'https://github.com/drinkataco/media-servarr/blob/main/charts/radarr/icon.png'
dependencies:
- name: 'media-servarr-base'
version: 0.5.0
version: 0.5.1
repository: "file://../.."
maintainers:
- name: 'media-servarr'
Expand Down
6 changes: 1 addition & 5 deletions charts/homarr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,19 +59,15 @@ deployment:
app-data-configs:
persistentVolumeClaim:
name: 'my-pv-claim1'
emptyDir: # nullify default empty dir
# Dashboard Icons
app-data-icons:
# Example direct NFS mount without need for PV
nfs:
server: 'fileserver'
path: '/srv/homarr/icons'
emptyDir: # nullify default empty dir
```
By default, a PersistentVolumeClaim will be provisioned for all the config directories listed above
You can define basic persistent volume claims in code to help you get started. You just need to pass to the pvc name (which is the key) is an empty object (`{}`)
By default, a PersistentVolumeClaim will be provisioned for the `data`, but `emptyDir: {}` will be used for config and icons, unless otherwise specified in your `values.yaml`

```yaml
persistentVolumeClaims:
Expand Down
2 changes: 0 additions & 2 deletions charts/homarr/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,8 @@ deployment:
volumes:
# Dashboard files
app-data-configs:
emptyDir: {}
# Icons
app-data-icons:
emptyDir: {}
# DB files
data:
persistentVolumeClaim:
Expand Down
4 changes: 2 additions & 2 deletions charts/jellyfin/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ keywords:
- 'jellyfin'
kubeversion: ">=1.24.0-0"
type: 'application'
version: 0.3.2
version: 0.3.3
appVersion: '10.9.9'
icon: 'https://github.com/drinkataco/media-servarr/blob/main/charts/jellyfin/icon.png'
dependencies:
- name: 'media-servarr-base'
version: 0.5.0
version: 0.5.1
repository: "file://../.."
maintainers:
- name: 'media-servarr'
Expand Down
6 changes: 1 addition & 5 deletions charts/jellyfin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,7 @@ deployment:
television:
```
By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for downloads and film - but it is recommended enable some type of PVC and PV!

It is highly recommended that you do not use NFS for your config volume - because of the loose implementation of NFS protocol that causes issue with file locking causing detrimental effects on the SQlite database.

You can define basic persistent volume claims in code to help you get started. You just need to pass to the pvc name (which is the key) is an empty object (`{}`)
By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for ebooks, film, music, and television, unless otherwise specified in your `values.yaml`

```yaml
persistentVolumeClaims:
Expand Down
1 change: 1 addition & 0 deletions charts/jellyfin/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ Success!
_/ |\___|_|_|\__, |_| |_|_| |_|
|__/ |___/


{{ include "media-servarr-base.notes" "jellyfin" }}
4 changes: 0 additions & 4 deletions charts/jellyfin/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,9 @@ deployment:
persistentVolumeClaim:
claimName: 'jellyfin-config'
ebooks:
emptyDir: {}
film:
emptyDir: {}
music:
emptyDir: {}
television:
emptyDir: {}

persistentVolumeClaims:
jellyfin-config:
Expand Down
4 changes: 2 additions & 2 deletions charts/jellyseerr/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ keywords:
- 'jellyseerr'
kubeversion: ">=1.24.0-0"
type: 'application'
version: 0.2.1
version: 0.2.2
appVersion: '1.9.2'
icon: 'https://github.com/drinkataco/media-servarr/blob/main/charts/jellyseerr/icon.png'
dependencies:
- name: 'media-servarr-base'
version: 0.5.0
version: 0.5.1
repository: "file://../.."
maintainers:
- name: 'media-servarr'
Expand Down
2 changes: 0 additions & 2 deletions charts/jellyseerr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,6 @@ deployment:
By default, a PersistentVolumeClaim will be provisioned for the `config`.

You can deseerre basic persistent volume claims in code to help you get started. You just need to pass to the pvc name (which is the key) is an empty object (`{}`)

```yaml
persistentVolumeClaims:
jellyseerr-config:
Expand Down
1 change: 1 addition & 0 deletions charts/jellyseerr/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ Success!
\___/ \___|_|_|\__, |___/\___|\___|_| |_|
|___/


{{ include "media-servarr-base.notes" "jellyseerr" }}
4 changes: 2 additions & 2 deletions charts/lidarr/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ keywords:
- 'lidarr'
kubeversion: ">=1.24.0-0"
type: 'application'
version: 0.5.2
version: 0.5.3
appVersion: '2.4.3'
icon: 'https://github.com/drinkataco/media-servarr/blob/main/charts/radarr/icon.png'
dependencies:
- name: 'media-servarr-base'
version: 0.5.0
version: 0.5.1
repository: "file://../.."
maintainers:
- name: 'media-servarr'
Expand Down
6 changes: 1 addition & 5 deletions charts/lidarr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,7 @@ deployment:
path: '/srv/media/music/'
```

By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for downloads and film - but it is recommended enable some type of PVC and PV!

It is highly recommended that you do not use NFS for your config volume - because of the loose implementation of NFS protocol that causes issue with file locking causing detrimental effects on the SQlite database.

You can define basic persistent volume claims in code to help you get started. You just need to pass to the pvc name (which is the key) is an empty object (`{}`)
By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for downloads and music, unless otherwise specified in your `values.yaml`

```yaml
persistentVolumeClaims:
Expand Down
1 change: 1 addition & 0 deletions charts/lidarr/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ Success!
| | | (_| | (_| | | | |
|_|_|\__,_|\__,_|_| |_|


{{ include "media-servarr-base.notes" "lidarr" }}
2 changes: 0 additions & 2 deletions charts/lidarr/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,7 @@ deployment:
persistentVolumeClaim:
claimName: 'lidarr-config'
downloads:
emptyDir: {}
music:
emptyDir: {}

persistentVolumeClaims:
lidarr-config:
Expand Down
4 changes: 2 additions & 2 deletions charts/prowlarr/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ keywords:
- 'prowlarr'
kubeversion: ">=1.24.0-0"
type: 'application'
version: 0.5.3
version: 0.5.4
appVersion: '1.21.2'
icon: 'https://github.com/drinkataco/media-servarr/blob/main/charts/prowlarr/icon.png'
dependencies:
- name: 'media-servarr-base'
version: 0.5.0
version: 0.5.1
repository: "file://../.."
maintainers:
- name: 'media-servarr'
Expand Down
10 changes: 1 addition & 9 deletions charts/prowlarr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,17 +92,9 @@ deployment:
config: # The key will be the volume name
persistentVolumeClaim:
name: 'prowlarr-config'
downloads:
nfs:
server: 'fileserver.local'
path: '/srv/downloads/'
```

By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for downloads - but it is recommended enable some type of PVC and PV!

It is highly recommended that you do not use NFS for your config volume - because of the loose implementation of NFS protocol that causes issue with file locking causing detrimental effects on the SQlite database.

You can define basic persistent volume claims in code to help you get started. You just need to pass to the pvc name (which is the key) is an empty object (`{}`)
By default, a PersistentVolumeClaim will be provisioned for the `config`.

```yaml
persistentVolumeClaims:
Expand Down
1 change: 1 addition & 0 deletions charts/prowlarr/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ Success!
| .__/|_| \___/ \_/\_/ |_|\__,_|_| |_|
|_|


{{ include "media-servarr-base.notes" "prowlarr" }}
4 changes: 2 additions & 2 deletions charts/radarr/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ keywords:
- 'radarr'
kubeversion: ">=1.24.0-0"
type: 'application'
version: 0.5.3
version: 0.5.4
appVersion: '5.8.3'
icon: 'https://github.com/drinkataco/media-servarr/blob/main/charts/radarr/icon.png'
dependencies:
- name: 'media-servarr-base'
version: 0.5.0
version: 0.5.1
repository: "file://../.."
maintainers:
- name: 'media-servarr'
Expand Down
6 changes: 1 addition & 5 deletions charts/radarr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,7 @@ deployment:
path: '/srv/media/film/'
```

By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for downloads and film - but it is recommended enable some type of PVC and PV!

It is highly recommended that you do not use NFS for your config volume - because of the loose implementation of NFS protocol that causes issue with file locking causing detrimental effects on the SQlite database.

You can define basic persistent volume claims in code to help you get started. You just need to pass to the pvc name (which is the key) is an empty object (`{}`)
By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for downloads, and film, unless otherwise specified in your `values.yaml`

```yaml
persistentVolumeClaims:
Expand Down
13 changes: 7 additions & 6 deletions charts/radarr/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
Success!
_ _ _
| |_ _ __ __ _ _ __ ___ _ __ ___ (_)___ ___(_) ___ _ __
| __| '__/ _` | '_ \/ __| '_ ` _ \| / __/ __| |/ _ \| '_ \
| |_| | | (_| | | | \__ \ | | | | | \__ \__ \ | (_) | | | |
\__|_| \__,_|_| |_|___/_| |_| |_|_|___/___/_|\___/|_| |_|
_
_ __ __ _ __| | __ _ _ __ _ __
| '__/ _` |/ _` |/ _` | '__| '__|
| | | (_| | (_| | (_| | | | |
|_| \__,_|\__,_|\__,_|_| |_|

{{ include "media-servarr-base.notes" "transmission" }}

{{ include "media-servarr-base.notes" "radarr" }}
2 changes: 0 additions & 2 deletions charts/radarr/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,7 @@ deployment:
persistentVolumeClaim:
claimName: 'radarr-config'
downloads:
emptyDir: {}
film:
emptyDir: {}

persistentVolumeClaims:
radarr-config:
Expand Down
4 changes: 2 additions & 2 deletions charts/readarr/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ keywords:
- 'readarr'
kubeversion: ">=1.24.0-0"
type: 'application'
version: 0.5.3
version: 0.5.4
appVersion: '0.3.32-develop'
icon: 'https://github.com/drinkataco/media-servarr/blob/main/charts/readarr/icon.png'
dependencies:
- name: 'media-servarr-base'
version: 0.5.0
version: 0.5.1
repository: "file://../.."
maintainers:
- name: 'media-servarr'
Expand Down
6 changes: 1 addition & 5 deletions charts/readarr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,7 @@ deployment:
path: '/srv/media/ebooks/'
```

By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for downloads and ebooks - but it is recommended enable some type of PVC and PV!

It is highly recommended that you do not use NFS for your config volume - because of the loose implementation of NFS protocol that causes issue with file locking causing detrimental effects on the SQlite database.

You can define basic persistent volume claims in code to help you get started. You just need to pass to the pvc name (which is the key) is an empty object (`{}`)
By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for downloads, and ebooks, unless otherwise specified in your `values.yaml`

```yaml
persistentVolumeClaims:
Expand Down
1 change: 1 addition & 0 deletions charts/readarr/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ Success!
| | | __/ (_| | (_| | (_| | | | |
|_| \___|\__,_|\__,_|\__,_|_| |_|


{{ include "media-servarr-base.notes" "readarr" }}
2 changes: 0 additions & 2 deletions charts/readarr/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,7 @@ deployment:
persistentVolumeClaim:
claimName: 'readarr-config'
downloads:
emptyDir: {}
ebooks:
emptyDir: {}

persistentVolumeClaims:
readarr-config:
Expand Down
4 changes: 2 additions & 2 deletions charts/sabnzbd/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ keywords:
- 'sabnzbd'
kubeversion: ">=1.24.0-0"
type: 'application'
version: 0.1.1
version: 0.1.2
appVersion: '4.3.2'
icon: 'https://github.com/drinkataco/media-servarr/blob/main/charts/sabnzbd/icon.png'
dependencies:
- name: 'media-servarr-base'
version: 0.5.0
version: 0.5.1
repository: "file://../.."
maintainers:
- name: 'media-servarr'
Expand Down
4 changes: 1 addition & 3 deletions charts/sabnzbd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,7 @@ deployment:
path: '/srv/downloads/'
```
By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for downloads - but it is recommended enable some type of PVC and PV!

You can define basic persistent volume claims in code to help you get started. You just need to pass to the pvc name (which is the key) is an empty object (`{}`)
By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for downloads, unless otherwise specified in your `values.yaml`

```yaml
persistentVolumeClaims:
Expand Down
1 change: 1 addition & 0 deletions charts/sabnzbd/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ Success!
___) / ___ \| |_) | | | |/ /| |_) | (_| |
|____/_/ \_\____/|_| |_/___|_.__/ \__,_|


{{ include "media-servarr-base.notes" "SABnzbd" }}
1 change: 0 additions & 1 deletion charts/sabnzbd/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ deployment:
persistentVolumeClaim:
claimName: 'sabnzbd-config'
downloads:
emptyDir: {}

persistentVolumeClaims:
sabnzbd-config:
Expand Down
Loading

0 comments on commit 2dcac5a

Please sign in to comment.