mirror of
https://github.com/rtomik/helm-charts.git
synced 2026-04-09 11:40:46 +00:00
Compare commits
5 Commits
norish-0.0
...
donetick-1
| Author | SHA1 | Date | |
|---|---|---|---|
| fe7c741bda | |||
| 55d1ce8377 | |||
| d3cdd77cc6 | |||
| 4c8179f9cc | |||
| 7be50d4890 |
@ -2,7 +2,7 @@ apiVersion: v2
|
|||||||
name: donetick
|
name: donetick
|
||||||
description: Donetick helm chart for Kubernetes
|
description: Donetick helm chart for Kubernetes
|
||||||
type: application
|
type: application
|
||||||
version: 1.0.4
|
version: 1.0.6
|
||||||
appVersion: "v0.1.60"
|
appVersion: "v0.1.60"
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: Richard Tomik
|
- name: Richard Tomik
|
||||||
|
|||||||
@ -2,7 +2,7 @@ apiVersion: v2
|
|||||||
name: norish
|
name: norish
|
||||||
description: Norish helm chart for Kubernetes - A recipe management and meal planning application
|
description: Norish helm chart for Kubernetes - A recipe management and meal planning application
|
||||||
type: application
|
type: application
|
||||||
version: 0.0.2
|
version: 0.0.3
|
||||||
appVersion: "v0.13.6-beta"
|
appVersion: "v0.13.6-beta"
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: Richard Tomik
|
- name: Richard Tomik
|
||||||
|
|||||||
@ -219,6 +219,9 @@ spec:
|
|||||||
key: google-client-secret
|
key: google-client-secret
|
||||||
{{- end }}
|
{{- end }}
|
||||||
{{- end }}
|
{{- end }}
|
||||||
|
{{- with .Values.config.extraEnv }}
|
||||||
|
{{- toYaml . | nindent 12 }}
|
||||||
|
{{- end }}
|
||||||
volumeMounts:
|
volumeMounts:
|
||||||
- name: uploads
|
- name: uploads
|
||||||
mountPath: /app/uploads
|
mountPath: /app/uploads
|
||||||
|
|||||||
@ -120,6 +120,18 @@ config:
|
|||||||
# This should match your ingress hostname
|
# This should match your ingress hostname
|
||||||
authUrl: "http://norish.domain.com"
|
authUrl: "http://norish.domain.com"
|
||||||
|
|
||||||
|
# Extra environment variables
|
||||||
|
# Example:
|
||||||
|
# extraEnv:
|
||||||
|
# - name: MY_CUSTOM_VAR
|
||||||
|
# value: "my-value"
|
||||||
|
# - name: SECRET_VAR
|
||||||
|
# valueFrom:
|
||||||
|
# secretKeyRef:
|
||||||
|
# name: my-secret
|
||||||
|
# key: secret-key
|
||||||
|
extraEnv: []
|
||||||
|
|
||||||
# Master encryption key (required)
|
# Master encryption key (required)
|
||||||
# Generate with: openssl rand -base64 32
|
# Generate with: openssl rand -base64 32
|
||||||
# For production, use an existing Kubernetes Secret
|
# For production, use an existing Kubernetes Secret
|
||||||
|
|||||||
@ -2,11 +2,11 @@ apiVersion: v2
|
|||||||
name: paperless-ngx
|
name: paperless-ngx
|
||||||
description: Paperless-ngx helm chart for Kubernetes
|
description: Paperless-ngx helm chart for Kubernetes
|
||||||
type: application
|
type: application
|
||||||
version: 0.0.2
|
version: 0.0.4
|
||||||
appVersion: "latest"
|
appVersion: "2.20.3"
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: Richard Tomik
|
- name: Richard Tomik
|
||||||
email: no@m.com
|
email: richard.tomik@proton.me
|
||||||
keywords:
|
keywords:
|
||||||
- productivity
|
- productivity
|
||||||
- document-management
|
- document-management
|
||||||
|
|||||||
@ -127,12 +127,16 @@ The following table lists the configurable parameters and their default values.
|
|||||||
| Name | Description | Value |
|
| Name | Description | Value |
|
||||||
|----------------------------------------|--------------------------------------------------------------------|---------------------|
|
|----------------------------------------|--------------------------------------------------------------------|---------------------|
|
||||||
| `persistence.data.enabled` | Enable persistence for data directory | `true` |
|
| `persistence.data.enabled` | Enable persistence for data directory | `true` |
|
||||||
|
| `persistence.data.existingClaim` | Use an existing PVC for data directory | `""` |
|
||||||
| `persistence.data.size` | Size of data PVC | `1Gi` |
|
| `persistence.data.size` | Size of data PVC | `1Gi` |
|
||||||
| `persistence.media.enabled` | Enable persistence for media directory | `true` |
|
| `persistence.media.enabled` | Enable persistence for media directory | `true` |
|
||||||
|
| `persistence.media.existingClaim` | Use an existing PVC for media directory | `""` |
|
||||||
| `persistence.media.size` | Size of media PVC | `10Gi` |
|
| `persistence.media.size` | Size of media PVC | `10Gi` |
|
||||||
| `persistence.consume.enabled` | Enable persistence for consume directory | `true` |
|
| `persistence.consume.enabled` | Enable persistence for consume directory | `true` |
|
||||||
|
| `persistence.consume.existingClaim` | Use an existing PVC for consume directory | `""` |
|
||||||
| `persistence.consume.size` | Size of consume PVC | `5Gi` |
|
| `persistence.consume.size` | Size of consume PVC | `5Gi` |
|
||||||
| `persistence.export.enabled` | Enable persistence for export directory | `true` |
|
| `persistence.export.enabled` | Enable persistence for export directory | `true` |
|
||||||
|
| `persistence.export.existingClaim` | Use an existing PVC for export directory | `""` |
|
||||||
| `persistence.export.size` | Size of export PVC | `1Gi` |
|
| `persistence.export.size` | Size of export PVC | `1Gi` |
|
||||||
|
|
||||||
### Service Parameters
|
### Service Parameters
|
||||||
@ -287,6 +291,37 @@ Paperless-ngx uses several directories:
|
|||||||
|
|
||||||
All directories can be configured with separate PVCs and storage classes.
|
All directories can be configured with separate PVCs and storage classes.
|
||||||
|
|
||||||
|
### Using Existing PVCs
|
||||||
|
|
||||||
|
The chart supports using existing PersistentVolumeClaims instead of creating new ones. This is useful for:
|
||||||
|
- Migrating from an existing Paperless-ngx deployment
|
||||||
|
- Using pre-provisioned storage with specific settings
|
||||||
|
- Sharing volumes across deployments
|
||||||
|
|
||||||
|
To use an existing PVC, specify the `existingClaim` parameter for the relevant volume:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
persistence:
|
||||||
|
data:
|
||||||
|
enabled: true
|
||||||
|
existingClaim: "my-existing-data-pvc"
|
||||||
|
media:
|
||||||
|
enabled: true
|
||||||
|
existingClaim: "my-existing-media-pvc"
|
||||||
|
export:
|
||||||
|
enabled: true
|
||||||
|
existingClaim: "" # Will create new PVC
|
||||||
|
consume:
|
||||||
|
enabled: true
|
||||||
|
existingClaim: "" # Will create new PVC
|
||||||
|
```
|
||||||
|
|
||||||
|
When `existingClaim` is specified:
|
||||||
|
- The chart will **NOT** create a new PVC
|
||||||
|
- The specified PVC must already exist in the same namespace
|
||||||
|
- `storageClass`, `size`, and `accessMode` parameters are ignored for that volume
|
||||||
|
- You can mix existing and new PVCs (some volumes with `existingClaim`, others without)
|
||||||
|
|
||||||
## Uninstalling the Chart
|
## Uninstalling the Chart
|
||||||
|
|
||||||
To uninstall/delete the `paperless-ngx` deployment:
|
To uninstall/delete the `paperless-ngx` deployment:
|
||||||
|
|||||||
@ -92,17 +92,26 @@ Redis port
|
|||||||
Redis URL
|
Redis URL
|
||||||
Constructs the Redis URL with optional authentication.
|
Constructs the Redis URL with optional authentication.
|
||||||
Format: redis://[username]:[password]@host:port/database
|
Format: redis://[username]:[password]@host:port/database
|
||||||
|
When existingSecret is configured, uses environment variable placeholder for password.
|
||||||
*/}}
|
*/}}
|
||||||
{{- define "paperless-ngx.redis.url" -}}
|
{{- define "paperless-ngx.redis.url" -}}
|
||||||
{{- $host := include "paperless-ngx.redis.host" . }}
|
{{- $host := include "paperless-ngx.redis.host" . }}
|
||||||
{{- $port := include "paperless-ngx.redis.port" . }}
|
{{- $port := include "paperless-ngx.redis.port" . }}
|
||||||
{{- $database := .Values.redis.external.database | toString }}
|
{{- $database := .Values.redis.external.database | toString }}
|
||||||
{{- $username := .Values.redis.external.username | default "" }}
|
{{- $username := .Values.redis.external.username | default "" }}
|
||||||
{{- $password := .Values.redis.external.password | default "" }}
|
{{- if .Values.redis.external.existingSecret }}
|
||||||
{{- if and $username $password }}
|
{{- if $username }}
|
||||||
|
{{- printf "redis://%s:$REDIS_PASSWORD@%s:%s/%s" $username $host $port $database }}
|
||||||
|
{{- else }}
|
||||||
|
{{- printf "redis://:$REDIS_PASSWORD@%s:%s/%s" $host $port $database }}
|
||||||
|
{{- end }}
|
||||||
|
{{- else if .Values.redis.external.password }}
|
||||||
|
{{- $password := .Values.redis.external.password }}
|
||||||
|
{{- if $username }}
|
||||||
{{- printf "redis://%s:%s@%s:%s/%s" $username $password $host $port $database }}
|
{{- printf "redis://%s:%s@%s:%s/%s" $username $password $host $port $database }}
|
||||||
{{- else if $password }}
|
{{- else }}
|
||||||
{{- printf "redis://:%s@%s:%s/%s" $password $host $port $database }}
|
{{- printf "redis://:%s@%s:%s/%s" $password $host $port $database }}
|
||||||
|
{{- end }}
|
||||||
{{- else }}
|
{{- else }}
|
||||||
{{- printf "redis://%s:%s/%s" $host $port $database }}
|
{{- printf "redis://%s:%s/%s" $host $port $database }}
|
||||||
{{- end }}
|
{{- end }}
|
||||||
|
|||||||
@ -73,6 +73,16 @@ spec:
|
|||||||
- name: PAPERLESS_REDIS_PREFIX
|
- name: PAPERLESS_REDIS_PREFIX
|
||||||
value: {{ .Values.redis.external.prefix | quote }}
|
value: {{ .Values.redis.external.prefix | quote }}
|
||||||
{{- end }}
|
{{- end }}
|
||||||
|
|
||||||
|
# Redis password from secret (if configured)
|
||||||
|
{{- if or .Values.redis.external.existingSecret .Values.redis.external.password }}
|
||||||
|
- name: REDIS_PASSWORD
|
||||||
|
valueFrom:
|
||||||
|
secretKeyRef:
|
||||||
|
name: {{ .Values.redis.external.existingSecret | default (printf "%s-secrets" (include "paperless-ngx.fullname" .)) }}
|
||||||
|
key: {{ .Values.redis.external.passwordKey | default "redis-password" }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
- name: PAPERLESS_DBHOST
|
- name: PAPERLESS_DBHOST
|
||||||
value: {{ include "paperless-ngx.postgresql.host" . | quote }}
|
value: {{ include "paperless-ngx.postgresql.host" . | quote }}
|
||||||
- name: PAPERLESS_DBPORT
|
- name: PAPERLESS_DBPORT
|
||||||
@ -324,7 +334,7 @@ spec:
|
|||||||
{{- if .Values.persistence.data.enabled }}
|
{{- if .Values.persistence.data.enabled }}
|
||||||
- name: data
|
- name: data
|
||||||
persistentVolumeClaim:
|
persistentVolumeClaim:
|
||||||
claimName: {{ include "paperless-ngx.fullname" . }}-data
|
claimName: {{ if .Values.persistence.data.existingClaim }}{{ .Values.persistence.data.existingClaim }}{{ else }}{{ include "paperless-ngx.fullname" . }}-data{{ end }}
|
||||||
{{- else }}
|
{{- else }}
|
||||||
- name: data
|
- name: data
|
||||||
emptyDir: {}
|
emptyDir: {}
|
||||||
@ -332,7 +342,7 @@ spec:
|
|||||||
{{- if .Values.persistence.media.enabled }}
|
{{- if .Values.persistence.media.enabled }}
|
||||||
- name: media
|
- name: media
|
||||||
persistentVolumeClaim:
|
persistentVolumeClaim:
|
||||||
claimName: {{ include "paperless-ngx.fullname" . }}-media
|
claimName: {{ if .Values.persistence.media.existingClaim }}{{ .Values.persistence.media.existingClaim }}{{ else }}{{ include "paperless-ngx.fullname" . }}-media{{ end }}
|
||||||
{{- else }}
|
{{- else }}
|
||||||
- name: media
|
- name: media
|
||||||
emptyDir: {}
|
emptyDir: {}
|
||||||
@ -340,7 +350,7 @@ spec:
|
|||||||
{{- if .Values.persistence.export.enabled }}
|
{{- if .Values.persistence.export.enabled }}
|
||||||
- name: export
|
- name: export
|
||||||
persistentVolumeClaim:
|
persistentVolumeClaim:
|
||||||
claimName: {{ include "paperless-ngx.fullname" . }}-export
|
claimName: {{ if .Values.persistence.export.existingClaim }}{{ .Values.persistence.export.existingClaim }}{{ else }}{{ include "paperless-ngx.fullname" . }}-export{{ end }}
|
||||||
{{- else }}
|
{{- else }}
|
||||||
- name: export
|
- name: export
|
||||||
emptyDir: {}
|
emptyDir: {}
|
||||||
@ -348,7 +358,7 @@ spec:
|
|||||||
{{- if .Values.persistence.consume.enabled }}
|
{{- if .Values.persistence.consume.enabled }}
|
||||||
- name: consume
|
- name: consume
|
||||||
persistentVolumeClaim:
|
persistentVolumeClaim:
|
||||||
claimName: {{ include "paperless-ngx.fullname" . }}-consume
|
claimName: {{ if .Values.persistence.consume.existingClaim }}{{ .Values.persistence.consume.existingClaim }}{{ else }}{{ include "paperless-ngx.fullname" . }}-consume{{ end }}
|
||||||
{{- else }}
|
{{- else }}
|
||||||
- name: consume
|
- name: consume
|
||||||
emptyDir: {}
|
emptyDir: {}
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
{{- if .Values.persistence.data.enabled }}
|
{{- if and .Values.persistence.data.enabled (not .Values.persistence.data.existingClaim) }}
|
||||||
apiVersion: v1
|
apiVersion: v1
|
||||||
kind: PersistentVolumeClaim
|
kind: PersistentVolumeClaim
|
||||||
metadata:
|
metadata:
|
||||||
@ -21,7 +21,7 @@ spec:
|
|||||||
---
|
---
|
||||||
{{- end }}
|
{{- end }}
|
||||||
|
|
||||||
{{- if .Values.persistence.media.enabled }}
|
{{- if and .Values.persistence.media.enabled (not .Values.persistence.media.existingClaim) }}
|
||||||
apiVersion: v1
|
apiVersion: v1
|
||||||
kind: PersistentVolumeClaim
|
kind: PersistentVolumeClaim
|
||||||
metadata:
|
metadata:
|
||||||
@ -44,7 +44,7 @@ spec:
|
|||||||
---
|
---
|
||||||
{{- end }}
|
{{- end }}
|
||||||
|
|
||||||
{{- if .Values.persistence.export.enabled }}
|
{{- if and .Values.persistence.export.enabled (not .Values.persistence.export.existingClaim) }}
|
||||||
apiVersion: v1
|
apiVersion: v1
|
||||||
kind: PersistentVolumeClaim
|
kind: PersistentVolumeClaim
|
||||||
metadata:
|
metadata:
|
||||||
@ -67,7 +67,7 @@ spec:
|
|||||||
---
|
---
|
||||||
{{- end }}
|
{{- end }}
|
||||||
|
|
||||||
{{- if .Values.persistence.consume.enabled }}
|
{{- if and .Values.persistence.consume.enabled (not .Values.persistence.consume.existingClaim) }}
|
||||||
apiVersion: v1
|
apiVersion: v1
|
||||||
kind: PersistentVolumeClaim
|
kind: PersistentVolumeClaim
|
||||||
metadata:
|
metadata:
|
||||||
|
|||||||
@ -5,7 +5,7 @@ fullnameOverride: ""
|
|||||||
## Image settings
|
## Image settings
|
||||||
image:
|
image:
|
||||||
repository: ghcr.io/paperless-ngx/paperless-ngx
|
repository: ghcr.io/paperless-ngx/paperless-ngx
|
||||||
tag: "2.18.4"
|
tag: "2.20.3"
|
||||||
pullPolicy: IfNotPresent
|
pullPolicy: IfNotPresent
|
||||||
|
|
||||||
## Deployment settings
|
## Deployment settings
|
||||||
@ -65,6 +65,7 @@ persistence:
|
|||||||
# Paperless data directory (search index, classification model, etc.)
|
# Paperless data directory (search index, classification model, etc.)
|
||||||
data:
|
data:
|
||||||
enabled: true
|
enabled: true
|
||||||
|
existingClaim: ""
|
||||||
storageClass: ""
|
storageClass: ""
|
||||||
accessMode: ReadWriteOnce
|
accessMode: ReadWriteOnce
|
||||||
size: 1Gi
|
size: 1Gi
|
||||||
@ -72,6 +73,7 @@ persistence:
|
|||||||
# Paperless media directory (documents and thumbnails)
|
# Paperless media directory (documents and thumbnails)
|
||||||
media:
|
media:
|
||||||
enabled: true
|
enabled: true
|
||||||
|
existingClaim: ""
|
||||||
storageClass: ""
|
storageClass: ""
|
||||||
accessMode: ReadWriteOnce
|
accessMode: ReadWriteOnce
|
||||||
size: 10Gi
|
size: 10Gi
|
||||||
@ -79,6 +81,7 @@ persistence:
|
|||||||
# Export directory (for exporting documents)
|
# Export directory (for exporting documents)
|
||||||
export:
|
export:
|
||||||
enabled: true
|
enabled: true
|
||||||
|
existingClaim: ""
|
||||||
storageClass: ""
|
storageClass: ""
|
||||||
accessMode: ReadWriteOnce
|
accessMode: ReadWriteOnce
|
||||||
size: 1Gi
|
size: 1Gi
|
||||||
@ -86,6 +89,7 @@ persistence:
|
|||||||
# Consume directory (for importing documents)
|
# Consume directory (for importing documents)
|
||||||
consume:
|
consume:
|
||||||
enabled: true
|
enabled: true
|
||||||
|
existingClaim: ""
|
||||||
storageClass: ""
|
storageClass: ""
|
||||||
accessMode: ReadWriteOnce
|
accessMode: ReadWriteOnce
|
||||||
size: 5Gi
|
size: 5Gi
|
||||||
|
|||||||
@ -2,7 +2,7 @@ apiVersion: v2
|
|||||||
name: qbittorrent-vpn
|
name: qbittorrent-vpn
|
||||||
description: qBittorrent with Gluetun VPN sidecar for Kubernetes
|
description: qBittorrent with Gluetun VPN sidecar for Kubernetes
|
||||||
type: application
|
type: application
|
||||||
version: 0.0.1
|
version: 0.0.2
|
||||||
appVersion: 5.1.0
|
appVersion: 5.1.0
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: Richard Tomik
|
- name: Richard Tomik
|
||||||
|
|||||||
@ -222,6 +222,45 @@ gluetun:
|
|||||||
STATUS_FILE: "/tmp/gluetun-status.json"
|
STATUS_FILE: "/tmp/gluetun-status.json"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Custom Sidecar Containers
|
||||||
|
|
||||||
|
The chart supports adding custom sidecar containers to the pod. This is useful for adding additional functionality like port forwarding management (NATMap), monitoring, or other helper containers.
|
||||||
|
|
||||||
|
Sidecars are specified using the standard Kubernetes container specification:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
sidecars:
|
||||||
|
- name: natmap
|
||||||
|
image: ghcr.io/muink/natmap:latest
|
||||||
|
imagePullPolicy: IfNotPresent
|
||||||
|
env:
|
||||||
|
- name: GATEWAY
|
||||||
|
value: "10.2.0.1"
|
||||||
|
- name: INTERFACE
|
||||||
|
value: "tun0"
|
||||||
|
- name: INTERVAL
|
||||||
|
value: "30"
|
||||||
|
volumeMounts:
|
||||||
|
- name: config
|
||||||
|
mountPath: /config
|
||||||
|
subPath: natmap
|
||||||
|
```
|
||||||
|
|
||||||
|
**Common Use Cases:**
|
||||||
|
|
||||||
|
1. **NATMap**: Automatically update port forwarding configurations
|
||||||
|
2. **Monitoring**: Add monitoring agents or exporters
|
||||||
|
3. **Custom Scripts**: Run periodic maintenance or update tasks
|
||||||
|
|
||||||
|
**Sharing Volumes:**
|
||||||
|
|
||||||
|
Sidecars can access the same volumes as the main containers:
|
||||||
|
- `config`: qBittorrent configuration volume
|
||||||
|
- `downloads`: Downloads volume
|
||||||
|
- `gluetun-config`: Gluetun configuration volume (if enabled)
|
||||||
|
|
||||||
|
For the full Kubernetes container specification reference, see the [Kubernetes documentation](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#container-v1-core).
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### VPN Connection Issues
|
### VPN Connection Issues
|
||||||
|
|||||||
@ -255,7 +255,11 @@ spec:
|
|||||||
|
|
||||||
resources:
|
resources:
|
||||||
{{- toYaml .Values.qbittorrent.resources | nindent 12 }}
|
{{- toYaml .Values.qbittorrent.resources | nindent 12 }}
|
||||||
|
|
||||||
|
{{- with .Values.sidecars }}
|
||||||
|
{{- toYaml . | nindent 8 }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
# Create /dev/net/tun as a device
|
# Create /dev/net/tun as a device
|
||||||
- name: tun
|
- name: tun
|
||||||
|
|||||||
@ -225,4 +225,21 @@ extraVolumes: []
|
|||||||
|
|
||||||
# Temporary options for development/debugging
|
# Temporary options for development/debugging
|
||||||
hostNetwork: false
|
hostNetwork: false
|
||||||
initContainers: []
|
initContainers: []
|
||||||
|
|
||||||
|
# Additional sidecar containers
|
||||||
|
# This allows you to add custom sidecar containers to the pod
|
||||||
|
# Each sidecar is specified using standard Kubernetes container spec
|
||||||
|
# Example: Add NATMap for port forwarding with VPN
|
||||||
|
# sidecars:
|
||||||
|
# - name: natmap
|
||||||
|
# image: ghcr.io/muink/natmap:latest
|
||||||
|
# env:
|
||||||
|
# - name: GATEWAY
|
||||||
|
# value: "10.2.0.1"
|
||||||
|
# - name: INTERFACE
|
||||||
|
# value: "tun0"
|
||||||
|
# volumeMounts:
|
||||||
|
# - name: config
|
||||||
|
# mountPath: /config
|
||||||
|
sidecars: []
|
||||||
Reference in New Issue
Block a user