mirror of
https://github.com/rtomik/helm-charts.git
synced 2026-04-05 17:50:38 +00:00
Compare commits
41 Commits
recipya-0.
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 839d5ce530 | |||
| dbfd393db5 | |||
| 0014e7498d | |||
| fe7c741bda | |||
| 55d1ce8377 | |||
| d3cdd77cc6 | |||
| 4c8179f9cc | |||
| 7be50d4890 | |||
| 3a61591220 | |||
| 25265eb94f | |||
| 8e34bd33dd | |||
| 4cb45e3013 | |||
| e65df72663 | |||
| 33f865a892 | |||
| 2ecf4aeec0 | |||
| 720a81d343 | |||
| c9b25918d5 | |||
| c81bb1bbd1 | |||
| 741401a79d | |||
| 509492560e | |||
| af1ecd86cb | |||
| 85b6787314 | |||
| e809d6067d | |||
| 7cb71b046c | |||
| fa186d389d | |||
| cf9632473d | |||
| 7b4e184104 | |||
| c413bc7757 | |||
| 05d7a2b0cd | |||
| 798a167bb3 | |||
| 3df15e3b42 | |||
| 7fa820f284 | |||
| 969cec0318 | |||
| 64e1db727c | |||
| a8f7a3fe07 | |||
| 32cefb046b | |||
| 567fcd4cd0 | |||
| c33421162d | |||
| ea19e1a6cf | |||
| 22353b8049 | |||
| d968f2ae19 |
@ -1,3 +1,4 @@
|
||||
[](https://artifacthub.io/packages/search?repo=rtomik-helm-charts)
|
||||
# helm-charts
|
||||
Repo for helm charts
|
||||
Donetick Helm chart
|
||||
|
||||
@ -9,11 +9,7 @@
|
||||
# when the hash of the last commit in the branch you set up changes. This does
|
||||
# NOT apply to ownership claim operations, which are processed immediately.
|
||||
#
|
||||
repositoryID: 8ec75275-172f-45e9-b188-3b0dd609bee9
|
||||
repositoryID: 11743389-27d2-4d03-a271-1dd96844082f
|
||||
owners: # (optional, used to claim repository ownership)
|
||||
- name: user1
|
||||
email: tomikr7@gmail.com
|
||||
|
||||
ignore: # (optional, packages that should not be indexed by Artifact Hub)
|
||||
- name: donetick # Exact match
|
||||
version: 0.1.0 # Regular expression (when omitted, all versions are ignored)
|
||||
- name: rtomik
|
||||
email: n@gmail.com
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
apiVersion: v2
|
||||
name: donetick
|
||||
description: A Helm chart for Donetick application
|
||||
description: Donetick helm chart for Kubernetes
|
||||
type: application
|
||||
version: 1.0.1
|
||||
appVersion: "latest"
|
||||
version: 1.0.6
|
||||
appVersion: "v0.1.60"
|
||||
maintainers:
|
||||
- name: Richard Tomik
|
||||
email: no@m.com
|
||||
|
||||
@ -6,6 +6,10 @@ A Helm chart for deploying the Donetick task management application on Kubernete
|
||||
|
||||
This chart deploys [Donetick](https://github.com/donetick/donetick) on a Kubernetes cluster using the Helm package manager.
|
||||
|
||||
Source code can be found here:
|
||||
- https://github.com/rtomik/helm-charts/tree/main/charts/donetick
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
@ -23,12 +27,192 @@ $ helm install donetick donetick-chart/donetick
|
||||
|
||||
> **Tip**: List all releases using `helm list`
|
||||
|
||||
## Configuration Examples
|
||||
|
||||
### Basic Installation with SQLite (Default)
|
||||
|
||||
```bash
|
||||
helm install donetick donetick-chart/donetick
|
||||
```
|
||||
|
||||
### Installation with External PostgreSQL
|
||||
|
||||
Create a values file for PostgreSQL configuration:
|
||||
|
||||
```yaml
|
||||
# values-postgres.yaml
|
||||
config:
|
||||
database:
|
||||
type: "postgres"
|
||||
host: "postgresql.database.svc.cluster.local"
|
||||
port: 5432
|
||||
user: "donetick"
|
||||
password: "your-secure-password"
|
||||
name: "donetick"
|
||||
migration: true
|
||||
|
||||
# Update JWT secret for production
|
||||
jwt:
|
||||
secret: "your-secure-jwt-secret-at-least-32-characters-long"
|
||||
|
||||
# Configure server settings
|
||||
server:
|
||||
cors_allow_origins:
|
||||
- "https://your-domain.com"
|
||||
- "http://localhost:5173"
|
||||
|
||||
# Enable features as needed
|
||||
features:
|
||||
notifications: true
|
||||
realtime: true
|
||||
oauth: false
|
||||
|
||||
# Enable ingress for external access
|
||||
ingress:
|
||||
enabled: true
|
||||
className: "nginx"
|
||||
annotations:
|
||||
cert-manager.io/cluster-issuer: "letsencrypt-prod"
|
||||
hosts:
|
||||
- host: donetick.your-domain.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- secretName: donetick-tls
|
||||
hosts:
|
||||
- donetick.your-domain.com
|
||||
|
||||
# Configure persistence
|
||||
persistence:
|
||||
enabled: true
|
||||
storageClass: "fast-ssd"
|
||||
size: "5Gi"
|
||||
```
|
||||
|
||||
Install with PostgreSQL configuration:
|
||||
|
||||
```bash
|
||||
helm install donetick donetick-chart/donetick -f values-postgres.yaml
|
||||
```
|
||||
|
||||
### Production Installation with External Secrets
|
||||
|
||||
For production deployments, use Kubernetes secrets for sensitive data:
|
||||
|
||||
```yaml
|
||||
# values-production.yaml
|
||||
config:
|
||||
database:
|
||||
type: "postgres"
|
||||
host: "postgresql.database.svc.cluster.local"
|
||||
port: 5432
|
||||
name: "donetick"
|
||||
|
||||
# Use existing secret for postgres credentials
|
||||
database:
|
||||
type: "postgres"
|
||||
host: "postgresql.database.svc.cluster.local"
|
||||
port: 5432
|
||||
name: "donetick"
|
||||
secrets:
|
||||
existingSecret: "donetick-postgres-secret"
|
||||
userKey: "username"
|
||||
passwordKey: "password"
|
||||
|
||||
# Use existing secret for JWT
|
||||
jwt:
|
||||
existingSecret: "donetick-jwt-secret"
|
||||
secretKey: "jwt-secret"
|
||||
session_time: "168h"
|
||||
max_refresh: "168h"
|
||||
|
||||
# OAuth2 configuration with secrets
|
||||
oauth2:
|
||||
existingSecret: "donetick-oauth-secret"
|
||||
clientIdKey: "client-id"
|
||||
clientSecretKey: "client-secret"
|
||||
auth_url: "https://your-oauth-provider.com/auth"
|
||||
token_url: "https://your-oauth-provider.com/token"
|
||||
user_info_url: "https://your-oauth-provider.com/userinfo"
|
||||
redirect_url: "https://donetick.your-domain.com/auth/callback"
|
||||
|
||||
# Production server settings
|
||||
server:
|
||||
cors_allow_origins:
|
||||
- "https://donetick.your-domain.com"
|
||||
rate_limit: 100
|
||||
rate_period: "60s"
|
||||
|
||||
# Enable production features
|
||||
features:
|
||||
notifications: true
|
||||
realtime: true
|
||||
oauth: true
|
||||
|
||||
# Security context for production
|
||||
podSecurityContext:
|
||||
runAsNonRoot: true
|
||||
runAsUser: 1000
|
||||
fsGroup: 1000
|
||||
|
||||
# Resource limits for production
|
||||
resources:
|
||||
limits:
|
||||
cpu: 500m
|
||||
memory: 512Mi
|
||||
requests:
|
||||
cpu: 100m
|
||||
memory: 128Mi
|
||||
|
||||
# Ingress with TLS
|
||||
ingress:
|
||||
enabled: true
|
||||
className: "nginx"
|
||||
annotations:
|
||||
nginx.ingress.kubernetes.io/ssl-redirect: "true"
|
||||
cert-manager.io/cluster-issuer: "letsencrypt-prod"
|
||||
hosts:
|
||||
- host: donetick.your-domain.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- secretName: donetick-tls
|
||||
hosts:
|
||||
- donetick.your-domain.com
|
||||
```
|
||||
|
||||
Create the required secrets:
|
||||
|
||||
```bash
|
||||
# Postgres secret
|
||||
kubectl create secret generic donetick-postgres-secret \
|
||||
--from-literal=username='donetick' \
|
||||
--from-literal=password='your-secure-db-password'
|
||||
|
||||
# JWT secret
|
||||
kubectl create secret generic donetick-jwt-secret \
|
||||
--from-literal=jwt-secret='your-very-secure-jwt-secret-at-least-32-characters-long'
|
||||
|
||||
# OAuth secret (if using OAuth)
|
||||
kubectl create secret generic donetick-oauth-secret \
|
||||
--from-literal=client-id='your-oauth-client-id' \
|
||||
--from-literal=client-secret='your-oauth-client-secret'
|
||||
```
|
||||
|
||||
Install with production configuration:
|
||||
|
||||
```bash
|
||||
helm install donetick donetick-chart/donetick -f values-production.yaml
|
||||
```
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall/delete the `donetick` deployment:
|
||||
|
||||
```bash
|
||||
$ helm uninstall donetick
|
||||
helm uninstall donetick
|
||||
```
|
||||
|
||||
## Parameters
|
||||
@ -45,7 +229,7 @@ $ helm uninstall donetick
|
||||
| Name | Description | Value |
|
||||
|-------------------------|--------------------------------------------------------------------------------------|--------------------|
|
||||
| `image.repository` | Donetick image repository | `donetick/donetick` |
|
||||
| `image.tag` | Donetick image tag | `latest` |
|
||||
| `image.tag` | Donetick image tag | `v0.1.60` |
|
||||
| `image.pullPolicy` | Donetick image pull policy | `IfNotPresent` |
|
||||
| `imagePullSecrets` | Global Docker registry secret names as an array | `[]` |
|
||||
|
||||
@ -58,12 +242,9 @@ $ helm uninstall donetick
|
||||
| `config.oauth2.existingSecret` | Name of existing secret for OAuth2 credentials | `""` |
|
||||
| `config.oauth2.clientIdKey` | Key in the existing secret for OAuth2 client ID | `"client-id"` |
|
||||
| `config.oauth2.clientSecretKey` | Key in the existing secret for OAuth2 client secret | `"client-secret"` |
|
||||
| `config.database.existingSecret` | Name of existing secret for database credentials | `""` |
|
||||
| `config.database.hostKey` | Key in the existing secret for database host | `"db-host"` |
|
||||
| `config.database.portKey` | Key in the existing secret for database port | `"db-port"` |
|
||||
| `config.database.userKey` | Key in the existing secret for database user | `"db-user"` |
|
||||
| `config.database.passwordKey` | Key in the existing secret for database password | `"db-password"` |
|
||||
| `config.database.nameKey` | Key in the existing secret for database name | `"db-name"` |
|
||||
| `config.database.secrets.existingSecret` | Name of existing secret for postgres credentials | `""` |
|
||||
| `config.database.secrets.userKey` | Key in the existing secret for postgres username | `"username"` |
|
||||
| `config.database.secrets.passwordKey` | Key in the existing secret for postgres password | `"password"` |
|
||||
|
||||
### Deployment parameters
|
||||
|
||||
@ -86,7 +267,12 @@ $ helm uninstall donetick
|
||||
| `service.type` | Kubernetes Service type | `ClusterIP` |
|
||||
| `service.port` | Service HTTP port | `2021` |
|
||||
| `service.annotations` | Additional annotations for Service | `{}` |
|
||||
| `service.nodePort` | Service HTTP node port (when applicable) | `""` |
|
||||
|
||||
### Pod Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------|------------------------------------------------------|-------------|
|
||||
| `podAnnotations` | Additional annotations for pods | `{}` |
|
||||
|
||||
### Ingress parameters
|
||||
|
||||
@ -104,7 +290,174 @@ $ helm uninstall donetick
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------|------------------------------------------------------|---------------|
|
||||
| `persistence.enabled` | Enable persistence using PVC | `true` |
|
||||
| `persistence.storageClass` | PVC Storage Class | `"longhorn"` |
|
||||
| `persistence.enabled` | Enable persistence using PVC | `false` |
|
||||
| `persistence.storageClass` | PVC Storage Class | `""` |
|
||||
| `persistence.accessMode` | PVC Access Mode | `ReadWriteOnce` |
|
||||
| `persistence.size` |
|
||||
| `persistence.size` | PVC Size | `1Gi` |
|
||||
|
||||
### Health Checks
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|------------------------------------------------------|---------------|
|
||||
| `probes.startup.enabled` | Enable startup probe | `true` |
|
||||
| `probes.startup.initialDelaySeconds` | Initial delay for startup probe | `10` |
|
||||
| `probes.startup.periodSeconds` | Period for startup probe | `10` |
|
||||
| `probes.startup.failureThreshold` | Failure threshold for startup probe | `30` |
|
||||
| `probes.liveness.enabled` | Enable liveness probe | `true` |
|
||||
| `probes.liveness.initialDelaySeconds` | Initial delay for liveness probe | `30` |
|
||||
| `probes.liveness.periodSeconds` | Period for liveness probe | `10` |
|
||||
| `probes.readiness.enabled` | Enable readiness probe | `true` |
|
||||
| `probes.readiness.initialDelaySeconds` | Initial delay for readiness probe | `5` |
|
||||
| `probes.readiness.periodSeconds` | Period for readiness probe | `5` |
|
||||
|
||||
### Application Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|------------------------------------------------------|---------------|
|
||||
| `config.name` | Application name | `selfhosted` |
|
||||
| `config.is_done_tick_dot_com` | Enable donetick.com features | `false` |
|
||||
| `config.is_user_creation_disabled` | Disable user registration | `false` |
|
||||
|
||||
### Real-time Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|------------------------------------------------------|---------------|
|
||||
| `config.realtime.max_connections` | Maximum WebSocket connections | `100` |
|
||||
| `config.realtime.ping_interval` | WebSocket ping interval | `30s` |
|
||||
| `config.realtime.pong_wait` | WebSocket pong wait timeout | `60s` |
|
||||
| `config.realtime.write_wait` | WebSocket write timeout | `10s` |
|
||||
| `config.realtime.max_message_size` | Maximum WebSocket message size | `512` |
|
||||
|
||||
### Database Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|------------------------------------------------------|---------------|
|
||||
| `config.database.type` | Database type (sqlite or postgres) | `sqlite` |
|
||||
| `config.database.migration` | Enable database migrations | `true` |
|
||||
| `config.database.host` | PostgreSQL host (when type=postgres) | `""` |
|
||||
| `config.database.port` | PostgreSQL port (when type=postgres) | `5432` |
|
||||
| `config.database.user` | PostgreSQL user (when type=postgres) | `""` |
|
||||
| `config.database.password` | PostgreSQL password (when type=postgres) | `""` |
|
||||
| `config.database.name` | PostgreSQL database name (when type=postgres) | `""` |
|
||||
|
||||
### JWT Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|------------------------------------------------------|---------------|
|
||||
| `config.jwt.secret` | JWT signing secret | `changeme-this-secret-should-be-at-least-32-characters-long` |
|
||||
| `config.jwt.session_time` | JWT session duration | `168h` |
|
||||
| `config.jwt.max_refresh` | JWT maximum refresh duration | `168h` |
|
||||
|
||||
### Server Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|------------------------------------------------------|---------------|
|
||||
| `config.server.port` | Server port | `2021` |
|
||||
| `config.server.read_timeout` | Server read timeout | `10s` |
|
||||
| `config.server.write_timeout` | Server write timeout | `10s` |
|
||||
| `config.server.rate_period` | Rate limiting period | `60s` |
|
||||
| `config.server.rate_limit` | Rate limiting requests per period | `300` |
|
||||
| `config.server.serve_frontend` | Serve frontend files | `true` |
|
||||
|
||||
### Feature Flags
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|------------------------------------------------------|---------------|
|
||||
| `config.features.notifications` | Enable notifications | `true` |
|
||||
| `config.features.realtime` | Enable real-time features | `true` |
|
||||
| `config.features.oauth` | Enable OAuth authentication | `false` |
|
||||
|
||||
## Database Setup
|
||||
|
||||
### PostgreSQL Requirements
|
||||
|
||||
When using PostgreSQL, ensure you have:
|
||||
|
||||
1. **Database Created**: Create a database for Donetick
|
||||
```sql
|
||||
CREATE DATABASE donetick;
|
||||
CREATE USER donetick WITH PASSWORD 'your-secure-password';
|
||||
GRANT ALL PRIVILEGES ON DATABASE donetick TO donetick;
|
||||
```
|
||||
|
||||
2. **Network Access**: Ensure Donetick can reach your PostgreSQL instance
|
||||
3. **Proper Credentials**: Configure database credentials in values or secrets
|
||||
|
||||
### Database Migration
|
||||
|
||||
Donetick automatically runs database migrations on startup when `config.database.migration: true`. For production:
|
||||
|
||||
1. **Review Migrations**: Check what migrations will be applied
|
||||
2. **Backup Database**: Always backup before running migrations
|
||||
3. **Monitor Startup**: Watch pod logs during initial deployment
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### 1. Real-time Configuration Panic
|
||||
**Error**: `Invalid real-time configuration: maxConnections must be positive, got 0`
|
||||
|
||||
**Solution**: Ensure the real-time configuration is properly set:
|
||||
```yaml
|
||||
config:
|
||||
realtime:
|
||||
max_connections: 100 # Must be > 0
|
||||
```
|
||||
|
||||
#### 2. Database Connection Issues
|
||||
**Error**: Database connection failures
|
||||
|
||||
**Solutions**:
|
||||
- Verify PostgreSQL is running and accessible
|
||||
- Check database credentials in secrets
|
||||
- Ensure database name exists
|
||||
- Verify network policies allow connection
|
||||
|
||||
#### 3. JWT Secret Issues
|
||||
**Error**: JWT authentication failures
|
||||
|
||||
**Solution**: Ensure JWT secret is at least 32 characters:
|
||||
```yaml
|
||||
config:
|
||||
jwt:
|
||||
secret: "your-very-secure-jwt-secret-at-least-32-characters-long"
|
||||
```
|
||||
|
||||
#### 4. CORS Issues
|
||||
**Error**: Cross-origin request blocked
|
||||
|
||||
**Solution**: Configure CORS origins:
|
||||
```yaml
|
||||
config:
|
||||
server:
|
||||
cors_allow_origins:
|
||||
- "https://your-domain.com"
|
||||
- "http://localhost:5173"
|
||||
```
|
||||
|
||||
### Debugging
|
||||
|
||||
Check application logs:
|
||||
```bash
|
||||
kubectl logs deployment/donetick -f
|
||||
```
|
||||
|
||||
Check configuration:
|
||||
```bash
|
||||
kubectl get configmap donetick-configmap -o yaml
|
||||
```
|
||||
|
||||
Verify secrets:
|
||||
```bash
|
||||
kubectl get secret donetick-secrets -o yaml
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Please feel free to contribute by opening issues or pull requests at:
|
||||
https://github.com/rtomik/helm-charts
|
||||
|
||||
## License
|
||||
|
||||
This Helm chart is licensed under the MIT License.
|
||||
|
||||
@ -22,15 +22,18 @@ data:
|
||||
{{- if .Values.config.database.migration_retry }}
|
||||
migration_retry: {{ .Values.config.database.migration_retry }}
|
||||
{{- end }}
|
||||
migration_timeout: {{ .Values.config.database.migration_timeout | default "300s" | quote }}
|
||||
{{- if eq .Values.config.database.type "postgres" }}
|
||||
{{- if not .Values.config.database.existingSecret }}
|
||||
host: {{ .Values.config.database.host | quote }}
|
||||
port: {{ .Values.config.database.port }}
|
||||
name: {{ .Values.config.database.name | quote }}
|
||||
{{- if not .Values.config.database.secrets.existingSecret }}
|
||||
user: {{ .Values.config.database.user | quote }}
|
||||
password: {{ .Values.config.database.password | quote }}
|
||||
name: {{ .Values.config.database.name | quote }}
|
||||
{{- else }}
|
||||
# Database credentials will be injected via environment variables from Secret
|
||||
# Reference environment variables for database credentials
|
||||
user: "$DT_DATABASE_USER"
|
||||
password: "$DT_DATABASE_PASSWORD"
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
jwt:
|
||||
@ -74,4 +77,20 @@ data:
|
||||
token_url: {{ .Values.config.oauth2.token_url | default "" | quote }}
|
||||
user_info_url: {{ .Values.config.oauth2.user_info_url | default "" | quote }}
|
||||
redirect_url: {{ .Values.config.oauth2.redirect_url | default "" | quote }}
|
||||
name: {{ .Values.config.oauth2.name | default "" | quote }}
|
||||
name: {{ .Values.config.oauth2.name | default "" | quote }}
|
||||
realtime:
|
||||
max_connections: {{ .Values.config.realtime.max_connections }}
|
||||
ping_interval: {{ .Values.config.realtime.ping_interval | quote }}
|
||||
pong_wait: {{ .Values.config.realtime.pong_wait | quote }}
|
||||
write_wait: {{ .Values.config.realtime.write_wait | quote }}
|
||||
max_message_size: {{ .Values.config.realtime.max_message_size }}
|
||||
logging:
|
||||
level: {{ .Values.config.logging.level | quote }}
|
||||
format: {{ .Values.config.logging.format | quote }}
|
||||
storage:
|
||||
type: {{ .Values.config.storage.type | quote }}
|
||||
path: {{ .Values.config.storage.path | quote }}
|
||||
features:
|
||||
notifications: {{ .Values.config.features.notifications }}
|
||||
realtime: {{ .Values.config.features.realtime }}
|
||||
oauth: {{ .Values.config.features.oauth }}
|
||||
@ -50,6 +50,17 @@ spec:
|
||||
- name: http
|
||||
containerPort: {{ .Values.config.server.port }}
|
||||
protocol: TCP
|
||||
{{- if .Values.probes.startup.enabled }}
|
||||
startupProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.startup.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.startup.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.startup.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.startup.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.startup.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.startup.successThreshold }}
|
||||
{{- end }}
|
||||
{{- if .Values.probes.liveness.enabled }}
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
@ -77,15 +88,44 @@ spec:
|
||||
- name: {{ .name }}
|
||||
value: {{ .value | quote }}
|
||||
{{- end }}
|
||||
{{- if or .Values.config.jwt.existingSecret .Values.config.oauth2.existingSecret .Values.config.database.existingSecret }}
|
||||
# Secret-based environment variables
|
||||
# Database configuration environment variables
|
||||
{{- if eq .Values.config.database.type "postgres" }}
|
||||
- name: DT_DATABASE_TYPE
|
||||
value: "postgres"
|
||||
- name: DT_DATABASE_HOST
|
||||
value: {{ .Values.config.database.host | quote }}
|
||||
- name: DT_DATABASE_PORT
|
||||
value: {{ .Values.config.database.port | quote }}
|
||||
- name: DT_DATABASE_NAME
|
||||
value: {{ .Values.config.database.name | quote }}
|
||||
{{- if .Values.config.database.secrets.existingSecret }}
|
||||
- name: DT_DATABASE_USER
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.database.secrets.existingSecret }}
|
||||
key: {{ .Values.config.database.secrets.userKey }}
|
||||
- name: DT_DATABASE_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.database.secrets.existingSecret }}
|
||||
key: {{ .Values.config.database.secrets.passwordKey }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
- name: DT_DATABASE_TYPE
|
||||
value: {{ .Values.config.database.type | quote }}
|
||||
{{- end }}
|
||||
# JWT configuration
|
||||
{{- if .Values.config.jwt.existingSecret }}
|
||||
- name: DT_JWT_SECRET
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.jwt.existingSecret }}
|
||||
key: {{ .Values.config.jwt.secretKey }}
|
||||
{{- else }}
|
||||
- name: DT_JWT_SECRET
|
||||
value: {{ .Values.config.jwt.secret | quote }}
|
||||
{{- end }}
|
||||
# OAuth2 configuration
|
||||
{{- if .Values.config.oauth2.existingSecret }}
|
||||
- name: DT_OAUTH2_CLIENT_ID
|
||||
valueFrom:
|
||||
@ -98,34 +138,6 @@ spec:
|
||||
name: {{ .Values.config.oauth2.existingSecret }}
|
||||
key: {{ .Values.config.oauth2.clientSecretKey }}
|
||||
{{- end }}
|
||||
{{- if and .Values.config.database.existingSecret (eq .Values.config.database.type "postgres") }}
|
||||
- name: DT_DB_HOST
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.database.existingSecret }}
|
||||
key: {{ .Values.config.database.hostKey }}
|
||||
- name: DT_DB_PORT
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.database.existingSecret }}
|
||||
key: {{ .Values.config.database.portKey }}
|
||||
- name: DT_DB_USER
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.database.existingSecret }}
|
||||
key: {{ .Values.config.database.userKey }}
|
||||
- name: DT_DB_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.database.existingSecret }}
|
||||
key: {{ .Values.config.database.passwordKey }}
|
||||
- name: DT_DB_NAME
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.database.existingSecret }}
|
||||
key: {{ .Values.config.database.nameKey }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- with .Values.extraEnv }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
@ -148,9 +160,14 @@ spec:
|
||||
- name: config
|
||||
configMap:
|
||||
name: {{ include "donetick.fullname" . }}-configmap
|
||||
{{- if .Values.persistence.enabled }}
|
||||
- name: data
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ include "donetick.fullname" . }}-data
|
||||
{{- else }}
|
||||
- name: data
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
{{- if not .Values.containerSecurityContext.readOnlyRootFilesystem }}
|
||||
- name: tmp
|
||||
emptyDir: {}
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
{{- if or (not .Values.config.jwt.existingSecret) (and (not .Values.config.oauth2.existingSecret) (or .Values.config.oauth2.client_id .Values.config.oauth2.client_secret)) (and (eq .Values.config.database.type "postgres") (not .Values.config.database.existingSecret)) }}
|
||||
{{- if or (not .Values.config.jwt.existingSecret) (and (not .Values.config.oauth2.existingSecret) (or .Values.config.oauth2.client_id .Values.config.oauth2.client_secret)) (and (eq .Values.config.database.type "postgres") (not .Values.config.database.secrets.existingSecret)) }}
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
@ -10,8 +10,8 @@ data:
|
||||
{{- if not .Values.config.jwt.existingSecret }}
|
||||
{{ .Values.config.jwt.secretKey }}: {{ .Values.config.jwt.secret | b64enc }}
|
||||
{{- end }}
|
||||
{{- if and (eq .Values.config.database.type "postgres") (not .Values.config.database.existingSecret) }}
|
||||
{{ .Values.config.database.passwordKey }}: {{ .Values.config.database.password | b64enc }}
|
||||
{{- if and (eq .Values.config.database.type "postgres") (not .Values.config.database.secrets.existingSecret) }}
|
||||
{{ .Values.config.database.secrets.passwordKey }}: {{ .Values.config.database.password | b64enc }}
|
||||
{{- end }}
|
||||
{{- if and (not .Values.config.oauth2.existingSecret) .Values.config.oauth2.client_id }}
|
||||
{{ .Values.config.oauth2.clientIdKey }}: {{ .Values.config.oauth2.client_id | b64enc }}
|
||||
|
||||
@ -4,6 +4,10 @@ metadata:
|
||||
name: {{ include "donetick.fullname" . }}
|
||||
labels:
|
||||
{{- include "donetick.labels" . | nindent 4 }}
|
||||
{{- with .Values.service.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
type: {{ .Values.service.type }}
|
||||
ports:
|
||||
|
||||
@ -5,8 +5,10 @@ fullnameOverride: ""
|
||||
## Image settings
|
||||
image:
|
||||
repository: donetick/donetick
|
||||
tag: latest
|
||||
tag: "v0.1.60"
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
imagePullSecrets: []
|
||||
|
||||
## Deployment settings
|
||||
replicaCount: 1
|
||||
@ -34,15 +36,19 @@ nodeSelector: {}
|
||||
tolerations: []
|
||||
affinity: {}
|
||||
|
||||
## Pod annotations
|
||||
podAnnotations: {}
|
||||
|
||||
## Service settings
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 2021
|
||||
annotations: {}
|
||||
|
||||
## Ingress settings
|
||||
ingress:
|
||||
enabled: true
|
||||
className: "traefik"
|
||||
enabled: false
|
||||
className: ""
|
||||
annotations:
|
||||
traefik.ingress.kubernetes.io/router.entrypoints: websecure
|
||||
hosts:
|
||||
@ -58,8 +64,8 @@ ingress:
|
||||
|
||||
## Persistence settings
|
||||
persistence:
|
||||
enabled: true
|
||||
storageClass: "longhorn"
|
||||
enabled: false
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 1Gi
|
||||
annotations: {}
|
||||
@ -85,16 +91,28 @@ extraVolumeMounts: []
|
||||
extraVolumes: []
|
||||
|
||||
## Resource limits and requests
|
||||
resources:
|
||||
limits:
|
||||
cpu: 500m
|
||||
memory: 512Mi
|
||||
requests:
|
||||
cpu: 100m
|
||||
memory: 128Mi
|
||||
resources: {}
|
||||
# We usually recommend not to specify default resources and to leave this as a conscious
|
||||
# choice for the user. This also increases chances charts run on environments with little
|
||||
# resources, such as Minikube. If you do want to specify resources, uncomment the following
|
||||
# lines, adjust them as necessary, and remove the curly braces after 'resources:'.
|
||||
# limits:
|
||||
# cpu: 500m
|
||||
# memory: 512Mi
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 128Mi
|
||||
|
||||
## Application health checks
|
||||
probes:
|
||||
startup:
|
||||
enabled: true
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 15
|
||||
timeoutSeconds: 15
|
||||
failureThreshold: 80
|
||||
successThreshold: 1
|
||||
path: /health
|
||||
liveness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 30
|
||||
@ -139,21 +157,18 @@ config:
|
||||
# Migration options
|
||||
migration_skip: false # Set to true to skip database migrations
|
||||
migration_retry: 3 # Number of retries for failed migrations
|
||||
|
||||
# These are only required for postgres - direct configuration
|
||||
migration_timeout: "600s" # Timeout for database migrations (default: 10 minutes)
|
||||
|
||||
# These are only required for postgres
|
||||
host: ""
|
||||
port: 5432
|
||||
user: ""
|
||||
password: ""
|
||||
name: ""
|
||||
|
||||
# Secret configuration for database credentials
|
||||
existingSecret: "" # Name of existing Kubernetes secret
|
||||
hostKey: "db-host" # Key in the secret for database host
|
||||
portKey: "db-port" # Key in the secret for database port
|
||||
userKey: "db-user" # Key in the secret for database user
|
||||
passwordKey: "db-password" # Key in the secret for database password
|
||||
nameKey: "db-name" # Key in the secret for database name
|
||||
|
||||
# Secret configuration for postgres credentials
|
||||
secrets:
|
||||
existingSecret: "" # Name of existing Kubernetes secret containing postgres credentials
|
||||
userKey: "username" # Key in the secret for database username
|
||||
passwordKey: "password" # Key in the secret for database password
|
||||
|
||||
# Security settings
|
||||
# For production, use a generated secret and store in a Kubernetes Secret
|
||||
@ -207,4 +222,28 @@ config:
|
||||
token_url: ""
|
||||
user_info_url: ""
|
||||
redirect_url: ""
|
||||
name: ""
|
||||
name: ""
|
||||
|
||||
# Real-time configuration
|
||||
realtime:
|
||||
max_connections: 100
|
||||
ping_interval: "30s"
|
||||
pong_wait: "60s"
|
||||
write_wait: "10s"
|
||||
max_message_size: 512
|
||||
|
||||
# Logging configuration
|
||||
logging:
|
||||
level: "info"
|
||||
format: "json"
|
||||
|
||||
# Storage configuration
|
||||
storage:
|
||||
type: "local"
|
||||
path: "/donetick-data/uploads"
|
||||
|
||||
# Feature flags
|
||||
features:
|
||||
notifications: true
|
||||
realtime: true
|
||||
oauth: false
|
||||
16
charts/jellyseerr/Chart.yaml
Normal file
16
charts/jellyseerr/Chart.yaml
Normal file
@ -0,0 +1,16 @@
|
||||
apiVersion: v2
|
||||
name: jellyseerr
|
||||
description: Jellyseerr helm chart for Kubernetes
|
||||
type: application
|
||||
version: 0.0.1
|
||||
appVersion: 2.5.2
|
||||
maintainers:
|
||||
- name: Richard Tomik
|
||||
email: no@m.com
|
||||
keywords:
|
||||
- jellyseerr
|
||||
- jellyfin
|
||||
- media-requests
|
||||
home: https://github.com/rtomik/helm-charts
|
||||
sources:
|
||||
- https://github.com/fallenbagel/jellyseerr
|
||||
32
charts/jellyseerr/NOTES.txt
Normal file
32
charts/jellyseerr/NOTES.txt
Normal file
@ -0,0 +1,32 @@
|
||||
1. Get the application URL by running these commands:
|
||||
{{- if .Values.ingress.enabled }}
|
||||
{{- range $host := .Values.ingress.hosts }}
|
||||
{{- range .paths }}
|
||||
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- else if contains "NodePort" .Values.service.type }}
|
||||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "jellyseerr.fullname" . }})
|
||||
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
|
||||
echo http://$NODE_IP:$NODE_PORT
|
||||
{{- else if contains "LoadBalancer" .Values.service.type }}
|
||||
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
|
||||
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "jellyseerr.fullname" . }}'
|
||||
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "jellyseerr.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
|
||||
echo http://$SERVICE_IP:{{ .Values.service.port }}
|
||||
{{- else if contains "ClusterIP" .Values.service.type }}
|
||||
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "jellyseerr.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
|
||||
export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
|
||||
echo "Visit http://127.0.0.1:8080 to use your application"
|
||||
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
|
||||
{{- end }}
|
||||
|
||||
2. Jellyseerr will be available at port {{ .Values.service.port }}
|
||||
|
||||
{{- if .Values.persistence.enabled }}
|
||||
3. Data is persisted using PVC: {{ if .Values.persistence.existingClaim }}{{ .Values.persistence.existingClaim }}{{ else }}{{ include "jellyseerr.fullname" . }}-config{{ end }}
|
||||
{{- else }}
|
||||
3. WARNING: No persistence enabled. Data will be lost when pods are restarted.
|
||||
{{- end }}
|
||||
|
||||
For more information about using this Helm chart, please refer to the README.md file.
|
||||
145
charts/jellyseerr/readme.md
Normal file
145
charts/jellyseerr/readme.md
Normal file
@ -0,0 +1,145 @@
|
||||
# Jellyseerr Helm Chart
|
||||
|
||||
A Helm chart for deploying [Jellyseerr](https://github.com/fallenbagel/jellyseerr) on Kubernetes.
|
||||
|
||||
## Introduction
|
||||
|
||||
This chart deploys Jellyseerr on a Kubernetes cluster using the Helm package manager. Jellyseerr is a fork of Overseerr for Jellyfin support.
|
||||
|
||||
Source code can be found here:
|
||||
- https://github.com/rtomik/helm-charts/tree/main/charts/jellyseerr
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
- Helm 3.0+
|
||||
- PV provisioner support in the underlying infrastructure (if persistence is needed)
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `jellyseerr`:
|
||||
|
||||
```bash
|
||||
helm repo add rtomik-charts https://rtomik.github.io/helm-charts
|
||||
helm install jellyseerr rtomik-charts/jellyseerr
|
||||
```
|
||||
|
||||
> **Tip**: List all releases using `helm list`
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall/delete the `jellyseerr` deployment:
|
||||
|
||||
```bash
|
||||
helm uninstall jellyseerr
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
### Global parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------------------------|---------------------------------------------------------------|--------|
|
||||
| `nameOverride` | String to partially override the release name | `""` |
|
||||
| `fullnameOverride` | String to fully override the release name | `""` |
|
||||
|
||||
### Image parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------|--------------------------------------------------------------|--------------------------------|
|
||||
| `image.repository` | Jellyseerr image repository | `ghcr.io/fallenbagel/jellyseerr` |
|
||||
| `image.tag` | Jellyseerr image tag | `latest` |
|
||||
| `image.pullPolicy` | Jellyseerr image pull policy | `IfNotPresent` |
|
||||
| `imagePullSecrets` | Global Docker registry secret names as an array | `[]` |
|
||||
|
||||
### Deployment parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------------------|--------------------------------------------------|-----------|
|
||||
| `replicaCount` | Number of Jellyseerr replicas | `1` |
|
||||
| `revisionHistoryLimit` | Number of revisions to retain for rollback | `3` |
|
||||
| `podSecurityContext.runAsNonRoot` | Run containers as non-root user | `true` |
|
||||
| `podSecurityContext.runAsUser` | User ID for the container | `1000` |
|
||||
| `podSecurityContext.fsGroup` | Group ID for the container filesystem | `1000` |
|
||||
| `containerSecurityContext` | Security context for the container | See values.yaml |
|
||||
| `nodeSelector` | Node labels for pod assignment | `{}` |
|
||||
| `tolerations` | Tolerations for pod assignment | `[]` |
|
||||
| `affinity` | Affinity for pod assignment | `{}` |
|
||||
|
||||
### Service parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------|----------------------------------------------|-------------|
|
||||
| `service.type` | Kubernetes Service type | `ClusterIP` |
|
||||
| `service.port` | Service HTTP port | `5055` |
|
||||
|
||||
### Ingress parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------|----------------------------------------------|------------------------|
|
||||
| `ingress.enabled` | Enable ingress record generation | `false` |
|
||||
| `ingress.className` | IngressClass name | `""` |
|
||||
| `ingress.annotations` | Additional annotations for the Ingress resource | `{}` |
|
||||
| `ingress.hosts` | Array of host and path objects | See values.yaml |
|
||||
| `ingress.tls` | TLS configuration | `[]` |
|
||||
|
||||
### Persistence parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------|----------------------------------------------|-----------------|
|
||||
| `persistence.enabled` | Enable persistence using PVC | `true` |
|
||||
| `persistence.existingClaim` | Use an existing PVC | `""` |
|
||||
| `persistence.storageClass` | PVC Storage Class | `""` |
|
||||
| `persistence.accessMode` | PVC Access Mode | `ReadWriteOnce` |
|
||||
| `persistence.size` | PVC Storage Size | `1Gi` |
|
||||
| `persistence.annotations` | Additional custom annotations for the PVC | `{}` |
|
||||
|
||||
### Environment variables
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------|----------------------------------------------|-----------------|
|
||||
| `env` | Environment variables for Jellyseerr | See values.yaml |
|
||||
| `extraEnv` | Additional environment variables | `[]` |
|
||||
|
||||
### Resources parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------|----------------------------------------------|-----------------|
|
||||
| `resources.limits` | The resources limits for containers | See values.yaml |
|
||||
| `resources.requests` | The resources requests for containers | See values.yaml |
|
||||
|
||||
## Configuration
|
||||
|
||||
The following table lists the configurable parameters of the Jellyseerr chart and their default values.
|
||||
|
||||
### Environment Variables
|
||||
|
||||
You can configure Jellyseerr by setting environment variables:
|
||||
|
||||
```yaml
|
||||
env:
|
||||
- name: TZ
|
||||
value: "America/New_York"
|
||||
- name: LOG_LEVEL
|
||||
value: "info"
|
||||
- name: PORT
|
||||
value: "5055"
|
||||
```
|
||||
|
||||
### Using Persistence
|
||||
|
||||
By default, persistence is enabled with a 1Gi volume:
|
||||
|
||||
```yaml
|
||||
persistence:
|
||||
enabled: true
|
||||
size: 1Gi
|
||||
```
|
||||
|
||||
You can also use an existing PVC:
|
||||
|
||||
```yaml
|
||||
persistence:
|
||||
enabled: true
|
||||
existingClaim: my-jellyseerr-pvc
|
||||
```
|
||||
45
charts/jellyseerr/templates/_helpers.tpl
Normal file
45
charts/jellyseerr/templates/_helpers.tpl
Normal file
@ -0,0 +1,45 @@
|
||||
{{/*
|
||||
Expand the name of the chart.
|
||||
*/}}
|
||||
{{- define "jellyseerr.name" -}}
|
||||
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create a default fully qualified app name.
|
||||
*/}}
|
||||
{{- define "jellyseerr.fullname" -}}
|
||||
{{- if .Values.fullnameOverride }}
|
||||
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- else }}
|
||||
{{- $name := default .Chart.Name .Values.nameOverride }}
|
||||
{{- printf "%s" $name | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create chart name and version as used by the chart label.
|
||||
*/}}
|
||||
{{- define "jellyseerr.chart" -}}
|
||||
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Common labels
|
||||
*/}}
|
||||
{{- define "jellyseerr.labels" -}}
|
||||
helm.sh/chart: {{ include "jellyseerr.chart" . }}
|
||||
{{ include "jellyseerr.selectorLabels" . }}
|
||||
{{- if .Chart.AppVersion }}
|
||||
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
|
||||
{{- end }}
|
||||
app.kubernetes.io/managed-by: {{ .Release.Service }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Selector labels
|
||||
*/}}
|
||||
{{- define "jellyseerr.selectorLabels" -}}
|
||||
app.kubernetes.io/name: {{ include "jellyseerr.name" . }}
|
||||
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||
{{- end }}
|
||||
107
charts/jellyseerr/templates/deployment.yaml
Normal file
107
charts/jellyseerr/templates/deployment.yaml
Normal file
@ -0,0 +1,107 @@
|
||||
### templates/deployment.yaml
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: {{ include "jellyseerr.fullname" . }}
|
||||
labels:
|
||||
{{- include "jellyseerr.labels" . | nindent 4 }}
|
||||
annotations:
|
||||
spec:
|
||||
replicas: {{ .Values.replicaCount }}
|
||||
revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
|
||||
selector:
|
||||
matchLabels:
|
||||
{{- include "jellyseerr.selectorLabels" . | nindent 6 }}
|
||||
strategy:
|
||||
type: RollingUpdate
|
||||
rollingUpdate:
|
||||
maxUnavailable: 1
|
||||
maxSurge: 1
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
{{- include "jellyseerr.selectorLabels" . | nindent 8 }}
|
||||
annotations:
|
||||
{{- with .Values.podAnnotations }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- with .Values.imagePullSecrets }}
|
||||
imagePullSecrets:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.podSecurityContext | nindent 8 }}
|
||||
containers:
|
||||
- name: {{ .Chart.Name }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.containerSecurityContext | nindent 12 }}
|
||||
image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
|
||||
imagePullPolicy: {{ .Values.image.pullPolicy }}
|
||||
{{- if .Values.startupArgs }}
|
||||
args:
|
||||
{{- range .Values.startupArgs }}
|
||||
- {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: {{ .Values.service.port }}
|
||||
protocol: TCP
|
||||
{{- if .Values.probes.liveness.enabled }}
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.liveness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.liveness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.liveness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.liveness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.liveness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.liveness.successThreshold }}
|
||||
{{- end }}
|
||||
{{- if .Values.probes.readiness.enabled }}
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.readiness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.readiness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.readiness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.readiness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.readiness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.readiness.successThreshold }}
|
||||
{{- end }}
|
||||
env:
|
||||
{{- range .Values.env }}
|
||||
- name: {{ .name }}
|
||||
value: {{ .value | quote }}
|
||||
{{- end }}
|
||||
{{- with .Values.extraEnv }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
volumeMounts:
|
||||
- name: config
|
||||
mountPath: /app/config
|
||||
{{- with .Values.extraVolumeMounts }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
resources:
|
||||
{{- toYaml .Values.resources | nindent 12 }}
|
||||
volumes:
|
||||
- name: config
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ if .Values.persistence.existingClaim }}{{ .Values.persistence.existingClaim }}{{ else }}{{ include "jellyseerr.fullname" . }}-config{{ end }}
|
||||
{{- with .Values.extraVolumes }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.nodeSelector }}
|
||||
nodeSelector:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.affinity }}
|
||||
affinity:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.tolerations }}
|
||||
tolerations:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
43
charts/jellyseerr/templates/ingress.yaml
Normal file
43
charts/jellyseerr/templates/ingress.yaml
Normal file
@ -0,0 +1,43 @@
|
||||
{{- if .Values.ingress.enabled -}}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: {{ include "jellyseerr.fullname" . }}
|
||||
labels:
|
||||
{{- include "jellyseerr.labels" . | nindent 4 }}
|
||||
{{- with .Values.ingress.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- if .Values.ingress.className }}
|
||||
ingressClassName: {{ .Values.ingress.className }}
|
||||
{{- end }}
|
||||
{{- if .Values.ingress.tls }}
|
||||
tls:
|
||||
{{- range .Values.ingress.tls }}
|
||||
- hosts:
|
||||
{{- range .hosts }}
|
||||
- {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- if .secretName }}
|
||||
secretName: {{ .secretName }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
rules:
|
||||
{{- range .Values.ingress.hosts }}
|
||||
- host: {{ .host | quote }}
|
||||
http:
|
||||
paths:
|
||||
{{- range .paths }}
|
||||
- path: {{ .path }}
|
||||
pathType: {{ .pathType }}
|
||||
backend:
|
||||
service:
|
||||
name: {{ include "jellyseerr.fullname" $ }}
|
||||
port:
|
||||
number: {{ $.Values.service.port }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
21
charts/jellyseerr/templates/pvc.yaml
Normal file
21
charts/jellyseerr/templates/pvc.yaml
Normal file
@ -0,0 +1,21 @@
|
||||
{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "jellyseerr.fullname" . }}-config
|
||||
labels:
|
||||
{{- include "jellyseerr.labels" . | nindent 4 }}
|
||||
{{- with .Values.persistence.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.accessMode | quote }}
|
||||
{{- if .Values.persistence.storageClass }}
|
||||
storageClassName: {{ .Values.persistence.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.size | quote }}
|
||||
{{- end }}
|
||||
15
charts/jellyseerr/templates/service.yaml
Normal file
15
charts/jellyseerr/templates/service.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: {{ include "jellyseerr.fullname" . }}
|
||||
labels:
|
||||
{{- include "jellyseerr.labels" . | nindent 4 }}
|
||||
spec:
|
||||
type: {{ .Values.service.type }}
|
||||
ports:
|
||||
- port: {{ .Values.service.port }}
|
||||
targetPort: http
|
||||
protocol: TCP
|
||||
name: http
|
||||
selector:
|
||||
{{- include "jellyseerr.selectorLabels" . | nindent 4 }}
|
||||
117
charts/jellyseerr/values.yaml
Normal file
117
charts/jellyseerr/values.yaml
Normal file
@ -0,0 +1,117 @@
|
||||
## Global settings
|
||||
nameOverride: ""
|
||||
fullnameOverride: ""
|
||||
|
||||
## Image settings
|
||||
image:
|
||||
repository: ghcr.io/fallenbagel/jellyseerr
|
||||
tag: 2.5.2
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
## Deployment settings
|
||||
replicaCount: 1
|
||||
revisionHistoryLimit: 3
|
||||
|
||||
# Optional startup arguments
|
||||
startupArgs: []
|
||||
|
||||
# Pod security settings
|
||||
podSecurityContext:
|
||||
runAsNonRoot: true
|
||||
runAsUser: 1000
|
||||
fsGroup: 1000
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
readOnlyRootFilesystem: false
|
||||
capabilities:
|
||||
drop:
|
||||
- ALL
|
||||
|
||||
## Pod scheduling
|
||||
nodeSelector: {}
|
||||
tolerations: []
|
||||
affinity: {}
|
||||
|
||||
## Pod annotations
|
||||
podAnnotations: {}
|
||||
|
||||
## Service settings
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 5055
|
||||
|
||||
## Ingress settings
|
||||
ingress:
|
||||
enabled: false
|
||||
className: ""
|
||||
annotations: {}
|
||||
# kubernetes.io/ingress.class: nginx
|
||||
# kubernetes.io/tls-acme: "true"
|
||||
# cert-manager.io/cluster-issuer: letsencrypt-prod
|
||||
hosts:
|
||||
- host: jellyseerr.domain.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls: []
|
||||
# - hosts:
|
||||
# - jellyseerr.domain.com
|
||||
# secretName: jellyseerr-tls
|
||||
|
||||
## Persistence settings
|
||||
persistence:
|
||||
enabled: true
|
||||
existingClaim: ""
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 1Gi
|
||||
annotations: {}
|
||||
|
||||
## Environment variables
|
||||
env:
|
||||
- name: TZ
|
||||
value: "UTC"
|
||||
- name: LOG_LEVEL
|
||||
value: "info"
|
||||
- name: PORT
|
||||
value: "5055"
|
||||
|
||||
# Extra environment variables (for advanced use cases)
|
||||
extraEnv: []
|
||||
# - name: NODE_ENV
|
||||
# value: "production"
|
||||
|
||||
# Extra volume mounts
|
||||
extraVolumeMounts: []
|
||||
|
||||
# Extra volumes
|
||||
extraVolumes: []
|
||||
|
||||
## Resource limits and requests
|
||||
# resources:
|
||||
# limits:
|
||||
# cpu: 500m
|
||||
# memory: 512Mi
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 128Mi
|
||||
|
||||
## Application health checks
|
||||
probes:
|
||||
liveness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 10
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 6
|
||||
successThreshold: 1
|
||||
path: /api/v1/status
|
||||
readiness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 5
|
||||
periodSeconds: 5
|
||||
timeoutSeconds: 3
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
path: /api/v1/status
|
||||
17
charts/joplin-server/Chart.yaml
Normal file
17
charts/joplin-server/Chart.yaml
Normal file
@ -0,0 +1,17 @@
|
||||
apiVersion: v2
|
||||
name: joplin-server
|
||||
description: Joplin Server helm chart for Kubernetes - Note-taking and synchronization server
|
||||
type: application
|
||||
version: 0.0.2
|
||||
appVersion: "3.4.2"
|
||||
maintainers:
|
||||
- name: Richard Tomik
|
||||
email: no@m.com
|
||||
keywords:
|
||||
- notes
|
||||
- synchronization
|
||||
- joplin
|
||||
- productivity
|
||||
home: https://github.com/rtomik/helm-charts
|
||||
sources:
|
||||
- https://github.com/laurent22/joplin
|
||||
106
charts/joplin-server/NOTES.txt
Normal file
106
charts/joplin-server/NOTES.txt
Normal file
@ -0,0 +1,106 @@
|
||||
1. Get the application URL by running these commands:
|
||||
{{- if .Values.ingress.enabled }}
|
||||
{{- range $host := .Values.ingress.hosts }}
|
||||
{{- range .paths }}
|
||||
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- else if contains "NodePort" .Values.service.type }}
|
||||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "joplin-server.fullname" . }})
|
||||
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
|
||||
echo http://$NODE_IP:$NODE_PORT
|
||||
{{- else if contains "LoadBalancer" .Values.service.type }}
|
||||
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
|
||||
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "joplin-server.fullname" . }}'
|
||||
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "joplin-server.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
|
||||
echo http://$SERVICE_IP:{{ .Values.service.port }}
|
||||
{{- else if contains "ClusterIP" .Values.service.type }}
|
||||
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "joplin-server.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
|
||||
export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
|
||||
echo "Visit http://127.0.0.1:8080 to use your application"
|
||||
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
|
||||
{{- end }}
|
||||
|
||||
2. Joplin Server is configured with:
|
||||
- Database: PostgreSQL ({{ .Values.postgresql.external.host }}:{{ .Values.postgresql.external.port }}/{{ .Values.postgresql.external.database }})
|
||||
- Storage: {{ .Values.joplin.storage.driver }}
|
||||
{{- if eq .Values.joplin.storage.driver "filesystem" }}
|
||||
- Data path: {{ .Values.joplin.storage.filesystemPath }}
|
||||
{{- end }}
|
||||
- User registration: {{ if .Values.joplin.server.enableUserRegistration }}enabled{{ else }}disabled{{ end }}
|
||||
- Sharing: {{ if .Values.joplin.server.enableSharing }}enabled{{ else }}disabled{{ end }}
|
||||
|
||||
{{- if and (eq .Values.joplin.storage.driver "filesystem") .Values.persistence.enabled }}
|
||||
3. Data is persisted using PVC: {{ include "joplin-server.fullname" . }}-data
|
||||
{{- else if eq .Values.joplin.storage.driver "filesystem" }}
|
||||
3. WARNING: No persistence enabled. Data will be lost when pods are restarted.
|
||||
{{- else }}
|
||||
3. Using {{ .Values.joplin.storage.driver }} storage - no local persistence needed.
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.transcribe.enabled }}
|
||||
4. AI Transcription service is enabled:
|
||||
- Transcribe service accessible internally at: {{ include "joplin-server.fullname" . }}-transcribe:{{ .Values.transcribe.service.port }}
|
||||
{{- if .Values.transcribe.persistence.enabled }}
|
||||
- Transcribe images stored in PVC: {{ include "joplin-server.fullname" . }}-transcribe-images
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.joplin.email.enabled }}
|
||||
5. Email notifications configured:
|
||||
- SMTP host: {{ .Values.joplin.email.host }}:{{ .Values.joplin.email.port }}
|
||||
- From: {{ .Values.joplin.email.fromName }} <{{ .Values.joplin.email.fromEmail }}>
|
||||
{{- end }}
|
||||
|
||||
{{- if not .Values.joplin.admin.email }}
|
||||
|
||||
6. IMPORTANT: First-time setup required!
|
||||
After accessing the application, you'll need to create your first admin user.
|
||||
Consider setting joplin.admin.email and joplin.admin.password for automated setup.
|
||||
{{- else }}
|
||||
|
||||
6. Admin user configured:
|
||||
- Email: {{ .Values.joplin.admin.email }}
|
||||
{{- if .Values.joplin.admin.existingSecret }}
|
||||
- Password: Retrieved from secret {{ .Values.joplin.admin.existingSecret }}
|
||||
{{- else }}
|
||||
- Password: Set in values (consider using existingSecret for production)
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{- if not .Values.postgresql.external.enabled }}
|
||||
|
||||
7. WARNING: PostgreSQL database not configured!
|
||||
Please configure postgresql.external settings to connect to your PostgreSQL database.
|
||||
Joplin Server requires a PostgreSQL database to function.
|
||||
{{- else if and .Values.postgresql.external.enabled (not .Values.postgresql.external.existingSecret) }}
|
||||
|
||||
7. SECURITY NOTE: Database credentials in plain text.
|
||||
For production use, consider using postgresql.external.existingSecret to store database credentials securely.
|
||||
{{- end }}
|
||||
|
||||
{{- $defaultHost := "joplin.domain.com" }}
|
||||
{{- $actualHost := "" }}
|
||||
{{- if .Values.ingress.enabled }}
|
||||
{{- range .Values.ingress.hosts }}
|
||||
{{- $actualHost = .host }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if and $actualHost (ne $actualHost $defaultHost) }}
|
||||
{{- if and .Values.probes.liveness.httpHeaders (len .Values.probes.liveness.httpHeaders) }}
|
||||
{{- $probeHost := "" }}
|
||||
{{- range .Values.probes.liveness.httpHeaders }}
|
||||
{{- if eq .name "Host" }}
|
||||
{{- $probeHost = .value }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if eq $probeHost $defaultHost }}
|
||||
|
||||
8. IMPORTANT: Health check configuration needs updating!
|
||||
Your ingress host is "{{ $actualHost }}" but health checks are configured for "{{ $defaultHost }}".
|
||||
Update probes.*.httpHeaders.Host value to match your domain for proper health checks.
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
For more information about using this Helm chart, please refer to the readme.md file.
|
||||
460
charts/joplin-server/readme.md
Normal file
460
charts/joplin-server/readme.md
Normal file
@ -0,0 +1,460 @@
|
||||
# Joplin Server Helm Chart
|
||||
|
||||
A Helm chart for deploying Joplin Server on Kubernetes - Note-taking and synchronization server.
|
||||
|
||||
## Introduction
|
||||
|
||||
This chart deploys [Joplin Server](https://github.com/laurent22/joplin) on a Kubernetes cluster using the Helm package manager. Joplin Server is the synchronization server for Joplin, allowing you to sync your notes across devices.
|
||||
|
||||
Source code can be found here:
|
||||
- https://github.com/rtomik/helm-charts/tree/main/charts/joplin-server
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
- Helm 3.0+
|
||||
- **External PostgreSQL database** (Required - Joplin Server does not support SQLite in production)
|
||||
- PV provisioner support in the underlying infrastructure (if persistence is needed for file storage)
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `joplin-server`:
|
||||
|
||||
```bash
|
||||
$ helm repo add joplin-chart https://rtomik.github.io/helm-charts
|
||||
$ helm install joplin-server joplin-chart/joplin-server
|
||||
```
|
||||
|
||||
> **Important**: You must configure PostgreSQL database settings before installation.
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall/delete the `joplin-server` deployment:
|
||||
|
||||
```bash
|
||||
$ helm uninstall joplin-server
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
### Global parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------------------------|------------------------------------------------|-------|
|
||||
| `nameOverride` | String to partially override the release name | `""` |
|
||||
| `fullnameOverride` | String to fully override the release name | `""` |
|
||||
|
||||
### Image parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------|-----------------------------------|--------------------|
|
||||
| `image.repository` | Joplin Server image repository | `joplin/server` |
|
||||
| `image.tag` | Joplin Server image tag | `latest` |
|
||||
| `image.pullPolicy` | Joplin Server image pull policy | `IfNotPresent` |
|
||||
|
||||
### Deployment parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------------------|-----------------------------------------------|-----------|
|
||||
| `replicaCount` | Number of Joplin Server replicas | `1` |
|
||||
| `revisionHistoryLimit` | Number of revisions to retain for rollback | `3` |
|
||||
| `podSecurityContext.runAsNonRoot` | Run containers as non-root user | `true` |
|
||||
| `podSecurityContext.runAsUser` | User ID for the container | `1001` |
|
||||
| `podSecurityContext.fsGroup` | Group ID for the container filesystem | `1001` |
|
||||
| `containerSecurityContext` | Security context for the container | See values.yaml |
|
||||
| `nodeSelector` | Node labels for pod assignment | `{}` |
|
||||
| `tolerations` | Tolerations for pod assignment | `[]` |
|
||||
| `affinity` | Affinity for pod assignment | `{}` |
|
||||
|
||||
### Service parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------|-----------------------|-------------|
|
||||
| `service.type` | Kubernetes Service type | `ClusterIP` |
|
||||
| `service.port` | Service HTTP port | `22300` |
|
||||
|
||||
### Ingress parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------|-------------------------------------------|-----------------|
|
||||
| `ingress.enabled` | Enable ingress record generation | `false` |
|
||||
| `ingress.className` | IngressClass name | `""` |
|
||||
| `ingress.annotations` | Additional annotations for the Ingress | See values.yaml |
|
||||
| `ingress.hosts` | Array of host and path objects | See values.yaml |
|
||||
| `ingress.tls` | TLS configuration | See values.yaml |
|
||||
|
||||
### Environment variables
|
||||
|
||||
| Name | Description | Value |
|
||||
|---------------------------|-----------------------------------------------|--------------------------|
|
||||
| `env.APP_PORT` | Application port | `22300` |
|
||||
| `env.APP_BASE_URL` | Base URL for the application | `http://localhost:22300` |
|
||||
| `env.DB_CLIENT` | Database client (always pg for PostgreSQL) | `pg` |
|
||||
|
||||
### PostgreSQL configuration (Required)
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|-----------------------------------------------|-----------|
|
||||
| `postgresql.external.enabled` | Use external PostgreSQL database (required) | `true` |
|
||||
| `postgresql.external.host` | PostgreSQL host | `""` |
|
||||
| `postgresql.external.port` | PostgreSQL port | `5432` |
|
||||
| `postgresql.external.database` | PostgreSQL database name | `joplin` |
|
||||
| `postgresql.external.user` | PostgreSQL username | `joplin` |
|
||||
| `postgresql.external.password` | PostgreSQL password | `""` |
|
||||
| `postgresql.external.existingSecret` | Name of existing secret with PostgreSQL credentials | `""` |
|
||||
| `postgresql.external.userKey` | Key in the secret for username | `username` |
|
||||
| `postgresql.external.passwordKey` | Key in the secret for password | `password` |
|
||||
| `postgresql.external.hostKey` | Key in the secret for host (optional) | `""` |
|
||||
| `postgresql.external.portKey` | Key in the secret for port (optional) | `""` |
|
||||
| `postgresql.external.databaseKey` | Key in the secret for database name (optional) | `""` |
|
||||
|
||||
### Joplin Server Configuration
|
||||
|
||||
#### Admin Settings
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|-----------------------------------------------|-----------|
|
||||
| `joplin.admin.email` | First admin user email | `""` |
|
||||
| `joplin.admin.password` | First admin user password | `""` |
|
||||
| `joplin.admin.existingSecret` | Name of existing secret with admin credentials | `""` |
|
||||
| `joplin.admin.emailKey` | Key in the secret for admin email | `admin-email` |
|
||||
| `joplin.admin.passwordKey` | Key in the secret for admin password | `admin-password` |
|
||||
|
||||
#### Server Settings
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------------------|-----------------------------------------------|-----------|
|
||||
| `joplin.server.maxRequestBodySize` | Maximum request body size | `200mb` |
|
||||
| `joplin.server.sessionTimeout` | Session timeout in seconds | `86400` |
|
||||
| `joplin.server.enableUserRegistration` | Enable/disable user registration | `false` |
|
||||
| `joplin.server.enableSharing` | Enable/disable sharing | `true` |
|
||||
| `joplin.server.enablePublicNotes` | Enable/disable public notes | `true` |
|
||||
|
||||
#### Storage Settings
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------------------|-----------------------------------------------|--------------|
|
||||
| `joplin.storage.driver` | Storage driver (filesystem, s3, azure) | `filesystem` |
|
||||
| `joplin.storage.filesystemPath` | Path for filesystem storage | `/var/lib/joplin` |
|
||||
|
||||
##### S3 Storage (Optional)
|
||||
|
||||
| Name | Description | Value |
|
||||
|---------------------------------------------|---------------------------------------------|-----------|
|
||||
| `joplin.storage.s3.bucket` | S3 bucket name | `""` |
|
||||
| `joplin.storage.s3.region` | S3 region | `""` |
|
||||
| `joplin.storage.s3.accessKeyId` | S3 access key ID | `""` |
|
||||
| `joplin.storage.s3.secretAccessKey` | S3 secret access key | `""` |
|
||||
| `joplin.storage.s3.endpoint` | S3 endpoint (for S3-compatible services) | `""` |
|
||||
| `joplin.storage.s3.existingSecret` | Name of existing secret with S3 credentials | `""` |
|
||||
| `joplin.storage.s3.accessKeyIdKey` | Key in the secret for access key ID | `access-key-id` |
|
||||
| `joplin.storage.s3.secretAccessKeyKey` | Key in the secret for secret access key | `secret-access-key` |
|
||||
|
||||
#### Email Settings (Optional)
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|-----------------------------------------------|-----------|
|
||||
| `joplin.email.enabled` | Enable email notifications | `false` |
|
||||
| `joplin.email.host` | SMTP host | `""` |
|
||||
| `joplin.email.port` | SMTP port | `587` |
|
||||
| `joplin.email.username` | SMTP username | `""` |
|
||||
| `joplin.email.password` | SMTP password | `""` |
|
||||
| `joplin.email.fromEmail` | From email address | `""` |
|
||||
| `joplin.email.fromName` | From name | `Joplin Server` |
|
||||
| `joplin.email.secure` | Use TLS/SSL | `true` |
|
||||
| `joplin.email.existingSecret` | Name of existing secret with email credentials | `""` |
|
||||
| `joplin.email.usernameKey` | Key in the secret for SMTP username | `email-username` |
|
||||
| `joplin.email.passwordKey` | Key in the secret for SMTP password | `email-password` |
|
||||
|
||||
#### Logging Settings
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------------|--------------------------------------|-----------|
|
||||
| `joplin.logging.level` | Log level (error, warn, info, debug) | `info` |
|
||||
| `joplin.logging.target` | Log target (console, file) | `console` |
|
||||
|
||||
### Persistence settings (for filesystem storage)
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------|----------------------------------|-----------------|
|
||||
| `persistence.enabled` | Enable persistence using PVC | `true` |
|
||||
| `persistence.storageClass` | PVC Storage Class | `""` |
|
||||
| `persistence.accessMode` | PVC Access Mode | `ReadWriteOnce` |
|
||||
| `persistence.size` | PVC Size | `10Gi` |
|
||||
| `persistence.annotations` | Annotations for PVC | `{}` |
|
||||
|
||||
### Transcribe Service (Optional AI Transcription)
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------------------|-----------------------------------------------|--------------|
|
||||
| `transcribe.enabled` | Enable transcribe service | `false` |
|
||||
| `transcribe.image.repository` | Transcribe image repository | `joplin/transcribe` |
|
||||
| `transcribe.image.tag` | Transcribe image tag | `latest` |
|
||||
| `transcribe.image.pullPolicy` | Transcribe image pull policy | `IfNotPresent` |
|
||||
| `transcribe.api.key` | Shared secret between Joplin and Transcribe | `""` |
|
||||
| `transcribe.api.existingSecret` | Name of existing secret with transcribe API key | `""` |
|
||||
| `transcribe.api.keyName` | Key in the secret for transcribe API key | `transcribe-api-key` |
|
||||
| `transcribe.service.type` | Transcribe service type | `ClusterIP` |
|
||||
| `transcribe.service.port` | Transcribe service port | `4567` |
|
||||
| `transcribe.htr.imagesFolder` | HTR images folder path | `/app/images` |
|
||||
|
||||
#### Transcribe Database (Separate from main database)
|
||||
|
||||
| Name | Description | Value |
|
||||
|---------------------------------------------|---------------------------------------------|-------------|
|
||||
| `transcribe.database.host` | Transcribe database host | `""` |
|
||||
| `transcribe.database.port` | Transcribe database port | `5432` |
|
||||
| `transcribe.database.database` | Transcribe database name | `transcribe` |
|
||||
| `transcribe.database.user` | Transcribe database username | `transcribe` |
|
||||
| `transcribe.database.password` | Transcribe database password | `""` |
|
||||
| `transcribe.database.existingSecret` | Name of existing secret with transcribe DB credentials | `""` |
|
||||
| `transcribe.database.userKey` | Key in the secret for username | `username` |
|
||||
| `transcribe.database.passwordKey` | Key in the secret for password | `password` |
|
||||
|
||||
### Resource Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------|--------------------------------------|-------|
|
||||
| `resources` | Resource limits and requests | `{}` |
|
||||
|
||||
### Health Checks
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------------------|------------------------------------------|-------|
|
||||
| `probes.liveness.enabled` | Enable liveness probe | `true` |
|
||||
| `probes.liveness.initialDelaySeconds` | Initial delay for liveness probe | `60` |
|
||||
| `probes.liveness.periodSeconds` | Period for liveness probe | `30` |
|
||||
| `probes.liveness.timeoutSeconds` | Timeout for liveness probe | `10` |
|
||||
| `probes.liveness.failureThreshold` | Failure threshold for liveness probe | `3` |
|
||||
| `probes.liveness.successThreshold` | Success threshold for liveness probe | `1` |
|
||||
| `probes.liveness.path` | Path for liveness probe | `/api/ping` |
|
||||
| `probes.liveness.httpHeaders` | HTTP headers for liveness probe | `[{"name": "Host", "value": "joplin.domain.com"}]` |
|
||||
| `probes.readiness.enabled` | Enable readiness probe | `true` |
|
||||
| `probes.readiness.initialDelaySeconds` | Initial delay for readiness probe | `30` |
|
||||
| `probes.readiness.periodSeconds` | Period for readiness probe | `10` |
|
||||
| `probes.readiness.timeoutSeconds` | Timeout for readiness probe | `5` |
|
||||
| `probes.readiness.failureThreshold` | Failure threshold for readiness probe | `3` |
|
||||
| `probes.readiness.successThreshold` | Success threshold for readiness probe | `1` |
|
||||
| `probes.readiness.path` | Path for readiness probe | `/api/ping` |
|
||||
| `probes.readiness.httpHeaders` | HTTP headers for readiness probe | `[{"name": "Host", "value": "joplin.domain.com"}]` |
|
||||
|
||||
### Autoscaling
|
||||
|
||||
| Name | Description | Value |
|
||||
|---------------------------------------------|------------------------------------------|---------|
|
||||
| `autoscaling.enabled` | Enable horizontal pod autoscaling | `false` |
|
||||
| `autoscaling.minReplicas` | Minimum number of replicas | `1` |
|
||||
| `autoscaling.maxReplicas` | Maximum number of replicas | `3` |
|
||||
| `autoscaling.targetCPUUtilizationPercentage`| Target CPU utilization percentage | `80` |
|
||||
| `autoscaling.targetMemoryUtilizationPercentage`| Target memory utilization percentage | `80` |
|
||||
|
||||
### Security Settings
|
||||
|
||||
| Name | Description | Value |
|
||||
|-----------------------------------|--------------------------------------|---------|
|
||||
| `security.httpsRedirect` | Enable/disable HTTPS redirect | `false` |
|
||||
| `security.tls.enabled` | Enable custom TLS certificate | `false` |
|
||||
| `security.tls.existingSecret` | Name of existing secret with TLS cert| `""` |
|
||||
| `security.tls.certificateKey` | Key in the secret for TLS certificate| `tls.crt` |
|
||||
| `security.tls.privateKeyKey` | Key in the secret for TLS private key| `tls.key` |
|
||||
|
||||
## Configuration Examples
|
||||
|
||||
### Basic Installation with PostgreSQL
|
||||
|
||||
```yaml
|
||||
postgresql:
|
||||
external:
|
||||
enabled: true
|
||||
host: "postgresql.example.com"
|
||||
port: 5432
|
||||
database: "joplin"
|
||||
user: "joplin"
|
||||
password: "secure-password"
|
||||
|
||||
ingress:
|
||||
enabled: true
|
||||
hosts:
|
||||
- host: joplin.example.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- joplin.example.com
|
||||
secretName: joplin-tls
|
||||
|
||||
env:
|
||||
APP_BASE_URL: "https://joplin.example.com"
|
||||
|
||||
# IMPORTANT: Update health check host headers to match your domain
|
||||
probes:
|
||||
liveness:
|
||||
httpHeaders:
|
||||
- name: Host
|
||||
value: joplin.example.com
|
||||
readiness:
|
||||
httpHeaders:
|
||||
- name: Host
|
||||
value: joplin.example.com
|
||||
|
||||
joplin:
|
||||
admin:
|
||||
email: "admin@example.com"
|
||||
password: "admin-password"
|
||||
server:
|
||||
enableUserRegistration: true
|
||||
```
|
||||
|
||||
### Using Kubernetes Secrets
|
||||
|
||||
#### Full Secret Configuration
|
||||
```yaml
|
||||
postgresql:
|
||||
external:
|
||||
enabled: true
|
||||
existingSecret: "joplin-postgresql-secret"
|
||||
hostKey: "host"
|
||||
portKey: "port"
|
||||
databaseKey: "database"
|
||||
userKey: "username"
|
||||
passwordKey: "password"
|
||||
|
||||
joplin:
|
||||
admin:
|
||||
existingSecret: "joplin-admin-secret"
|
||||
emailKey: "email"
|
||||
passwordKey: "password"
|
||||
```
|
||||
|
||||
#### Mixed Configuration (Host in values, credentials in secret)
|
||||
```yaml
|
||||
postgresql:
|
||||
external:
|
||||
enabled: true
|
||||
host: "postgres-cluster-pooler.dbs.svc.cluster.local"
|
||||
port: 5432
|
||||
database: "joplin-server"
|
||||
existingSecret: "joplin-db-credentials"
|
||||
userKey: "username"
|
||||
passwordKey: "password"
|
||||
# hostKey, portKey, databaseKey left empty - using values above
|
||||
```
|
||||
|
||||
### S3 Storage Configuration
|
||||
|
||||
```yaml
|
||||
joplin:
|
||||
storage:
|
||||
driver: "s3"
|
||||
s3:
|
||||
bucket: "joplin-notes"
|
||||
region: "us-east-1"
|
||||
existingSecret: "joplin-s3-secret"
|
||||
accessKeyIdKey: "access-key-id"
|
||||
secretAccessKeyKey: "secret-access-key"
|
||||
|
||||
# No persistence needed when using S3
|
||||
persistence:
|
||||
enabled: false
|
||||
```
|
||||
|
||||
### Email Notifications Setup
|
||||
|
||||
```yaml
|
||||
joplin:
|
||||
email:
|
||||
enabled: true
|
||||
host: "smtp.example.com"
|
||||
port: 587
|
||||
fromEmail: "joplin@example.com"
|
||||
fromName: "Joplin Server"
|
||||
secure: true
|
||||
existingSecret: "joplin-email-secret"
|
||||
usernameKey: "username"
|
||||
passwordKey: "password"
|
||||
```
|
||||
|
||||
### Transcribe Service (AI Features)
|
||||
|
||||
```yaml
|
||||
transcribe:
|
||||
enabled: true
|
||||
api:
|
||||
existingSecret: "joplin-transcribe-secret"
|
||||
keyName: "api-key"
|
||||
database:
|
||||
host: "postgresql.example.com"
|
||||
port: 5432
|
||||
database: "transcribe"
|
||||
user: "transcribe"
|
||||
existingSecret: "transcribe-db-secret"
|
||||
userKey: "username"
|
||||
passwordKey: "password"
|
||||
persistence:
|
||||
enabled: true
|
||||
size: 5Gi
|
||||
```
|
||||
|
||||
## First-time Setup
|
||||
|
||||
1. **Configure PostgreSQL**: Ensure your PostgreSQL database is accessible and credentials are configured
|
||||
2. **Admin User**: Set admin email/password or access the web interface to create the first admin user
|
||||
3. **User Registration**: Configure whether users can self-register or admin approval is required
|
||||
4. **Storage**: Choose between filesystem (requires persistence) or cloud storage (S3/Azure)
|
||||
|
||||
## Security Considerations
|
||||
|
||||
For production deployments:
|
||||
|
||||
1. Use external secrets for all sensitive information (database passwords, admin credentials, etc.)
|
||||
2. Enable TLS/SSL for all communications
|
||||
3. Configure proper RBAC and network policies
|
||||
4. Use dedicated databases with proper access controls
|
||||
5. Disable user registration if not needed
|
||||
6. Use cloud storage for better scalability and backup
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and solutions:
|
||||
|
||||
1. **Health Check Issues / "No Available Server"**:
|
||||
- Ensure `probes.*.httpHeaders` includes the correct Host header matching your domain
|
||||
- Health checks use `/api/ping` endpoint which requires proper host validation
|
||||
- Example fix:
|
||||
```yaml
|
||||
probes:
|
||||
liveness:
|
||||
httpHeaders:
|
||||
- name: Host
|
||||
value: your-joplin-domain.com
|
||||
readiness:
|
||||
httpHeaders:
|
||||
- name: Host
|
||||
value: your-joplin-domain.com
|
||||
```
|
||||
|
||||
2. **Database connection issues**: Verify PostgreSQL credentials and network connectivity
|
||||
3. **Storage permissions**: Check filesystem permissions for persistent volumes
|
||||
4. **First admin user**: If no admin configured, access the web interface to create one
|
||||
5. **Transcribe issues**: Verify Docker socket access and separate database configuration
|
||||
6. **Origin validation errors**: Make sure `env.APP_BASE_URL` matches your ingress host
|
||||
|
||||
For detailed troubleshooting, check the application logs:
|
||||
|
||||
```bash
|
||||
kubectl logs -f deployment/joplin-server
|
||||
```
|
||||
|
||||
Check pod status and events:
|
||||
```bash
|
||||
kubectl describe pod -l app.kubernetes.io/name=joplin-server
|
||||
```
|
||||
|
||||
## Backing Up
|
||||
|
||||
- **Database**: Use PostgreSQL backup tools (pg_dump, etc.)
|
||||
- **File Storage**:
|
||||
- Filesystem: Backup the PVC data
|
||||
- S3: Files are already stored in S3 (ensure proper S3 backup policies)
|
||||
- **Configuration**: Backup your Kubernetes secrets and config
|
||||
45
charts/joplin-server/templates/_helpers.tpl
Normal file
45
charts/joplin-server/templates/_helpers.tpl
Normal file
@ -0,0 +1,45 @@
|
||||
{{/*
|
||||
Expand the name of the chart.
|
||||
*/}}
|
||||
{{- define "joplin-server.name" -}}
|
||||
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create a default fully qualified app name.
|
||||
*/}}
|
||||
{{- define "joplin-server.fullname" -}}
|
||||
{{- if .Values.fullnameOverride }}
|
||||
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- else }}
|
||||
{{- $name := default .Chart.Name .Values.nameOverride }}
|
||||
{{- printf "%s" $name | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create chart name and version as used by the chart label.
|
||||
*/}}
|
||||
{{- define "joplin-server.chart" -}}
|
||||
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Common labels
|
||||
*/}}
|
||||
{{- define "joplin-server.labels" -}}
|
||||
helm.sh/chart: {{ include "joplin-server.chart" . }}
|
||||
{{ include "joplin-server.selectorLabels" . }}
|
||||
{{- if .Chart.AppVersion }}
|
||||
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
|
||||
{{- end }}
|
||||
app.kubernetes.io/managed-by: {{ .Release.Service }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Selector labels
|
||||
*/}}
|
||||
{{- define "joplin-server.selectorLabels" -}}
|
||||
app.kubernetes.io/name: {{ include "joplin-server.name" . }}
|
||||
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||
{{- end }}
|
||||
377
charts/joplin-server/templates/deployment.yaml
Normal file
377
charts/joplin-server/templates/deployment.yaml
Normal file
@ -0,0 +1,377 @@
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: {{ include "joplin-server.fullname" . }}
|
||||
labels:
|
||||
{{- include "joplin-server.labels" . | nindent 4 }}
|
||||
spec:
|
||||
replicas: {{ .Values.replicaCount }}
|
||||
revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
|
||||
selector:
|
||||
matchLabels:
|
||||
{{- include "joplin-server.selectorLabels" . | nindent 6 }}
|
||||
strategy:
|
||||
type: RollingUpdate
|
||||
rollingUpdate:
|
||||
maxUnavailable: 1
|
||||
maxSurge: 1
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
{{- include "joplin-server.selectorLabels" . | nindent 8 }}
|
||||
annotations:
|
||||
{{- with .Values.podAnnotations }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- with .Values.imagePullSecrets }}
|
||||
imagePullSecrets:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.podSecurityContext | nindent 8 }}
|
||||
containers:
|
||||
- name: {{ .Chart.Name }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.containerSecurityContext | nindent 12 }}
|
||||
image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
|
||||
imagePullPolicy: {{ .Values.image.pullPolicy }}
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 22300
|
||||
protocol: TCP
|
||||
{{- if .Values.probes.liveness.enabled }}
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.liveness.path }}
|
||||
port: http
|
||||
{{- if .Values.probes.liveness.httpHeaders }}
|
||||
httpHeaders:
|
||||
{{- toYaml .Values.probes.liveness.httpHeaders | nindent 16 }}
|
||||
{{- end }}
|
||||
initialDelaySeconds: {{ .Values.probes.liveness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.liveness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.liveness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.liveness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.liveness.successThreshold }}
|
||||
{{- end }}
|
||||
{{- if .Values.probes.readiness.enabled }}
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.readiness.path }}
|
||||
port: http
|
||||
{{- if .Values.probes.readiness.httpHeaders }}
|
||||
httpHeaders:
|
||||
{{- toYaml .Values.probes.readiness.httpHeaders | nindent 16 }}
|
||||
{{- end }}
|
||||
initialDelaySeconds: {{ .Values.probes.readiness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.readiness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.readiness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.readiness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.readiness.successThreshold }}
|
||||
{{- end }}
|
||||
env:
|
||||
{{- range $key, $value := .Values.env }}
|
||||
- name: {{ $key }}
|
||||
value: {{ $value | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.postgresql.external.enabled }}
|
||||
- name: POSTGRES_HOST
|
||||
{{- if and .Values.postgresql.external.existingSecret .Values.postgresql.external.hostKey }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.postgresql.external.existingSecret }}
|
||||
key: {{ .Values.postgresql.external.hostKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.postgresql.external.host | quote }}
|
||||
{{- end }}
|
||||
- name: POSTGRES_PORT
|
||||
{{- if and .Values.postgresql.external.existingSecret .Values.postgresql.external.portKey }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.postgresql.external.existingSecret }}
|
||||
key: {{ .Values.postgresql.external.portKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.postgresql.external.port | quote }}
|
||||
{{- end }}
|
||||
- name: POSTGRES_DATABASE
|
||||
{{- if and .Values.postgresql.external.existingSecret .Values.postgresql.external.databaseKey }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.postgresql.external.existingSecret }}
|
||||
key: {{ .Values.postgresql.external.databaseKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.postgresql.external.database | quote }}
|
||||
{{- end }}
|
||||
- name: POSTGRES_USER
|
||||
{{- if and .Values.postgresql.external.existingSecret .Values.postgresql.external.userKey }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.postgresql.external.existingSecret }}
|
||||
key: {{ .Values.postgresql.external.userKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.postgresql.external.user | quote }}
|
||||
{{- end }}
|
||||
- name: POSTGRES_PASSWORD
|
||||
{{- if and .Values.postgresql.external.existingSecret .Values.postgresql.external.passwordKey }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.postgresql.external.existingSecret }}
|
||||
key: {{ .Values.postgresql.external.passwordKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.postgresql.external.password | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.joplin.admin.email }}
|
||||
- name: ADMIN_EMAIL
|
||||
{{- if .Values.joplin.admin.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.joplin.admin.existingSecret }}
|
||||
key: {{ .Values.joplin.admin.emailKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.joplin.admin.email | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.joplin.admin.password }}
|
||||
- name: ADMIN_PASSWORD
|
||||
{{- if .Values.joplin.admin.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.joplin.admin.existingSecret }}
|
||||
key: {{ .Values.joplin.admin.passwordKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.joplin.admin.password | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.joplin.server.maxRequestBodySize }}
|
||||
- name: MAX_REQUEST_BODY_SIZE
|
||||
value: {{ .Values.joplin.server.maxRequestBodySize | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.joplin.server.sessionTimeout }}
|
||||
- name: SESSION_TIMEOUT
|
||||
value: {{ .Values.joplin.server.sessionTimeout | quote }}
|
||||
{{- end }}
|
||||
- name: ENABLE_USER_REGISTRATION
|
||||
value: {{ .Values.joplin.server.enableUserRegistration | quote }}
|
||||
- name: ENABLE_SHARING
|
||||
value: {{ .Values.joplin.server.enableSharing | quote }}
|
||||
- name: ENABLE_PUBLIC_NOTES
|
||||
value: {{ .Values.joplin.server.enablePublicNotes | quote }}
|
||||
{{- if eq .Values.joplin.storage.driver "filesystem" }}
|
||||
- name: STORAGE_CONNECTION_STRING
|
||||
value: "Type=Filesystem; Path={{ .Values.joplin.storage.filesystemPath }}"
|
||||
{{- else if eq .Values.joplin.storage.driver "s3" }}
|
||||
- name: STORAGE_CONNECTION_STRING
|
||||
value: "Type=S3; Bucket={{ .Values.joplin.storage.s3.bucket }}; Region={{ .Values.joplin.storage.s3.region }}{{- if .Values.joplin.storage.s3.endpoint }}; Endpoint={{ .Values.joplin.storage.s3.endpoint }}{{- end }}"
|
||||
{{- else }}
|
||||
- name: STORAGE_CONNECTION_STRING
|
||||
value: "Type=Database"
|
||||
{{- end }}
|
||||
{{- if and (eq .Values.joplin.storage.driver "s3") .Values.joplin.storage.s3.bucket }}
|
||||
- name: AWS_ACCESS_KEY_ID
|
||||
{{- if .Values.joplin.storage.s3.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.joplin.storage.s3.existingSecret }}
|
||||
key: {{ .Values.joplin.storage.s3.accessKeyIdKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.joplin.storage.s3.accessKeyId | quote }}
|
||||
{{- end }}
|
||||
- name: AWS_SECRET_ACCESS_KEY
|
||||
{{- if .Values.joplin.storage.s3.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.joplin.storage.s3.existingSecret }}
|
||||
key: {{ .Values.joplin.storage.s3.secretAccessKeyKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.joplin.storage.s3.secretAccessKey | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.joplin.email.enabled }}
|
||||
- name: SMTP_HOST
|
||||
value: {{ .Values.joplin.email.host | quote }}
|
||||
- name: SMTP_PORT
|
||||
value: {{ .Values.joplin.email.port | quote }}
|
||||
- name: SMTP_USERNAME
|
||||
{{- if .Values.joplin.email.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.joplin.email.existingSecret }}
|
||||
key: {{ .Values.joplin.email.usernameKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.joplin.email.username | quote }}
|
||||
{{- end }}
|
||||
- name: SMTP_PASSWORD
|
||||
{{- if .Values.joplin.email.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.joplin.email.existingSecret }}
|
||||
key: {{ .Values.joplin.email.passwordKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.joplin.email.password | quote }}
|
||||
{{- end }}
|
||||
- name: SMTP_FROM_EMAIL
|
||||
value: {{ .Values.joplin.email.fromEmail | quote }}
|
||||
- name: SMTP_FROM_NAME
|
||||
value: {{ .Values.joplin.email.fromName | quote }}
|
||||
- name: SMTP_SECURE
|
||||
value: {{ .Values.joplin.email.secure | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.transcribe.enabled }}
|
||||
- name: TRANSCRIBE_ENABLED
|
||||
value: "true"
|
||||
- name: TRANSCRIBE_API_KEY
|
||||
{{- if .Values.transcribe.api.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.transcribe.api.existingSecret }}
|
||||
key: {{ .Values.transcribe.api.keyName }}
|
||||
{{- else }}
|
||||
value: {{ .Values.transcribe.api.key | quote }}
|
||||
{{- end }}
|
||||
- name: TRANSCRIBE_BASE_URL
|
||||
value: "http://{{ include "joplin-server.fullname" . }}-transcribe:{{ .Values.transcribe.service.port }}"
|
||||
{{- end }}
|
||||
- name: LOG_LEVEL
|
||||
value: {{ .Values.joplin.logging.level | quote }}
|
||||
- name: LOG_TARGET
|
||||
value: {{ .Values.joplin.logging.target | quote }}
|
||||
{{- with .Values.extraEnv }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
volumeMounts:
|
||||
{{- if eq .Values.joplin.storage.driver "filesystem" }}
|
||||
- name: data
|
||||
mountPath: {{ .Values.joplin.storage.filesystemPath }}
|
||||
{{- end }}
|
||||
{{- if and .Values.security.tls.enabled .Values.security.tls.existingSecret }}
|
||||
- name: tls-certs
|
||||
mountPath: /app/certs
|
||||
readOnly: true
|
||||
{{- end }}
|
||||
{{- with .Values.extraVolumeMounts }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
resources:
|
||||
{{- toYaml .Values.resources | nindent 12 }}
|
||||
{{- if .Values.transcribe.enabled }}
|
||||
- name: transcribe
|
||||
image: "{{ .Values.transcribe.image.repository }}:{{ .Values.transcribe.image.tag }}"
|
||||
imagePullPolicy: {{ .Values.transcribe.image.pullPolicy }}
|
||||
ports:
|
||||
- name: transcribe
|
||||
containerPort: 4567
|
||||
protocol: TCP
|
||||
env:
|
||||
- name: APP_PORT
|
||||
value: "4567"
|
||||
- name: DB_CLIENT
|
||||
value: "pg"
|
||||
- name: API_KEY
|
||||
{{- if .Values.transcribe.api.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.transcribe.api.existingSecret }}
|
||||
key: {{ .Values.transcribe.api.keyName }}
|
||||
{{- else }}
|
||||
value: {{ .Values.transcribe.api.key | quote }}
|
||||
{{- end }}
|
||||
- name: HTR_CLI_IMAGES_FOLDER
|
||||
value: {{ .Values.transcribe.htr.imagesFolder | quote }}
|
||||
{{- if .Values.transcribe.database.host }}
|
||||
- name: QUEUE_DATABASE_HOST
|
||||
{{- if .Values.transcribe.database.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.transcribe.database.existingSecret }}
|
||||
key: {{ .Values.transcribe.database.hostKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.transcribe.database.host | quote }}
|
||||
{{- end }}
|
||||
- name: QUEUE_DATABASE_PORT
|
||||
{{- if .Values.transcribe.database.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.transcribe.database.existingSecret }}
|
||||
key: {{ .Values.transcribe.database.portKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.transcribe.database.port | quote }}
|
||||
{{- end }}
|
||||
- name: QUEUE_DATABASE_NAME
|
||||
{{- if .Values.transcribe.database.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.transcribe.database.existingSecret }}
|
||||
key: {{ .Values.transcribe.database.databaseKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.transcribe.database.database | quote }}
|
||||
{{- end }}
|
||||
- name: QUEUE_DATABASE_USER
|
||||
{{- if .Values.transcribe.database.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.transcribe.database.existingSecret }}
|
||||
key: {{ .Values.transcribe.database.userKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.transcribe.database.user | quote }}
|
||||
{{- end }}
|
||||
- name: QUEUE_DATABASE_PASSWORD
|
||||
{{- if .Values.transcribe.database.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.transcribe.database.existingSecret }}
|
||||
key: {{ .Values.transcribe.database.passwordKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.transcribe.database.password | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
volumeMounts:
|
||||
- name: transcribe-images
|
||||
mountPath: {{ .Values.transcribe.htr.imagesFolder }}
|
||||
- name: docker-socket
|
||||
mountPath: /var/run/docker.sock
|
||||
{{- end }}
|
||||
volumes:
|
||||
{{- if eq .Values.joplin.storage.driver "filesystem" }}
|
||||
- name: data
|
||||
{{- if .Values.persistence.enabled }}
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ include "joplin-server.fullname" . }}-data
|
||||
{{- else }}
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.transcribe.enabled }}
|
||||
- name: transcribe-images
|
||||
{{- if .Values.transcribe.persistence.enabled }}
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ include "joplin-server.fullname" . }}-transcribe-images
|
||||
{{- else }}
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
- name: docker-socket
|
||||
hostPath:
|
||||
path: /var/run/docker.sock
|
||||
type: Socket
|
||||
{{- end }}
|
||||
{{- if and .Values.security.tls.enabled .Values.security.tls.existingSecret }}
|
||||
- name: tls-certs
|
||||
secret:
|
||||
secretName: {{ .Values.security.tls.existingSecret }}
|
||||
{{- end }}
|
||||
{{- with .Values.extraVolumes }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.nodeSelector }}
|
||||
nodeSelector:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.affinity }}
|
||||
affinity:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.tolerations }}
|
||||
tolerations:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
43
charts/joplin-server/templates/ingress.yaml
Normal file
43
charts/joplin-server/templates/ingress.yaml
Normal file
@ -0,0 +1,43 @@
|
||||
{{- if .Values.ingress.enabled -}}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: {{ include "joplin-server.fullname" . }}
|
||||
labels:
|
||||
{{- include "joplin-server.labels" . | nindent 4 }}
|
||||
{{- with .Values.ingress.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- if .Values.ingress.className }}
|
||||
ingressClassName: {{ .Values.ingress.className }}
|
||||
{{- end }}
|
||||
{{- if .Values.ingress.tls }}
|
||||
tls:
|
||||
{{- range .Values.ingress.tls }}
|
||||
- hosts:
|
||||
{{- range .hosts }}
|
||||
- {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- if .secretName }}
|
||||
secretName: {{ .secretName }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
rules:
|
||||
{{- range .Values.ingress.hosts }}
|
||||
- host: {{ .host | quote }}
|
||||
http:
|
||||
paths:
|
||||
{{- range .paths }}
|
||||
- path: {{ .path }}
|
||||
pathType: {{ .pathType }}
|
||||
backend:
|
||||
service:
|
||||
name: {{ include "joplin-server.fullname" $ }}
|
||||
port:
|
||||
number: {{ $.Values.service.port }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
44
charts/joplin-server/templates/pvc.yaml
Normal file
44
charts/joplin-server/templates/pvc.yaml
Normal file
@ -0,0 +1,44 @@
|
||||
{{- if and (eq .Values.joplin.storage.driver "filesystem") .Values.persistence.enabled }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "joplin-server.fullname" . }}-data
|
||||
labels:
|
||||
{{- include "joplin-server.labels" . | nindent 4 }}
|
||||
{{- with .Values.persistence.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.accessMode | quote }}
|
||||
{{- if .Values.persistence.storageClass }}
|
||||
storageClassName: {{ .Values.persistence.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.size | quote }}
|
||||
{{- end }}
|
||||
---
|
||||
{{- if and .Values.transcribe.enabled .Values.transcribe.persistence.enabled }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "joplin-server.fullname" . }}-transcribe-images
|
||||
labels:
|
||||
{{- include "joplin-server.labels" . | nindent 4 }}
|
||||
app.kubernetes.io/component: transcribe
|
||||
{{- with .Values.transcribe.persistence.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.transcribe.persistence.accessMode | quote }}
|
||||
{{- if .Values.transcribe.persistence.storageClass }}
|
||||
storageClassName: {{ .Values.transcribe.persistence.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.transcribe.persistence.size | quote }}
|
||||
{{- end }}
|
||||
34
charts/joplin-server/templates/service.yaml
Normal file
34
charts/joplin-server/templates/service.yaml
Normal file
@ -0,0 +1,34 @@
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: {{ include "joplin-server.fullname" . }}
|
||||
labels:
|
||||
{{- include "joplin-server.labels" . | nindent 4 }}
|
||||
spec:
|
||||
type: {{ .Values.service.type }}
|
||||
ports:
|
||||
- port: {{ .Values.service.port }}
|
||||
targetPort: http
|
||||
protocol: TCP
|
||||
name: http
|
||||
selector:
|
||||
{{- include "joplin-server.selectorLabels" . | nindent 4 }}
|
||||
---
|
||||
{{- if .Values.transcribe.enabled }}
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: {{ include "joplin-server.fullname" . }}-transcribe
|
||||
labels:
|
||||
{{- include "joplin-server.labels" . | nindent 4 }}
|
||||
app.kubernetes.io/component: transcribe
|
||||
spec:
|
||||
type: {{ .Values.transcribe.service.type }}
|
||||
ports:
|
||||
- port: {{ .Values.transcribe.service.port }}
|
||||
targetPort: transcribe
|
||||
protocol: TCP
|
||||
name: transcribe
|
||||
selector:
|
||||
{{- include "joplin-server.selectorLabels" . | nindent 4 }}
|
||||
{{- end }}
|
||||
268
charts/joplin-server/values.yaml
Normal file
268
charts/joplin-server/values.yaml
Normal file
@ -0,0 +1,268 @@
|
||||
## Global settings
|
||||
nameOverride: ""
|
||||
fullnameOverride: ""
|
||||
|
||||
## Image settings
|
||||
image:
|
||||
repository: joplin/server
|
||||
tag: "3.4.2"
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
## Deployment settings
|
||||
replicaCount: 1
|
||||
revisionHistoryLimit: 3
|
||||
|
||||
# Pod security settings
|
||||
podSecurityContext:
|
||||
runAsNonRoot: true
|
||||
runAsUser: 1001
|
||||
fsGroup: 1001
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
readOnlyRootFilesystem: false
|
||||
capabilities:
|
||||
drop:
|
||||
- ALL
|
||||
|
||||
## Pod scheduling
|
||||
nodeSelector: {}
|
||||
tolerations: []
|
||||
affinity: {}
|
||||
|
||||
## Service settings
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 22300
|
||||
|
||||
## Ingress settings
|
||||
ingress:
|
||||
enabled: false
|
||||
className: ""
|
||||
annotations:
|
||||
traefik.ingress.kubernetes.io/router.entrypoints: websecure
|
||||
hosts:
|
||||
- host: joplin.domain.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- joplin.domain.com
|
||||
|
||||
## Resource limits and requests
|
||||
# resources:
|
||||
# limits:
|
||||
# cpu: 500m
|
||||
# memory: 512Mi
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 256Mi
|
||||
|
||||
## Application health checks
|
||||
probes:
|
||||
liveness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 60
|
||||
periodSeconds: 30
|
||||
timeoutSeconds: 10
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
path: /api/ping
|
||||
# Host header for health checks to bypass origin validation
|
||||
# Update this to match your actual domain
|
||||
httpHeaders:
|
||||
- name: Host
|
||||
value: joplin.domain.com
|
||||
readiness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 10
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
path: /api/ping
|
||||
# Host header for health checks to bypass origin validation
|
||||
# Update this to match your actual domain
|
||||
httpHeaders:
|
||||
- name: Host
|
||||
value: joplin.domain.com
|
||||
|
||||
## Autoscaling configuration
|
||||
autoscaling:
|
||||
enabled: false
|
||||
minReplicas: 1
|
||||
maxReplicas: 3
|
||||
targetCPUUtilizationPercentage: 80
|
||||
targetMemoryUtilizationPercentage: 80
|
||||
|
||||
## Environment variables
|
||||
env:
|
||||
# Application Settings
|
||||
APP_PORT: "22300"
|
||||
APP_BASE_URL: "http://localhost:22300"
|
||||
|
||||
# Database Settings (PostgreSQL required)
|
||||
DB_CLIENT: "pg"
|
||||
|
||||
# Extra environment variables (for advanced use cases)
|
||||
extraEnv: []
|
||||
|
||||
# Extra volume mounts
|
||||
extraVolumeMounts: []
|
||||
|
||||
# Extra volumes
|
||||
extraVolumes: []
|
||||
|
||||
## PostgreSQL configuration (External database required)
|
||||
postgresql:
|
||||
# External PostgreSQL settings (required)
|
||||
external:
|
||||
enabled: false
|
||||
host: ""
|
||||
port: 5432
|
||||
database: "joplin"
|
||||
user: "joplin"
|
||||
password: ""
|
||||
# Use existing secret for database credentials
|
||||
existingSecret: ""
|
||||
userKey: "username"
|
||||
passwordKey: "password"
|
||||
# Optional: only set if host/port/database are also in the secret
|
||||
hostKey: ""
|
||||
portKey: ""
|
||||
databaseKey: ""
|
||||
|
||||
## Joplin Server Configuration
|
||||
joplin:
|
||||
# Admin settings
|
||||
admin:
|
||||
# First admin user email (set during first setup)
|
||||
email: ""
|
||||
# First admin user password (set during first setup)
|
||||
password: ""
|
||||
# Use existing secret for admin credentials
|
||||
existingSecret: ""
|
||||
emailKey: "admin-email"
|
||||
passwordKey: "admin-password"
|
||||
|
||||
# Server settings
|
||||
server:
|
||||
# Maximum request body size (in bytes)
|
||||
maxRequestBodySize: "200mb"
|
||||
# Session timeout in seconds
|
||||
sessionTimeout: 86400
|
||||
# Enable/disable user registration
|
||||
enableUserRegistration: false
|
||||
# Enable/disable sharing
|
||||
enableSharing: true
|
||||
# Enable/disable public notes
|
||||
enablePublicNotes: true
|
||||
|
||||
# Storage settings
|
||||
storage:
|
||||
# Storage driver: database, filesystem, s3, or azure
|
||||
driver: "database"
|
||||
# For filesystem storage (requires persistence)
|
||||
filesystemPath: "/var/lib/joplin"
|
||||
# For S3 storage (optional)
|
||||
s3:
|
||||
bucket: ""
|
||||
region: ""
|
||||
accessKeyId: ""
|
||||
secretAccessKey: ""
|
||||
endpoint: ""
|
||||
# Use existing secret for S3 credentials
|
||||
existingSecret: ""
|
||||
accessKeyIdKey: "access-key-id"
|
||||
secretAccessKeyKey: "secret-access-key"
|
||||
|
||||
# Email settings (for user registration and notifications)
|
||||
email:
|
||||
enabled: false
|
||||
host: ""
|
||||
port: 587
|
||||
username: ""
|
||||
password: ""
|
||||
fromEmail: ""
|
||||
fromName: "Joplin Server"
|
||||
# Use TLS/SSL
|
||||
secure: true
|
||||
# Use existing secret for email credentials
|
||||
existingSecret: ""
|
||||
usernameKey: "email-username"
|
||||
passwordKey: "email-password"
|
||||
|
||||
# Logging settings
|
||||
logging:
|
||||
level: "info" # error, warn, info, debug
|
||||
target: "console" # console, file
|
||||
|
||||
## Persistence settings (for filesystem storage)
|
||||
persistence:
|
||||
enabled: false
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 3Gi
|
||||
annotations: {}
|
||||
|
||||
## Transcribe service (optional AI transcription)
|
||||
transcribe:
|
||||
enabled: false
|
||||
image:
|
||||
repository: joplin/transcribe
|
||||
tag: "latest"
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
# Transcribe API settings
|
||||
api:
|
||||
# Shared secret between Joplin Server and Transcribe service
|
||||
key: ""
|
||||
# Use existing secret for transcribe API key
|
||||
existingSecret: ""
|
||||
keyName: "transcribe-api-key"
|
||||
|
||||
# Transcribe service settings
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 4567
|
||||
|
||||
# HTR CLI settings
|
||||
htr:
|
||||
# Images folder path
|
||||
imagesFolder: "/app/images"
|
||||
|
||||
# Transcribe persistence (for image storage)
|
||||
persistence:
|
||||
enabled: false
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 5Gi
|
||||
annotations: {}
|
||||
|
||||
# Transcribe database (separate from main Joplin database)
|
||||
database:
|
||||
host: ""
|
||||
port: 5432
|
||||
database: "transcribe"
|
||||
user: "transcribe"
|
||||
password: ""
|
||||
# Use existing secret for transcribe database credentials
|
||||
existingSecret: ""
|
||||
userKey: "username"
|
||||
passwordKey: "password"
|
||||
hostKey: "host"
|
||||
portKey: "port"
|
||||
databaseKey: "database"
|
||||
|
||||
## Security settings
|
||||
security:
|
||||
# Enable/disable HTTPS redirect
|
||||
httpsRedirect: false
|
||||
# Custom TLS certificate
|
||||
tls:
|
||||
enabled: false
|
||||
# Use existing secret for TLS certificate
|
||||
existingSecret: ""
|
||||
certificateKey: "tls.crt"
|
||||
privateKeyKey: "tls.key"
|
||||
16
charts/karakeep/Chart.yaml
Normal file
16
charts/karakeep/Chart.yaml
Normal file
@ -0,0 +1,16 @@
|
||||
apiVersion: v2
|
||||
name: karakeep
|
||||
description: Karakeep helm chart for Kubernetes
|
||||
type: application
|
||||
version: 0.0.1
|
||||
appVersion: "0.26.0"
|
||||
maintainers:
|
||||
- name: Richard Tomik
|
||||
email: no@m.com
|
||||
keywords:
|
||||
- bookmark-manager
|
||||
- karakeep
|
||||
- productivity
|
||||
home: https://github.com/rtomik/helm-charts
|
||||
sources:
|
||||
- https://github.com/karakeep-app/karakeep
|
||||
46
charts/karakeep/NOTES.txt
Normal file
46
charts/karakeep/NOTES.txt
Normal file
@ -0,0 +1,46 @@
|
||||
1. Get the application URL by running these commands:
|
||||
{{- if .Values.ingress.enabled }}
|
||||
{{- range $host := .Values.ingress.hosts }}
|
||||
{{- range .paths }}
|
||||
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- else if contains "NodePort" .Values.service.type }}
|
||||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "karakeep.fullname" . }})
|
||||
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
|
||||
echo http://$NODE_IP:$NODE_PORT
|
||||
{{- else if contains "LoadBalancer" .Values.service.type }}
|
||||
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
|
||||
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "karakeep.fullname" . }}'
|
||||
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "karakeep.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
|
||||
echo http://$SERVICE_IP:{{ .Values.service.port }}
|
||||
{{- else if contains "ClusterIP" .Values.service.type }}
|
||||
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "{{ include "karakeep.selectorLabels" . }}" -o jsonpath="{.items[0].metadata.name}")
|
||||
export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
|
||||
echo "Visit http://127.0.0.1:3000 to use your application"
|
||||
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 3000:$CONTAINER_PORT
|
||||
{{- end }}
|
||||
|
||||
2. Karakeep has been deployed with the following components:
|
||||
- Main application (Karakeep)
|
||||
- MeiliSearch for search functionality
|
||||
- Chrome browser for web scraping
|
||||
|
||||
{{- if not .Values.persistence.enabled }}
|
||||
3. WARNING: Persistence is disabled. Data will be lost when pods are restarted.
|
||||
Enable persistence by setting:
|
||||
persistence.enabled=true
|
||||
{{- end }}
|
||||
|
||||
4. IMPORTANT: Configuration for production:
|
||||
- Generate a secure 32-character random string for NEXTAUTH_SECRET
|
||||
- NEXTAUTH_URL is automatically set when ingress is enabled
|
||||
- Update secrets or environment variables as needed
|
||||
|
||||
{{- if not .Values.secrets.create }}
|
||||
{{- if not .Values.secrets.existingSecret }}
|
||||
5. Optional: Configure additional API keys via secrets:
|
||||
- OPENAI_API_KEY for AI features
|
||||
- MEILI_MASTER_KEY for MeiliSearch authentication
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
108
charts/karakeep/readme.md
Normal file
108
charts/karakeep/readme.md
Normal file
@ -0,0 +1,108 @@
|
||||
# Karakeep Helm Chart
|
||||
|
||||
This Helm chart deploys [Karakeep](https://github.com/karakeep-app/karakeep), a bookmark management application, along with its required services on a Kubernetes cluster.
|
||||
|
||||
## Components
|
||||
|
||||
This chart deploys three containers in a single pod:
|
||||
|
||||
1. **Karakeep**: The main bookmark management application
|
||||
2. **Chrome**: Headless Chrome browser for web scraping and preview generation
|
||||
3. **MeiliSearch**: Search engine for fast bookmark search functionality
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
- Helm 3.2.0+
|
||||
- PV provisioner support in the underlying infrastructure (if persistence is enabled)
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `karakeep`:
|
||||
|
||||
```bash
|
||||
helm repo add karakeep-chart https://rtomik.github.io/helm-charts
|
||||
helm install karakeep karakeep-chart/karakeep
|
||||
```
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall/delete the `karakeep` deployment:
|
||||
|
||||
```bash
|
||||
helm delete karakeep
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
The following table lists the configurable parameters and their default values.
|
||||
|
||||
### Global Settings
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-----------|-------------|---------|
|
||||
| `nameOverride` | Override the name of the chart | `""` |
|
||||
| `fullnameOverride` | Override the full name of the chart | `""` |
|
||||
| `replicaCount` | Number of replicas | `1` |
|
||||
|
||||
### Karakeep Configuration
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-----------|-------------|---------|
|
||||
| `karakeep.image.repository` | Karakeep image repository | `ghcr.io/karakeep-app/karakeep` |
|
||||
| `karakeep.image.tag` | Karakeep image tag | `"release"` |
|
||||
| `karakeep.image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
||||
|
||||
### Chrome Configuration
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-----------|-------------|---------|
|
||||
| `chrome.image.repository` | Chrome image repository | `gcr.io/zenika-hub/alpine-chrome` |
|
||||
| `chrome.image.tag` | Chrome image tag | `"124"` |
|
||||
|
||||
### MeiliSearch Configuration
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-----------|-------------|---------|
|
||||
| `meilisearch.image.repository` | MeiliSearch image repository | `getmeili/meilisearch` |
|
||||
| `meilisearch.image.tag` | MeiliSearch image tag | `"v1.13.3"` |
|
||||
|
||||
### Persistence
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-----------|-------------|---------|
|
||||
| `persistence.enabled` | Enable persistent storage | `true` |
|
||||
| `persistence.data.size` | Size of data volume | `5Gi` |
|
||||
| `persistence.data.storageClass` | Storage class for data volume | `""` |
|
||||
| `persistence.meilisearch.size` | Size of MeiliSearch volume | `2Gi` |
|
||||
| `persistence.meilisearch.storageClass` | Storage class for MeiliSearch volume | `""` |
|
||||
|
||||
### Ingress
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-----------|-------------|---------|
|
||||
| `ingress.enabled` | Enable ingress | `false` |
|
||||
| `ingress.hosts[0].host` | Hostname | `karakeep.domain.com` |
|
||||
|
||||
### Secrets
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|-----------|-------------|---------|
|
||||
| `secrets.create` | Create secret for environment variables | `false` |
|
||||
| `secrets.existingSecret` | Use existing secret | `""` |
|
||||
| `secrets.env` | Environment variables to store in secret | `{}` |
|
||||
|
||||
**Important Configuration:**
|
||||
1. The default `NEXTAUTH_SECRET` is set to a placeholder value. For production deployments, you should either:
|
||||
- Override the value: `--set karakeep.env[3].value="your-secure-32-character-string"`
|
||||
- Use secrets: `--set secrets.create=true --set secrets.env.NEXTAUTH_SECRET="your-secure-32-character-string"`
|
||||
|
||||
2. When ingress is enabled, `NEXTAUTH_URL` is automatically set to the ingress hostname. For custom configurations:
|
||||
- Override manually: `--set karakeep.env[4].value="https://your-domain.com"`
|
||||
|
||||
## Notes
|
||||
|
||||
- This chart creates a multi-container pod with all three services running together
|
||||
- Data persistence is enabled by default with separate volumes for Karakeep data and MeiliSearch indices
|
||||
- The services communicate via localhost since they share the same pod network
|
||||
- Chrome runs with security flags for containerized environments
|
||||
70
charts/karakeep/templates/_helpers.tpl
Normal file
70
charts/karakeep/templates/_helpers.tpl
Normal file
@ -0,0 +1,70 @@
|
||||
{{/*
|
||||
Expand the name of the chart.
|
||||
*/}}
|
||||
{{- define "karakeep.name" -}}
|
||||
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create a default fully qualified app name.
|
||||
*/}}
|
||||
{{- define "karakeep.fullname" -}}
|
||||
{{- if .Values.fullnameOverride }}
|
||||
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- else }}
|
||||
{{- $name := default .Chart.Name .Values.nameOverride }}
|
||||
{{- printf "%s" $name | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create chart name and version as used by the chart label.
|
||||
*/}}
|
||||
{{- define "karakeep.chart" -}}
|
||||
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Common labels
|
||||
*/}}
|
||||
{{- define "karakeep.labels" -}}
|
||||
helm.sh/chart: {{ include "karakeep.chart" . }}
|
||||
{{ include "karakeep.selectorLabels" . }}
|
||||
{{- if .Chart.AppVersion }}
|
||||
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
|
||||
{{- end }}
|
||||
app.kubernetes.io/managed-by: {{ .Release.Service }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Selector labels
|
||||
*/}}
|
||||
{{- define "karakeep.selectorLabels" -}}
|
||||
app.kubernetes.io/name: {{ include "karakeep.name" . }}
|
||||
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create the name of the secret to use
|
||||
*/}}
|
||||
{{- define "karakeep.secretName" -}}
|
||||
{{- if .Values.secrets.existingSecret }}
|
||||
{{- .Values.secrets.existingSecret }}
|
||||
{{- else }}
|
||||
{{- include "karakeep.fullname" . }}-secret
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create the name of the data PVC
|
||||
*/}}
|
||||
{{- define "karakeep.dataPvcName" -}}
|
||||
{{- include "karakeep.fullname" . }}-data
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create the name of the meilisearch PVC
|
||||
*/}}
|
||||
{{- define "karakeep.meilisearchPvcName" -}}
|
||||
{{- include "karakeep.fullname" . }}-meilisearch
|
||||
{{- end }}
|
||||
191
charts/karakeep/templates/deployment.yaml
Normal file
191
charts/karakeep/templates/deployment.yaml
Normal file
@ -0,0 +1,191 @@
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: {{ include "karakeep.fullname" . }}
|
||||
labels:
|
||||
{{- include "karakeep.labels" . | nindent 4 }}
|
||||
spec:
|
||||
replicas: {{ .Values.replicaCount }}
|
||||
revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
|
||||
selector:
|
||||
matchLabels:
|
||||
{{- include "karakeep.selectorLabels" . | nindent 6 }}
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
{{- include "karakeep.selectorLabels" . | nindent 8 }}
|
||||
spec:
|
||||
{{- with .Values.nodeSelector }}
|
||||
nodeSelector:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.affinity }}
|
||||
affinity:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.tolerations }}
|
||||
tolerations:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.podSecurityContext | nindent 8 }}
|
||||
containers:
|
||||
# Karakeep main application
|
||||
- name: karakeep
|
||||
image: "{{ .Values.karakeep.image.repository }}:{{ .Values.karakeep.image.tag }}"
|
||||
imagePullPolicy: {{ .Values.karakeep.image.pullPolicy }}
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: {{ .Values.karakeep.service.port }}
|
||||
protocol: TCP
|
||||
env:
|
||||
{{- range .Values.karakeep.env }}
|
||||
- name: {{ .name }}
|
||||
{{- if and (eq .name "NEXTAUTH_URL") $.Values.ingress.enabled }}
|
||||
{{- $host := (index $.Values.ingress.hosts 0).host }}
|
||||
{{- if $.Values.ingress.tls }}
|
||||
value: "https://{{ $host }}"
|
||||
{{- else }}
|
||||
value: "http://{{ $host }}"
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
value: {{ .value | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range .Values.karakeep.extraEnv }}
|
||||
- name: {{ .name }}
|
||||
{{- if .value }}
|
||||
value: {{ .value | quote }}
|
||||
{{- else if .valueFrom }}
|
||||
valueFrom:
|
||||
{{- toYaml .valueFrom | nindent 16 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if or .Values.secrets.create .Values.secrets.existingSecret }}
|
||||
envFrom:
|
||||
- secretRef:
|
||||
name: {{ include "karakeep.secretName" . }}
|
||||
{{- end }}
|
||||
volumeMounts:
|
||||
- name: data
|
||||
mountPath: /data
|
||||
securityContext:
|
||||
{{- toYaml .Values.containerSecurityContext | nindent 12 }}
|
||||
{{- with .Values.karakeep.resources }}
|
||||
resources:
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: /
|
||||
port: http
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 30
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /
|
||||
port: http
|
||||
initialDelaySeconds: 15
|
||||
periodSeconds: 10
|
||||
|
||||
# Chrome browser sidecar
|
||||
- name: chrome
|
||||
image: "{{ .Values.chrome.image.repository }}:{{ .Values.chrome.image.tag }}"
|
||||
imagePullPolicy: {{ .Values.chrome.image.pullPolicy }}
|
||||
args:
|
||||
{{- range .Values.chrome.args }}
|
||||
- {{ . | quote }}
|
||||
{{- end }}
|
||||
ports:
|
||||
- name: debug
|
||||
containerPort: {{ .Values.chrome.service.port }}
|
||||
protocol: TCP
|
||||
securityContext:
|
||||
{{- toYaml .Values.chrome.securityContext | nindent 12 }}
|
||||
{{- with .Values.chrome.resources }}
|
||||
resources:
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: /json/version
|
||||
port: debug
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 30
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /json/version
|
||||
port: debug
|
||||
initialDelaySeconds: 10
|
||||
periodSeconds: 5
|
||||
|
||||
# MeiliSearch sidecar
|
||||
- name: meilisearch
|
||||
image: "{{ .Values.meilisearch.image.repository }}:{{ .Values.meilisearch.image.tag }}"
|
||||
imagePullPolicy: {{ .Values.meilisearch.image.pullPolicy }}
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: {{ .Values.meilisearch.service.port }}
|
||||
protocol: TCP
|
||||
env:
|
||||
{{- range .Values.meilisearch.env }}
|
||||
- name: {{ .name }}
|
||||
value: {{ .value | quote }}
|
||||
{{- end }}
|
||||
{{- range .Values.meilisearch.extraEnv }}
|
||||
- name: {{ .name }}
|
||||
{{- if .value }}
|
||||
value: {{ .value | quote }}
|
||||
{{- else if .valueFrom }}
|
||||
valueFrom:
|
||||
{{- toYaml .valueFrom | nindent 16 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if or .Values.secrets.create .Values.secrets.existingSecret }}
|
||||
envFrom:
|
||||
- secretRef:
|
||||
name: {{ include "karakeep.secretName" . }}
|
||||
{{- end }}
|
||||
volumeMounts:
|
||||
- name: meilisearch-data
|
||||
mountPath: /meili_data
|
||||
securityContext:
|
||||
{{- toYaml .Values.meilisearch.securityContext | nindent 12 }}
|
||||
{{- with .Values.meilisearch.resources }}
|
||||
resources:
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
startupProbe:
|
||||
httpGet:
|
||||
path: /health
|
||||
port: http
|
||||
initialDelaySeconds: 10
|
||||
periodSeconds: 5
|
||||
failureThreshold: 30
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: /health
|
||||
port: http
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 30
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /health
|
||||
port: http
|
||||
initialDelaySeconds: 15
|
||||
periodSeconds: 10
|
||||
|
||||
volumes:
|
||||
{{- if .Values.persistence.enabled }}
|
||||
- name: data
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ include "karakeep.dataPvcName" . }}
|
||||
- name: meilisearch-data
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ include "karakeep.meilisearchPvcName" . }}
|
||||
{{- else }}
|
||||
- name: data
|
||||
emptyDir: {}
|
||||
- name: meilisearch-data
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
41
charts/karakeep/templates/ingress.yaml
Normal file
41
charts/karakeep/templates/ingress.yaml
Normal file
@ -0,0 +1,41 @@
|
||||
{{- if .Values.ingress.enabled -}}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: {{ include "karakeep.fullname" . }}
|
||||
labels:
|
||||
{{- include "karakeep.labels" . | nindent 4 }}
|
||||
{{- with .Values.ingress.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- if .Values.ingress.className }}
|
||||
ingressClassName: {{ .Values.ingress.className }}
|
||||
{{- end }}
|
||||
{{- if .Values.ingress.tls }}
|
||||
tls:
|
||||
{{- range .Values.ingress.tls }}
|
||||
- hosts:
|
||||
{{- range .hosts }}
|
||||
- {{ . | quote }}
|
||||
{{- end }}
|
||||
secretName: {{ .secretName }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
rules:
|
||||
{{- range .Values.ingress.hosts }}
|
||||
- host: {{ .host | quote }}
|
||||
http:
|
||||
paths:
|
||||
{{- range .paths }}
|
||||
- path: {{ .path }}
|
||||
pathType: {{ .pathType }}
|
||||
backend:
|
||||
service:
|
||||
name: {{ include "karakeep.fullname" $ }}
|
||||
port:
|
||||
number: {{ $.Values.service.port }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
43
charts/karakeep/templates/pvc.yaml
Normal file
43
charts/karakeep/templates/pvc.yaml
Normal file
@ -0,0 +1,43 @@
|
||||
{{- if .Values.persistence.enabled }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "karakeep.dataPvcName" . }}
|
||||
labels:
|
||||
{{- include "karakeep.labels" . | nindent 4 }}
|
||||
component: data
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.data.accessMode }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.data.size }}
|
||||
{{- if .Values.persistence.data.storageClass }}
|
||||
{{- if (eq "-" .Values.persistence.data.storageClass) }}
|
||||
storageClassName: ""
|
||||
{{- else }}
|
||||
storageClassName: {{ .Values.persistence.data.storageClass }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "karakeep.meilisearchPvcName" . }}
|
||||
labels:
|
||||
{{- include "karakeep.labels" . | nindent 4 }}
|
||||
component: meilisearch
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.meilisearch.accessMode }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.meilisearch.size }}
|
||||
{{- if .Values.persistence.meilisearch.storageClass }}
|
||||
{{- if (eq "-" .Values.persistence.meilisearch.storageClass) }}
|
||||
storageClassName: ""
|
||||
{{- else }}
|
||||
storageClassName: {{ .Values.persistence.meilisearch.storageClass }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
13
charts/karakeep/templates/secret.yaml
Normal file
13
charts/karakeep/templates/secret.yaml
Normal file
@ -0,0 +1,13 @@
|
||||
{{- if .Values.secrets.create }}
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: {{ include "karakeep.secretName" . }}
|
||||
labels:
|
||||
{{- include "karakeep.labels" . | nindent 4 }}
|
||||
type: Opaque
|
||||
data:
|
||||
{{- range $key, $value := .Values.secrets.env }}
|
||||
{{ $key }}: {{ $value | b64enc }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
15
charts/karakeep/templates/service.yaml
Normal file
15
charts/karakeep/templates/service.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: {{ include "karakeep.fullname" . }}
|
||||
labels:
|
||||
{{- include "karakeep.labels" . | nindent 4 }}
|
||||
spec:
|
||||
type: {{ .Values.service.type }}
|
||||
ports:
|
||||
- port: {{ .Values.service.port }}
|
||||
targetPort: http
|
||||
protocol: TCP
|
||||
name: http
|
||||
selector:
|
||||
{{- include "karakeep.selectorLabels" . | nindent 4 }}
|
||||
170
charts/karakeep/values.yaml
Normal file
170
charts/karakeep/values.yaml
Normal file
@ -0,0 +1,170 @@
|
||||
## Global settings
|
||||
nameOverride: ""
|
||||
fullnameOverride: ""
|
||||
|
||||
## Deployment settings
|
||||
replicaCount: 1
|
||||
revisionHistoryLimit: 3
|
||||
|
||||
# Pod security settings
|
||||
podSecurityContext:
|
||||
runAsNonRoot: false
|
||||
runAsUser: 0
|
||||
fsGroup: 0
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
readOnlyRootFilesystem: false
|
||||
capabilities:
|
||||
drop:
|
||||
- ALL
|
||||
|
||||
## Pod scheduling
|
||||
nodeSelector: {}
|
||||
tolerations: []
|
||||
affinity: {}
|
||||
|
||||
## Karakeep Web Application
|
||||
karakeep:
|
||||
image:
|
||||
repository: ghcr.io/karakeep-app/karakeep
|
||||
tag: "0.26.0"
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
securityContext: {}
|
||||
|
||||
env:
|
||||
- name: DATA_DIR
|
||||
value: "/data"
|
||||
- name: MEILI_ADDR
|
||||
value: "http://localhost:7700"
|
||||
- name: BROWSER_WEB_URL
|
||||
value: "http://localhost:9222"
|
||||
- name: NEXTAUTH_SECRET
|
||||
value: "changeme-generate-a-secure-random-string"
|
||||
- name: NEXTAUTH_URL
|
||||
value: "http://localhost:3000"
|
||||
|
||||
extraEnv: []
|
||||
# - name: OPENAI_API_KEY
|
||||
# valueFrom:
|
||||
# secretKeyRef:
|
||||
# name: karakeep-secrets
|
||||
# key: openai-api-key
|
||||
|
||||
service:
|
||||
port: 3000
|
||||
|
||||
#resources:
|
||||
# limits:
|
||||
# cpu: 500m
|
||||
# memory: 1Gi
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 256Mi
|
||||
|
||||
## Chrome Browser Service
|
||||
chrome:
|
||||
image:
|
||||
repository: gcr.io/zenika-hub/alpine-chrome
|
||||
tag: "124"
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
securityContext: {}
|
||||
|
||||
args:
|
||||
- --no-sandbox
|
||||
- --disable-gpu
|
||||
- --disable-dev-shm-usage
|
||||
- --remote-debugging-address=0.0.0.0
|
||||
- --remote-debugging-port=9222
|
||||
- --hide-scrollbars
|
||||
|
||||
service:
|
||||
port: 9222
|
||||
|
||||
#resources:
|
||||
# limits:
|
||||
# cpu: 500m
|
||||
# memory: 512Mi
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 128Mi
|
||||
|
||||
## MeiliSearch Service
|
||||
meilisearch:
|
||||
image:
|
||||
repository: getmeili/meilisearch
|
||||
tag: "v1.13.3"
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
securityContext: {}
|
||||
|
||||
env:
|
||||
- name: MEILI_NO_ANALYTICS
|
||||
value: "true"
|
||||
- name: MEILI_MAX_INDEXING_MEMORY
|
||||
value: "512MiB"
|
||||
- name: MEILI_MAX_INDEXING_THREADS
|
||||
value: "2"
|
||||
|
||||
extraEnv: []
|
||||
|
||||
service:
|
||||
port: 7700
|
||||
|
||||
resources:
|
||||
limits:
|
||||
cpu: 500m
|
||||
memory: 1Gi
|
||||
requests:
|
||||
cpu: 100m
|
||||
memory: 256Mi
|
||||
|
||||
## Service settings
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 3000
|
||||
|
||||
## Ingress settings
|
||||
ingress:
|
||||
enabled: false
|
||||
className: ""
|
||||
annotations:
|
||||
traefik.ingress.kubernetes.io/router.entrypoints: websecure
|
||||
hosts:
|
||||
- host: karakeep.<domain.com>
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- karakeep.<domain.com>
|
||||
|
||||
## Persistence settings
|
||||
persistence:
|
||||
enabled: true
|
||||
|
||||
# Karakeep data storage
|
||||
data:
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 5Gi
|
||||
|
||||
# MeiliSearch data storage
|
||||
meilisearch:
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 2Gi
|
||||
|
||||
## Secret configuration
|
||||
secrets:
|
||||
# Set to true to create a secret for environment variables
|
||||
create: false
|
||||
# Name of existing secret to use
|
||||
existingSecret: ""
|
||||
# Environment variables to include in secret
|
||||
env: {}
|
||||
# NEXTAUTH_SECRET: "your-secure-random-string"
|
||||
# OPENAI_API_KEY: "your-openai-api-key"
|
||||
# MEILI_MASTER_KEY: "your-meilisearch-master-key"
|
||||
17
charts/mealie/Chart.yaml
Normal file
17
charts/mealie/Chart.yaml
Normal file
@ -0,0 +1,17 @@
|
||||
apiVersion: v2
|
||||
name: mealie
|
||||
description: Mealie helm chart for Kubernetes - Recipe management and meal planning
|
||||
type: application
|
||||
version: 0.0.2
|
||||
appVersion: "v3.2.1"
|
||||
maintainers:
|
||||
- name: Richard Tomik
|
||||
email: no@m.com
|
||||
keywords:
|
||||
- recipe-management
|
||||
- meal-planning
|
||||
- cooking
|
||||
- mealie
|
||||
home: https://github.com/rtomik/helm-charts
|
||||
sources:
|
||||
- https://github.com/mealie-recipes/mealie
|
||||
84
charts/mealie/NOTES.txt
Normal file
84
charts/mealie/NOTES.txt
Normal file
@ -0,0 +1,84 @@
|
||||
1. Get the application URL by running these commands:
|
||||
{{- if .Values.ingress.enabled }}
|
||||
{{- range $host := .Values.ingress.hosts }}
|
||||
{{- range .paths }}
|
||||
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- else if contains "NodePort" .Values.service.type }}
|
||||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "mealie.fullname" . }})
|
||||
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
|
||||
echo http://$NODE_IP:$NODE_PORT
|
||||
{{- else if contains "LoadBalancer" .Values.service.type }}
|
||||
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
|
||||
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "mealie.fullname" . }}'
|
||||
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "mealie.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
|
||||
echo http://$SERVICE_IP:{{ .Values.service.port }}
|
||||
{{- else if contains "ClusterIP" .Values.service.type }}
|
||||
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "mealie.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
|
||||
export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
|
||||
echo "Visit http://127.0.0.1:8080 to use your application"
|
||||
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
|
||||
{{- end }}
|
||||
|
||||
2. Mealie application is configured with:
|
||||
- Database: {{ .Values.env.DB_ENGINE }}
|
||||
- User signup: {{ if eq .Values.env.ALLOW_SIGNUP "true" }}enabled{{ else }}disabled{{ end }}
|
||||
- API port: {{ .Values.env.API_PORT }}
|
||||
|
||||
{{- if .Values.persistence.enabled }}
|
||||
3. Data is persisted using PVC: {{ include "mealie.fullname" . }}-data
|
||||
{{- else }}
|
||||
3. WARNING: No persistence enabled. Data will be lost when pods are restarted.
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.postgresql.external.enabled }}
|
||||
4. Using external PostgreSQL database:
|
||||
- Host: {{ .Values.postgresql.external.host }}
|
||||
- Database: {{ .Values.postgresql.external.database }}
|
||||
{{- end }}
|
||||
|
||||
{{- if or .Values.email.enabled .Values.ldap.enabled .Values.oidc.enabled .Values.openai.enabled }}
|
||||
5. Additional features enabled:
|
||||
{{- if .Values.email.enabled }}
|
||||
- SMTP Email notifications configured
|
||||
{{- end }}
|
||||
{{- if .Values.ldap.enabled }}
|
||||
- LDAP authentication enabled
|
||||
{{- end }}
|
||||
{{- if .Values.oidc.enabled }}
|
||||
- OpenID Connect (OIDC) authentication enabled
|
||||
{{- end }}
|
||||
{{- if .Values.openai.enabled }}
|
||||
- OpenAI integration enabled for AI features
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{- if or .Values.postgresql.external.existingSecret .Values.email.existingSecret .Values.ldap.existingSecret .Values.oidc.existingSecret .Values.openai.existingSecret .Values.tls.existingSecret }}
|
||||
|
||||
6. Using external secrets for sensitive information:
|
||||
{{- if .Values.postgresql.external.existingSecret }}
|
||||
- Database credentials from: {{ .Values.postgresql.external.existingSecret }}
|
||||
{{- end }}
|
||||
{{- if .Values.email.existingSecret }}
|
||||
- SMTP credentials from: {{ .Values.email.existingSecret }}
|
||||
{{- end }}
|
||||
{{- if .Values.ldap.existingSecret }}
|
||||
- LDAP credentials from: {{ .Values.ldap.existingSecret }}
|
||||
{{- end }}
|
||||
{{- if .Values.oidc.existingSecret }}
|
||||
- OIDC credentials from: {{ .Values.oidc.existingSecret }}
|
||||
{{- end }}
|
||||
{{- if .Values.openai.existingSecret }}
|
||||
- OpenAI API key from: {{ .Values.openai.existingSecret }}
|
||||
{{- end }}
|
||||
{{- if .Values.tls.existingSecret }}
|
||||
- TLS certificates from: {{ .Values.tls.existingSecret }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
|
||||
6. SECURITY NOTE: For production use, it's recommended to store sensitive data in Kubernetes Secrets.
|
||||
Consider using existingSecret options for database, email, LDAP, OIDC, and OpenAI configurations.
|
||||
{{- end }}
|
||||
|
||||
For more information about using this Helm chart, please refer to the readme.md file.
|
||||
352
charts/mealie/readme.md
Normal file
352
charts/mealie/readme.md
Normal file
@ -0,0 +1,352 @@
|
||||
# Mealie Helm Chart
|
||||
|
||||
A Helm chart for deploying Mealie recipe management and meal planning application on Kubernetes.
|
||||
|
||||
## Introduction
|
||||
|
||||
This chart deploys [Mealie](https://github.com/mealie-recipes/mealie) on a Kubernetes cluster using the Helm package manager. Mealie is a self-hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in Vue for a pleasant user experience for the whole family.
|
||||
|
||||
Source code can be found here:
|
||||
- https://github.com/rtomik/helm-charts/tree/main/charts/mealie
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
- Helm 3.0+
|
||||
- PV provisioner support in the underlying infrastructure (if persistence is needed)
|
||||
- External Postgresql DB like https://cloudnative-pg.io/
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `mealie`:
|
||||
|
||||
```bash
|
||||
$ helm repo add mealie-chart https://rtomik.github.io/helm-charts
|
||||
$ helm install mealie mealie-chart/mealie
|
||||
```
|
||||
|
||||
> **Tip**: List all releases using `helm list`
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall/delete the `mealie` deployment:
|
||||
|
||||
```bash
|
||||
$ helm uninstall mealie
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
### Global parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------------------------|------------------------------------------------|-------|
|
||||
| `nameOverride` | String to partially override the release name | `""` |
|
||||
| `fullnameOverride` | String to fully override the release name | `""` |
|
||||
|
||||
### Image parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------|-----------------------------------|-----------------------------------|
|
||||
| `image.repository` | Mealie image repository | `ghcr.io/mealie-recipes/mealie` |
|
||||
| `image.tag` | Mealie image tag | `v3.1.1` |
|
||||
| `image.pullPolicy` | Mealie image pull policy | `IfNotPresent` |
|
||||
|
||||
### Deployment parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------------------|-----------------------------------------------|-----------|
|
||||
| `replicaCount` | Number of Mealie replicas | `1` |
|
||||
| `revisionHistoryLimit` | Number of revisions to retain for rollback | `3` |
|
||||
| `podSecurityContext.runAsNonRoot` | Run containers as non-root user | `false` |
|
||||
| `podSecurityContext.runAsUser` | User ID for the container | `911` |
|
||||
| `podSecurityContext.fsGroup` | Group ID for the container filesystem | `911` |
|
||||
| `containerSecurityContext` | Security context for the container | See values.yaml |
|
||||
| `nodeSelector` | Node labels for pod assignment | `{}` |
|
||||
| `tolerations` | Tolerations for pod assignment | `[]` |
|
||||
| `affinity` | Affinity for pod assignment | `{}` |
|
||||
|
||||
### Service parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------|-----------------------|-------------|
|
||||
| `service.type` | Kubernetes Service type | `ClusterIP` |
|
||||
| `service.port` | Service HTTP port | `9000` |
|
||||
|
||||
### Ingress parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------|-------------------------------------------|-----------------|
|
||||
| `ingress.enabled` | Enable ingress record generation | `false` |
|
||||
| `ingress.className` | IngressClass name | `""` |
|
||||
| `ingress.annotations` | Additional annotations for the Ingress | See values.yaml |
|
||||
| `ingress.hosts` | Array of host and path objects | See values.yaml |
|
||||
| `ingress.tls` | TLS configuration | See values.yaml |
|
||||
|
||||
### Persistence parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------|----------------------------------|-----------------|
|
||||
| `persistence.enabled` | Enable persistence using PVC | `true` |
|
||||
| `persistence.storageClass` | PVC Storage Class | `""` |
|
||||
| `persistence.accessMode` | PVC Access Mode | `ReadWriteOnce` |
|
||||
| `persistence.size` | PVC Size | `5Gi` |
|
||||
| `persistence.annotations` | Annotations for PVC | `{}` |
|
||||
|
||||
### Environment variables
|
||||
|
||||
| Name | Description | Value |
|
||||
|---------------------------------------|-----------------------------------------------|-----------------|
|
||||
| `env.PUID` | UserID permissions between host OS and container | `911` |
|
||||
| `env.PGID` | GroupID permissions between host OS and container | `911` |
|
||||
| `env.DEFAULT_GROUP` | The default group for users | `Home` |
|
||||
| `env.DEFAULT_HOUSEHOLD` | The default household for users in each group | `Family` |
|
||||
| `env.BASE_URL` | Used for Notifications | `http://localhost:9000` |
|
||||
| `env.TOKEN_TIME` | The time in hours that a login/auth token is valid | `48` |
|
||||
| `env.API_PORT` | The port exposed by backend API | `9000` |
|
||||
| `env.API_DOCS` | Turns on/off access to the API documentation | `true` |
|
||||
| `env.TZ` | Must be set to get correct date/time on the server | `UTC` |
|
||||
| `env.ALLOW_SIGNUP` | Allow user sign-up without token | `false` |
|
||||
| `env.ALLOW_PASSWORD_LOGIN` | Whether or not to display username+password input fields | `true` |
|
||||
| `env.LOG_LEVEL` | Logging level | `info` |
|
||||
| `env.DAILY_SCHEDULE_TIME` | Time to run daily server tasks (HH:MM) | `23:45` |
|
||||
|
||||
### PostgreSQL configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|-----------------------------------------------|-----------|
|
||||
| `postgresql.enabled` | Enable PostgreSQL support | `false` |
|
||||
| `postgresql.external.enabled` | Use external PostgreSQL database | `false` |
|
||||
| `postgresql.external.host` | PostgreSQL host | `""` |
|
||||
| `postgresql.external.port` | PostgreSQL port | `5432` |
|
||||
| `postgresql.external.database` | PostgreSQL database name | `mealie` |
|
||||
| `postgresql.external.user` | PostgreSQL username | `mealie` |
|
||||
| `postgresql.external.password` | PostgreSQL password | `""` |
|
||||
| `postgresql.external.existingSecret` | Name of existing secret with PostgreSQL credentials | `""` |
|
||||
| `postgresql.external.userKey` | Key in the secret for username | `username` |
|
||||
| `postgresql.external.passwordKey` | Key in the secret for password | `password` |
|
||||
|
||||
### Email (SMTP) configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------|--------------------------------------|-----------|
|
||||
| `email.enabled` | Enable SMTP email support | `false` |
|
||||
| `email.host` | SMTP host | `""` |
|
||||
| `email.port` | SMTP port | `587` |
|
||||
| `email.fromName` | From name for emails | `Mealie` |
|
||||
| `email.authStrategy` | SMTP auth strategy (TLS, SSL, NONE) | `TLS` |
|
||||
| `email.fromEmail` | From email address | `""` |
|
||||
| `email.user` | SMTP username | `""` |
|
||||
| `email.password` | SMTP password | `""` |
|
||||
| `email.existingSecret` | Name of existing secret with SMTP credentials | `""` |
|
||||
| `email.userKey` | Key in the secret for SMTP username | `smtp-user` |
|
||||
| `email.passwordKey` | Key in the secret for SMTP password | `smtp-password` |
|
||||
|
||||
### LDAP Authentication
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------|--------------------------------------|-----------|
|
||||
| `ldap.enabled` | Enable LDAP authentication | `false` |
|
||||
| `ldap.serverUrl` | LDAP server URL | `""` |
|
||||
| `ldap.tlsInsecure` | Do not verify server certificate | `false` |
|
||||
| `ldap.tlsCaCertFile` | Path to CA certificate file | `""` |
|
||||
| `ldap.enableStartTls` | Use STARTTLS to connect to server | `false` |
|
||||
| `ldap.baseDn` | Starting point for user authentication | `""` |
|
||||
| `ldap.queryBind` | Optional bind user for LDAP searches | `""` |
|
||||
| `ldap.queryPassword` | Password for the bind user | `""` |
|
||||
| `ldap.userFilter` | LDAP filter to narrow down eligible users | `""` |
|
||||
| `ldap.adminFilter` | LDAP filter for admin users | `""` |
|
||||
| `ldap.idAttribute` | LDAP attribute for user ID | `uid` |
|
||||
| `ldap.nameAttribute` | LDAP attribute for user name | `name` |
|
||||
| `ldap.mailAttribute` | LDAP attribute for user email | `mail` |
|
||||
|
||||
### OpenID Connect (OIDC)
|
||||
|
||||
| Name | Description | Value |
|
||||
|------------------------------|------------------------------------------|-----------|
|
||||
| `oidc.enabled` | Enable OIDC authentication | `false` |
|
||||
| `oidc.signupEnabled` | Allow new users via OIDC | `true` |
|
||||
| `oidc.configurationUrl` | URL to OIDC configuration | `""` |
|
||||
| `oidc.clientId` | OIDC client ID | `""` |
|
||||
| `oidc.clientSecret` | OIDC client secret | `""` |
|
||||
| `oidc.userGroup` | Required OIDC user group | `""` |
|
||||
| `oidc.adminGroup` | OIDC admin group | `""` |
|
||||
| `oidc.autoRedirect` | Bypass login page and redirect to IdP | `false` |
|
||||
| `oidc.providerName` | Provider name shown in login button | `OAuth` |
|
||||
| `oidc.rememberMe` | Extend session as if "Remember Me" was checked | `false` |
|
||||
| `oidc.signingAlgorithm` | Algorithm used to sign the id token | `RS256` |
|
||||
| `oidc.userClaim` | Claim to look up existing user by | `email` |
|
||||
| `oidc.nameClaim` | Claim for user's full name | `name` |
|
||||
| `oidc.groupsClaim` | Claim for user groups | `groups` |
|
||||
|
||||
### OpenAI Integration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------------------------------------|------------------------------------------|-----------|
|
||||
| `openai.enabled` | Enable OpenAI integration | `false` |
|
||||
| `openai.baseUrl` | Base URL for OpenAI API | `""` |
|
||||
| `openai.apiKey` | OpenAI API key | `""` |
|
||||
| `openai.model` | OpenAI model to use | `gpt-4o` |
|
||||
| `openai.customHeaders` | Custom HTTP headers for OpenAI requests | `""` |
|
||||
| `openai.customParams` | Custom HTTP query params for OpenAI requests | `""` |
|
||||
| `openai.enableImageServices` | Enable OpenAI image services | `true` |
|
||||
| `openai.workers` | Number of OpenAI workers per request | `2` |
|
||||
| `openai.sendDatabaseData` | Send Mealie data to OpenAI to improve accuracy | `true` |
|
||||
| `openai.requestTimeout` | Timeout for OpenAI requests in seconds | `60` |
|
||||
|
||||
### TLS Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------|--------------------------------------|-----------|
|
||||
| `tls.enabled` | Enable TLS configuration | `false` |
|
||||
| `tls.certificatePath` | Path to TLS certificate file | `""` |
|
||||
| `tls.privateKeyPath` | Path to TLS private key file | `""` |
|
||||
| `tls.existingSecret` | Name of existing secret with TLS certificates | `""` |
|
||||
| `tls.certificateKey` | Key in the secret for TLS certificate | `tls.crt` |
|
||||
| `tls.privateKeyKey` | Key in the secret for TLS private key | `tls.key` |
|
||||
|
||||
### Theme Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------|--------------------------------|-----------|
|
||||
| `theme.light.primary` | Light theme primary color | `#E58325` |
|
||||
| `theme.light.accent` | Light theme accent color | `#007A99` |
|
||||
| `theme.light.secondary` | Light theme secondary color | `#973542` |
|
||||
| `theme.light.success` | Light theme success color | `#43A047` |
|
||||
| `theme.light.info` | Light theme info color | `#1976D2` |
|
||||
| `theme.light.warning` | Light theme warning color | `#FF6D00` |
|
||||
| `theme.light.error` | Light theme error color | `#EF5350` |
|
||||
| `theme.dark.primary` | Dark theme primary color | `#E58325` |
|
||||
| `theme.dark.accent` | Dark theme accent color | `#007A99` |
|
||||
| `theme.dark.secondary` | Dark theme secondary color | `#973542` |
|
||||
| `theme.dark.success` | Dark theme success color | `#43A047` |
|
||||
| `theme.dark.info` | Dark theme info color | `#1976D2` |
|
||||
| `theme.dark.warning` | Dark theme warning color | `#FF6D00` |
|
||||
| `theme.dark.error` | Dark theme error color | `#EF5350` |
|
||||
|
||||
### Resource Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------|--------------------------------------|-------|
|
||||
| `resources` | Resource limits and requests | `{}` |
|
||||
|
||||
### Health Checks
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------------------|------------------------------------------|-------|
|
||||
| `probes.liveness.enabled` | Enable liveness probe | `true` |
|
||||
| `probes.liveness.initialDelaySeconds` | Initial delay for liveness probe | `60` |
|
||||
| `probes.liveness.periodSeconds` | Period for liveness probe | `30` |
|
||||
| `probes.liveness.timeoutSeconds` | Timeout for liveness probe | `10` |
|
||||
| `probes.liveness.failureThreshold` | Failure threshold for liveness probe | `3` |
|
||||
| `probes.liveness.successThreshold` | Success threshold for liveness probe | `1` |
|
||||
| `probes.liveness.path` | Path for liveness probe | `/` |
|
||||
| `probes.readiness.enabled` | Enable readiness probe | `true` |
|
||||
| `probes.readiness.initialDelaySeconds` | Initial delay for readiness probe | `30` |
|
||||
| `probes.readiness.periodSeconds` | Period for readiness probe | `10` |
|
||||
| `probes.readiness.timeoutSeconds` | Timeout for readiness probe | `5` |
|
||||
| `probes.readiness.failureThreshold` | Failure threshold for readiness probe | `3` |
|
||||
| `probes.readiness.successThreshold` | Success threshold for readiness probe | `1` |
|
||||
| `probes.readiness.path` | Path for readiness probe | `/` |
|
||||
|
||||
### Autoscaling
|
||||
|
||||
| Name | Description | Value |
|
||||
|---------------------------------------------|------------------------------------------|---------|
|
||||
| `autoscaling.enabled` | Enable horizontal pod autoscaling | `false` |
|
||||
| `autoscaling.minReplicas` | Minimum number of replicas | `1` |
|
||||
| `autoscaling.maxReplicas` | Maximum number of replicas | `3` |
|
||||
| `autoscaling.targetCPUUtilizationPercentage`| Target CPU utilization percentage | `80` |
|
||||
| `autoscaling.targetMemoryUtilizationPercentage`| Target memory utilization percentage | `80` |
|
||||
|
||||
## Configuration Examples
|
||||
|
||||
### Basic Installation with Persistence
|
||||
|
||||
```yaml
|
||||
persistence:
|
||||
enabled: true
|
||||
size: 10Gi
|
||||
storageClass: "fast-ssd"
|
||||
|
||||
ingress:
|
||||
enabled: true
|
||||
hosts:
|
||||
- host: mealie.example.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- mealie.example.com
|
||||
secretName: mealie-tls
|
||||
```
|
||||
|
||||
### PostgreSQL Database Configuration
|
||||
|
||||
```yaml
|
||||
postgresql:
|
||||
external:
|
||||
enabled: true
|
||||
host: "postgresql.example.com"
|
||||
port: 5432
|
||||
database: "mealie"
|
||||
user: "mealie"
|
||||
existingSecret: "mealie-postgresql-secret"
|
||||
userKey: "username"
|
||||
passwordKey: "password"
|
||||
|
||||
env:
|
||||
DB_ENGINE: "postgres"
|
||||
```
|
||||
|
||||
### OIDC Authentication Setup
|
||||
|
||||
```yaml
|
||||
oidc:
|
||||
enabled: true
|
||||
configurationUrl: "https://auth.example.com/.well-known/openid-configuration"
|
||||
clientId: "mealie-client"
|
||||
existingSecret: "mealie-oidc-secret"
|
||||
clientIdKey: "client-id"
|
||||
clientSecretKey: "client-secret"
|
||||
autoRedirect: true
|
||||
providerName: "CompanySSO"
|
||||
```
|
||||
|
||||
### OpenAI Integration
|
||||
|
||||
```yaml
|
||||
openai:
|
||||
enabled: true
|
||||
baseUrl: "https://api.openai.com/v1"
|
||||
existingSecret: "mealie-openai-secret"
|
||||
apiKeyKey: "api-key"
|
||||
model: "gpt-4"
|
||||
enableImageServices: true
|
||||
```
|
||||
|
||||
## Security Considerations
|
||||
|
||||
For production deployments, it's recommended to:
|
||||
|
||||
1. Use external secrets for sensitive information
|
||||
2. Enable TLS/SSL for all communications
|
||||
3. Configure proper RBAC and network policies
|
||||
4. Use a dedicated database with proper access controls
|
||||
5. Enable authentication (LDAP/OIDC) and disable public signup
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and solutions:
|
||||
|
||||
1. **Database connection issues**: Verify database credentials and network connectivity
|
||||
2. **Persistence issues**: Check StorageClass and PVC configuration
|
||||
3. **Authentication problems**: Verify LDAP/OIDC configuration and network access
|
||||
4. **Performance issues**: Adjust resource limits and consider using external database
|
||||
|
||||
For more detailed troubleshooting, check the application logs:
|
||||
|
||||
```bash
|
||||
kubectl logs -f deployment/mealie
|
||||
```
|
||||
45
charts/mealie/templates/_helpers.tpl
Normal file
45
charts/mealie/templates/_helpers.tpl
Normal file
@ -0,0 +1,45 @@
|
||||
{{/*
|
||||
Expand the name of the chart.
|
||||
*/}}
|
||||
{{- define "mealie.name" -}}
|
||||
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create a default fully qualified app name.
|
||||
*/}}
|
||||
{{- define "mealie.fullname" -}}
|
||||
{{- if .Values.fullnameOverride }}
|
||||
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- else }}
|
||||
{{- $name := default .Chart.Name .Values.nameOverride }}
|
||||
{{- printf "%s" $name | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create chart name and version as used by the chart label.
|
||||
*/}}
|
||||
{{- define "mealie.chart" -}}
|
||||
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Common labels
|
||||
*/}}
|
||||
{{- define "mealie.labels" -}}
|
||||
helm.sh/chart: {{ include "mealie.chart" . }}
|
||||
{{ include "mealie.selectorLabels" . }}
|
||||
{{- if .Chart.AppVersion }}
|
||||
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
|
||||
{{- end }}
|
||||
app.kubernetes.io/managed-by: {{ .Release.Service }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Selector labels
|
||||
*/}}
|
||||
{{- define "mealie.selectorLabels" -}}
|
||||
app.kubernetes.io/name: {{ include "mealie.name" . }}
|
||||
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||
{{- end }}
|
||||
337
charts/mealie/templates/deployment.yaml
Normal file
337
charts/mealie/templates/deployment.yaml
Normal file
@ -0,0 +1,337 @@
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: {{ include "mealie.fullname" . }}
|
||||
labels:
|
||||
{{- include "mealie.labels" . | nindent 4 }}
|
||||
spec:
|
||||
replicas: {{ .Values.replicaCount }}
|
||||
revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
|
||||
selector:
|
||||
matchLabels:
|
||||
{{- include "mealie.selectorLabels" . | nindent 6 }}
|
||||
strategy:
|
||||
type: RollingUpdate
|
||||
rollingUpdate:
|
||||
maxUnavailable: 1
|
||||
maxSurge: 1
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
{{- include "mealie.selectorLabels" . | nindent 8 }}
|
||||
annotations:
|
||||
{{- with .Values.podAnnotations }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- with .Values.imagePullSecrets }}
|
||||
imagePullSecrets:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.podSecurityContext | nindent 8 }}
|
||||
containers:
|
||||
- name: {{ .Chart.Name }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.containerSecurityContext | nindent 12 }}
|
||||
image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
|
||||
imagePullPolicy: {{ .Values.image.pullPolicy }}
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: 9000
|
||||
protocol: TCP
|
||||
{{- if .Values.probes.liveness.enabled }}
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.liveness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.liveness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.liveness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.liveness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.liveness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.liveness.successThreshold }}
|
||||
{{- end }}
|
||||
{{- if .Values.probes.readiness.enabled }}
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.readiness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.readiness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.readiness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.readiness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.readiness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.readiness.successThreshold }}
|
||||
{{- end }}
|
||||
env:
|
||||
{{- range $key, $value := .Values.env }}
|
||||
- name: {{ $key }}
|
||||
value: {{ $value | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.postgresql.external.enabled }}
|
||||
- name: DB_ENGINE
|
||||
value: "postgres"
|
||||
- name: POSTGRES_SERVER
|
||||
value: {{ .Values.postgresql.external.host | quote }}
|
||||
- name: POSTGRES_PORT
|
||||
value: {{ .Values.postgresql.external.port | quote }}
|
||||
- name: POSTGRES_DB
|
||||
value: {{ .Values.postgresql.external.database | quote }}
|
||||
- name: POSTGRES_USER
|
||||
{{- if .Values.postgresql.external.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.postgresql.external.existingSecret }}
|
||||
key: {{ .Values.postgresql.external.userKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.postgresql.external.user | quote }}
|
||||
{{- end }}
|
||||
- name: POSTGRES_PASSWORD
|
||||
{{- if .Values.postgresql.external.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.postgresql.external.existingSecret }}
|
||||
key: {{ .Values.postgresql.external.passwordKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.postgresql.external.password | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.email.enabled }}
|
||||
- name: SMTP_HOST
|
||||
{{- if .Values.email.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.email.existingSecret }}
|
||||
key: "smtp-host"
|
||||
{{- else }}
|
||||
value: {{ .Values.email.host | quote }}
|
||||
{{- end }}
|
||||
- name: SMTP_PORT
|
||||
value: {{ .Values.email.port | quote }}
|
||||
- name: SMTP_FROM_NAME
|
||||
value: {{ .Values.email.fromName | quote }}
|
||||
- name: SMTP_AUTH_STRATEGY
|
||||
value: {{ .Values.email.authStrategy | quote }}
|
||||
- name: SMTP_FROM_EMAIL
|
||||
value: {{ .Values.email.fromEmail | quote }}
|
||||
{{- if and .Values.email.user (or (eq .Values.email.authStrategy "TLS") (eq .Values.email.authStrategy "SSL")) }}
|
||||
- name: SMTP_USER
|
||||
{{- if .Values.email.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.email.existingSecret }}
|
||||
key: {{ .Values.email.userKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.email.user | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if and .Values.email.password (or (eq .Values.email.authStrategy "TLS") (eq .Values.email.authStrategy "SSL")) }}
|
||||
- name: SMTP_PASSWORD
|
||||
{{- if .Values.email.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.email.existingSecret }}
|
||||
key: {{ .Values.email.passwordKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.email.password | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.ldap.enabled }}
|
||||
- name: LDAP_AUTH_ENABLED
|
||||
value: "true"
|
||||
- name: LDAP_SERVER_URL
|
||||
value: {{ .Values.ldap.serverUrl | quote }}
|
||||
- name: LDAP_TLS_INSECURE
|
||||
value: {{ .Values.ldap.tlsInsecure | quote }}
|
||||
{{- if .Values.ldap.tlsCaCertFile }}
|
||||
- name: LDAP_TLS_CACERTFILE
|
||||
value: {{ .Values.ldap.tlsCaCertFile | quote }}
|
||||
{{- end }}
|
||||
- name: LDAP_ENABLE_STARTTLS
|
||||
value: {{ .Values.ldap.enableStartTls | quote }}
|
||||
- name: LDAP_BASE_DN
|
||||
value: {{ .Values.ldap.baseDn | quote }}
|
||||
{{- if .Values.ldap.queryBind }}
|
||||
- name: LDAP_QUERY_BIND
|
||||
value: {{ .Values.ldap.queryBind | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.ldap.queryPassword }}
|
||||
- name: LDAP_QUERY_PASSWORD
|
||||
{{- if .Values.ldap.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.ldap.existingSecret }}
|
||||
key: {{ .Values.ldap.passwordKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.ldap.queryPassword | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.ldap.userFilter }}
|
||||
- name: LDAP_USER_FILTER
|
||||
value: {{ .Values.ldap.userFilter | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.ldap.adminFilter }}
|
||||
- name: LDAP_ADMIN_FILTER
|
||||
value: {{ .Values.ldap.adminFilter | quote }}
|
||||
{{- end }}
|
||||
- name: LDAP_ID_ATTRIBUTE
|
||||
value: {{ .Values.ldap.idAttribute | quote }}
|
||||
- name: LDAP_NAME_ATTRIBUTE
|
||||
value: {{ .Values.ldap.nameAttribute | quote }}
|
||||
- name: LDAP_MAIL_ATTRIBUTE
|
||||
value: {{ .Values.ldap.mailAttribute | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.oidc.enabled }}
|
||||
- name: OIDC_AUTH_ENABLED
|
||||
value: "true"
|
||||
- name: OIDC_SIGNUP_ENABLED
|
||||
value: {{ .Values.oidc.signupEnabled | quote }}
|
||||
- name: OIDC_CONFIGURATION_URL
|
||||
value: {{ .Values.oidc.configurationUrl | quote }}
|
||||
- name: OIDC_CLIENT_ID
|
||||
{{- if .Values.oidc.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.oidc.existingSecret }}
|
||||
key: {{ .Values.oidc.clientIdKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.oidc.clientId | quote }}
|
||||
{{- end }}
|
||||
- name: OIDC_CLIENT_SECRET
|
||||
{{- if .Values.oidc.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.oidc.existingSecret }}
|
||||
key: {{ .Values.oidc.clientSecretKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.oidc.clientSecret | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.oidc.userGroup }}
|
||||
- name: OIDC_USER_GROUP
|
||||
value: {{ .Values.oidc.userGroup | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.oidc.adminGroup }}
|
||||
- name: OIDC_ADMIN_GROUP
|
||||
value: {{ .Values.oidc.adminGroup | quote }}
|
||||
{{- end }}
|
||||
- name: OIDC_AUTO_REDIRECT
|
||||
value: {{ .Values.oidc.autoRedirect | quote }}
|
||||
- name: OIDC_PROVIDER_NAME
|
||||
value: {{ .Values.oidc.providerName | quote }}
|
||||
- name: OIDC_REMEMBER_ME
|
||||
value: {{ .Values.oidc.rememberMe | quote }}
|
||||
- name: OIDC_SIGNING_ALGORITHM
|
||||
value: {{ .Values.oidc.signingAlgorithm | quote }}
|
||||
- name: OIDC_USER_CLAIM
|
||||
value: {{ .Values.oidc.userClaim | quote }}
|
||||
- name: OIDC_NAME_CLAIM
|
||||
value: {{ .Values.oidc.nameClaim | quote }}
|
||||
- name: OIDC_GROUPS_CLAIM
|
||||
value: {{ .Values.oidc.groupsClaim | quote }}
|
||||
{{- if .Values.oidc.scopesOverride }}
|
||||
- name: OIDC_SCOPES_OVERRIDE
|
||||
value: {{ .Values.oidc.scopesOverride | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.oidc.tlsCaCertFile }}
|
||||
- name: OIDC_TLS_CACERTFILE
|
||||
value: {{ .Values.oidc.tlsCaCertFile | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.openai.enabled }}
|
||||
{{- if .Values.openai.baseUrl }}
|
||||
- name: OPENAI_BASE_URL
|
||||
value: {{ .Values.openai.baseUrl | quote }}
|
||||
{{- end }}
|
||||
- name: OPENAI_API_KEY
|
||||
{{- if .Values.openai.existingSecret }}
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.openai.existingSecret }}
|
||||
key: {{ .Values.openai.apiKeyKey }}
|
||||
{{- else }}
|
||||
value: {{ .Values.openai.apiKey | quote }}
|
||||
{{- end }}
|
||||
- name: OPENAI_MODEL
|
||||
value: {{ .Values.openai.model | quote }}
|
||||
{{- if .Values.openai.customHeaders }}
|
||||
- name: OPENAI_CUSTOM_HEADERS
|
||||
value: {{ .Values.openai.customHeaders | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.openai.customParams }}
|
||||
- name: OPENAI_CUSTOM_PARAMS
|
||||
value: {{ .Values.openai.customParams | quote }}
|
||||
{{- end }}
|
||||
- name: OPENAI_ENABLE_IMAGE_SERVICES
|
||||
value: {{ .Values.openai.enableImageServices | quote }}
|
||||
- name: OPENAI_WORKERS
|
||||
value: {{ .Values.openai.workers | quote }}
|
||||
- name: OPENAI_SEND_DATABASE_DATA
|
||||
value: {{ .Values.openai.sendDatabaseData | quote }}
|
||||
- name: OPENAI_REQUEST_TIMEOUT
|
||||
value: {{ .Values.openai.requestTimeout | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.tls.enabled }}
|
||||
{{- if .Values.tls.existingSecret }}
|
||||
- name: TLS_CERTIFICATE_PATH
|
||||
value: "/app/certs/{{ .Values.tls.certificateKey }}"
|
||||
- name: TLS_PRIVATE_KEY_PATH
|
||||
value: "/app/certs/{{ .Values.tls.privateKeyKey }}"
|
||||
{{- else }}
|
||||
- name: TLS_CERTIFICATE_PATH
|
||||
value: {{ .Values.tls.certificatePath | quote }}
|
||||
- name: TLS_PRIVATE_KEY_PATH
|
||||
value: {{ .Values.tls.privateKeyPath | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $key, $value := .Values.theme.light }}
|
||||
- name: THEME_LIGHT_{{ $key | upper }}
|
||||
value: {{ $value | quote }}
|
||||
{{- end }}
|
||||
{{- range $key, $value := .Values.theme.dark }}
|
||||
- name: THEME_DARK_{{ $key | upper }}
|
||||
value: {{ $value | quote }}
|
||||
{{- end }}
|
||||
{{- with .Values.extraEnv }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
volumeMounts:
|
||||
- name: data
|
||||
mountPath: /app/data
|
||||
{{- if and .Values.tls.enabled .Values.tls.existingSecret }}
|
||||
- name: tls-certs
|
||||
mountPath: /app/certs
|
||||
readOnly: true
|
||||
{{- end }}
|
||||
{{- with .Values.extraVolumeMounts }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
resources:
|
||||
{{- toYaml .Values.resources | nindent 12 }}
|
||||
volumes:
|
||||
- name: data
|
||||
{{- if .Values.persistence.enabled }}
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ include "mealie.fullname" . }}-data
|
||||
{{- else }}
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
{{- if and .Values.tls.enabled .Values.tls.existingSecret }}
|
||||
- name: tls-certs
|
||||
secret:
|
||||
secretName: {{ .Values.tls.existingSecret }}
|
||||
{{- end }}
|
||||
{{- with .Values.extraVolumes }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.nodeSelector }}
|
||||
nodeSelector:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.affinity }}
|
||||
affinity:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.tolerations }}
|
||||
tolerations:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
43
charts/mealie/templates/ingress.yaml
Normal file
43
charts/mealie/templates/ingress.yaml
Normal file
@ -0,0 +1,43 @@
|
||||
{{- if .Values.ingress.enabled -}}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: {{ include "mealie.fullname" . }}
|
||||
labels:
|
||||
{{- include "mealie.labels" . | nindent 4 }}
|
||||
{{- with .Values.ingress.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- if .Values.ingress.className }}
|
||||
ingressClassName: {{ .Values.ingress.className }}
|
||||
{{- end }}
|
||||
{{- if .Values.ingress.tls }}
|
||||
tls:
|
||||
{{- range .Values.ingress.tls }}
|
||||
- hosts:
|
||||
{{- range .hosts }}
|
||||
- {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- if .secretName }}
|
||||
secretName: {{ .secretName }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
rules:
|
||||
{{- range .Values.ingress.hosts }}
|
||||
- host: {{ .host | quote }}
|
||||
http:
|
||||
paths:
|
||||
{{- range .paths }}
|
||||
- path: {{ .path }}
|
||||
pathType: {{ .pathType }}
|
||||
backend:
|
||||
service:
|
||||
name: {{ include "mealie.fullname" $ }}
|
||||
port:
|
||||
number: {{ $.Values.service.port }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
27
charts/mealie/templates/pvc.yaml
Normal file
27
charts/mealie/templates/pvc.yaml
Normal file
@ -0,0 +1,27 @@
|
||||
{{- if .Values.persistence.enabled }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "mealie.fullname" . }}-data
|
||||
labels:
|
||||
{{- include "mealie.labels" . | nindent 4 }}
|
||||
{{- with .Values.persistence.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.accessMode | quote }}
|
||||
{{- if .Values.persistence.storageClass }}
|
||||
storageClassName: {{ .Values.persistence.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.size | quote }}
|
||||
{{- if .Values.persistence.selector }}
|
||||
{{- with .Values.persistence.selector }}
|
||||
selector:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
15
charts/mealie/templates/service.yaml
Normal file
15
charts/mealie/templates/service.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: {{ include "mealie.fullname" . }}
|
||||
labels:
|
||||
{{- include "mealie.labels" . | nindent 4 }}
|
||||
spec:
|
||||
type: {{ .Values.service.type }}
|
||||
ports:
|
||||
- port: {{ .Values.service.port }}
|
||||
targetPort: http
|
||||
protocol: TCP
|
||||
name: http
|
||||
selector:
|
||||
{{- include "mealie.selectorLabels" . | nindent 4 }}
|
||||
259
charts/mealie/values.yaml
Normal file
259
charts/mealie/values.yaml
Normal file
@ -0,0 +1,259 @@
|
||||
## Global settings
|
||||
nameOverride: ""
|
||||
fullnameOverride: ""
|
||||
|
||||
## Image settings
|
||||
image:
|
||||
repository: ghcr.io/mealie-recipes/mealie
|
||||
tag: "v3.2.1"
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
## Deployment settings
|
||||
replicaCount: 1
|
||||
revisionHistoryLimit: 3
|
||||
|
||||
# Pod security settings
|
||||
podSecurityContext:
|
||||
runAsNonRoot: false
|
||||
runAsUser: 911
|
||||
fsGroup: 911
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
readOnlyRootFilesystem: false
|
||||
capabilities:
|
||||
drop:
|
||||
- ALL
|
||||
|
||||
## Pod scheduling
|
||||
nodeSelector: {}
|
||||
tolerations: []
|
||||
affinity: {}
|
||||
|
||||
## Service settings
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 9000
|
||||
|
||||
## Ingress settings
|
||||
ingress:
|
||||
enabled: false
|
||||
className: ""
|
||||
annotations:
|
||||
traefik.ingress.kubernetes.io/router.entrypoints: websecure
|
||||
hosts:
|
||||
- host: mealie.domain.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- mealie.domain.com
|
||||
|
||||
## Persistence settings
|
||||
persistence:
|
||||
enabled: false
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 5Gi
|
||||
annotations: {}
|
||||
|
||||
## Resource limits and requests
|
||||
# resources:
|
||||
# limits:
|
||||
# cpu: 1000m
|
||||
# memory: 1000Mi
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 256Mi
|
||||
|
||||
## Application health checks
|
||||
probes:
|
||||
liveness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 60
|
||||
periodSeconds: 30
|
||||
timeoutSeconds: 10
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
path: /
|
||||
readiness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 10
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
path: /
|
||||
|
||||
## Autoscaling configuration
|
||||
autoscaling:
|
||||
enabled: false
|
||||
minReplicas: 1
|
||||
maxReplicas: 3
|
||||
targetCPUUtilizationPercentage: 80
|
||||
targetMemoryUtilizationPercentage: 80
|
||||
|
||||
## Environment variables
|
||||
env:
|
||||
# General Settings
|
||||
PUID: "911"
|
||||
PGID: "911"
|
||||
DEFAULT_GROUP: "Home"
|
||||
DEFAULT_HOUSEHOLD: "Family"
|
||||
BASE_URL: "http://localhost:9000"
|
||||
TOKEN_TIME: "48"
|
||||
API_PORT: "9000"
|
||||
API_DOCS: "true"
|
||||
TZ: "UTC"
|
||||
ALLOW_SIGNUP: "false"
|
||||
ALLOW_PASSWORD_LOGIN: "true"
|
||||
LOG_LEVEL: "info"
|
||||
DAILY_SCHEDULE_TIME: "23:45"
|
||||
|
||||
# Security
|
||||
SECURITY_MAX_LOGIN_ATTEMPTS: "5"
|
||||
SECURITY_USER_LOCKOUT_TIME: "24"
|
||||
|
||||
# Database
|
||||
DB_ENGINE: "postgres" # postgres or sqlite
|
||||
|
||||
# Webworker
|
||||
UVICORN_WORKERS: "1"
|
||||
|
||||
# Extra environment variables (for advanced use cases)
|
||||
extraEnv: []
|
||||
# - name: POSTGRES_USER
|
||||
# value: "mealie"
|
||||
# - name: POSTGRES_PASSWORD
|
||||
# value: "mealie"
|
||||
# - name: POSTGRES_SERVER
|
||||
# value: "postgres"
|
||||
# - name: POSTGRES_PORT
|
||||
# value: "5432"
|
||||
# - name: POSTGRES_DB
|
||||
# value: "mealie"
|
||||
|
||||
# Extra volume mounts
|
||||
extraVolumeMounts: []
|
||||
|
||||
# Extra volumes
|
||||
extraVolumes: []
|
||||
|
||||
## PostgreSQL configuration (when using external database)
|
||||
postgresql:
|
||||
enabled: false
|
||||
# External PostgreSQL settings
|
||||
external:
|
||||
enabled: false
|
||||
host: ""
|
||||
port: 5432
|
||||
database: "mealie"
|
||||
user: "mealie"
|
||||
password: ""
|
||||
# Use existing secret for database credentials
|
||||
existingSecret: ""
|
||||
userKey: "username"
|
||||
passwordKey: "password"
|
||||
|
||||
## SMTP Email configuration
|
||||
email:
|
||||
enabled: false
|
||||
host: ""
|
||||
port: 587
|
||||
fromName: "Mealie"
|
||||
authStrategy: "TLS" # TLS, SSL, NONE
|
||||
fromEmail: ""
|
||||
user: ""
|
||||
password: ""
|
||||
# Use existing secret for SMTP credentials
|
||||
existingSecret: ""
|
||||
userKey: "smtp-user"
|
||||
passwordKey: "smtp-password"
|
||||
|
||||
## LDAP Authentication
|
||||
ldap:
|
||||
enabled: false
|
||||
serverUrl: ""
|
||||
tlsInsecure: false
|
||||
tlsCaCertFile: ""
|
||||
enableStartTls: false
|
||||
baseDn: ""
|
||||
queryBind: ""
|
||||
queryPassword: ""
|
||||
userFilter: ""
|
||||
adminFilter: ""
|
||||
idAttribute: "uid"
|
||||
nameAttribute: "name"
|
||||
mailAttribute: "mail"
|
||||
# Use existing secret for LDAP credentials
|
||||
existingSecret: ""
|
||||
passwordKey: "ldap-password"
|
||||
|
||||
## OpenID Connect (OIDC)
|
||||
oidc:
|
||||
enabled: false
|
||||
signupEnabled: true
|
||||
configurationUrl: ""
|
||||
clientId: ""
|
||||
clientSecret: ""
|
||||
userGroup: ""
|
||||
adminGroup: ""
|
||||
autoRedirect: false
|
||||
providerName: "OAuth"
|
||||
rememberMe: false
|
||||
signingAlgorithm: "RS256"
|
||||
userClaim: "email"
|
||||
nameClaim: "name"
|
||||
groupsClaim: "groups"
|
||||
scopesOverride: ""
|
||||
tlsCaCertFile: ""
|
||||
# Use existing secret for OIDC credentials
|
||||
existingSecret: ""
|
||||
clientIdKey: "oidc-client-id"
|
||||
clientSecretKey: "oidc-client-secret"
|
||||
|
||||
## OpenAI Integration
|
||||
openai:
|
||||
enabled: false
|
||||
baseUrl: ""
|
||||
apiKey: ""
|
||||
model: "gpt-4o"
|
||||
customHeaders: ""
|
||||
customParams: ""
|
||||
enableImageServices: true
|
||||
workers: 2
|
||||
sendDatabaseData: true
|
||||
requestTimeout: 60
|
||||
# Use existing secret for OpenAI API key
|
||||
existingSecret: ""
|
||||
apiKeyKey: "openai-api-key"
|
||||
|
||||
## TLS Configuration
|
||||
tls:
|
||||
enabled: false
|
||||
certificatePath: ""
|
||||
privateKeyPath: ""
|
||||
# Use existing secret for TLS certificates
|
||||
existingSecret: ""
|
||||
certificateKey: "tls.crt"
|
||||
privateKeyKey: "tls.key"
|
||||
|
||||
## Theming
|
||||
theme:
|
||||
light:
|
||||
primary: "#E58325"
|
||||
accent: "#007A99"
|
||||
secondary: "#973542"
|
||||
success: "#43A047"
|
||||
info: "#1976D2"
|
||||
warning: "#FF6D00"
|
||||
error: "#EF5350"
|
||||
dark:
|
||||
primary: "#E58325"
|
||||
accent: "#007A99"
|
||||
secondary: "#973542"
|
||||
success: "#43A047"
|
||||
info: "#1976D2"
|
||||
warning: "#FF6D00"
|
||||
error: "#EF5350"
|
||||
17
charts/norish/Chart.yaml
Normal file
17
charts/norish/Chart.yaml
Normal file
@ -0,0 +1,17 @@
|
||||
apiVersion: v2
|
||||
name: norish
|
||||
description: Norish helm chart for Kubernetes - A recipe management and meal planning application
|
||||
type: application
|
||||
version: 0.0.5
|
||||
appVersion: "v0.15.4-beta"
|
||||
maintainers:
|
||||
- name: Richard Tomik
|
||||
email: no@m.com
|
||||
keywords:
|
||||
- recipe
|
||||
- meal-planning
|
||||
- food
|
||||
- norish
|
||||
home: https://github.com/rtomik/helm-charts
|
||||
sources:
|
||||
- https://github.com/norishapp/norish
|
||||
663
charts/norish/readme.md
Normal file
663
charts/norish/readme.md
Normal file
@ -0,0 +1,663 @@
|
||||
cl# Norish Helm Chart
|
||||
|
||||
A Helm chart for deploying [Norish](https://github.com/norishapp/norish), a recipe management and meal planning application, on Kubernetes.
|
||||
|
||||
## Introduction
|
||||
|
||||
This chart bootstraps a Norish deployment on a Kubernetes cluster using the Helm package manager.
|
||||
|
||||
**IMPORTANT: This chart requires a central PostgreSQL database and Redis server.** You must have both a PostgreSQL and Redis server available before deploying this chart. The chart does not include PostgreSQL or Redis deployments.
|
||||
|
||||
**Note:** This chart includes a Chrome headless sidecar container that is required for recipe parsing and scraping functionality. Chrome requires elevated security privileges (`SYS_ADMIN` capability) and additional resources (recommend 256Mi-512Mi memory).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
- Helm 3.0+
|
||||
- **PostgreSQL database server** (required)
|
||||
- **Redis server** (required for v0.14.0+)
|
||||
- PV provisioner support in the underlying infrastructure (if persistence is enabled)
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `norish`:
|
||||
|
||||
```bash
|
||||
$ helm repo add helm-charts https://rtomik.github.io/helm-charts
|
||||
$ helm install norish helm-charts/norish
|
||||
```
|
||||
|
||||
The command deploys Norish on the Kubernetes cluster with default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall/delete the `norish` deployment:
|
||||
|
||||
```bash
|
||||
helm uninstall norish
|
||||
```
|
||||
|
||||
This command removes all the Kubernetes components associated with the chart and deletes the release.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Required Configuration
|
||||
|
||||
Before deploying, you must configure:
|
||||
|
||||
1. **PostgreSQL Database** (REQUIRED): A central PostgreSQL database must be available
|
||||
- Configure `database.host` to point to your PostgreSQL server
|
||||
- Ensure the database exists before deployment
|
||||
- Set appropriate credentials
|
||||
|
||||
2. **Redis Server** (REQUIRED for v0.14.0+): A Redis server must be available
|
||||
- Configure `redis.host` to point to your Redis server
|
||||
- Configure authentication if required
|
||||
- Used for background job processing and queues
|
||||
|
||||
3. **Master Key**: A 32-byte base64-encoded encryption key
|
||||
```bash
|
||||
# Generate a master key
|
||||
openssl rand -base64 32
|
||||
```
|
||||
|
||||
4. **Application URL**: Set `config.authUrl` to match your ingress hostname
|
||||
|
||||
### Authentication Configuration
|
||||
|
||||
**Authentication providers are now optional!** You can deploy Norish in two ways:
|
||||
|
||||
**Option 1: Password Authentication (Simple Setup)**
|
||||
- No external authentication provider required
|
||||
- Users can register and log in with email/password
|
||||
- Perfect for self-hosted, single-tenant deployments
|
||||
- Enabled automatically when no OAuth/OIDC provider is configured
|
||||
|
||||
**Option 2: OAuth/OIDC Provider (Enterprise Setup)**
|
||||
- Configure ONE of the following:
|
||||
- OIDC/OAuth2
|
||||
- GitHub OAuth
|
||||
- Google OAuth
|
||||
- Recommended for multi-user environments
|
||||
- Can be combined with password authentication via `config.passwordAuthEnabled`
|
||||
|
||||
### Example: Minimal Installation (Password Authentication)
|
||||
|
||||
This is the simplest setup using built-in password authentication:
|
||||
|
||||
```yaml
|
||||
# values.yaml
|
||||
database:
|
||||
host: "postgresql.default.svc.cluster.local"
|
||||
port: 5432
|
||||
name: norish
|
||||
username: norish
|
||||
password: "secure-password"
|
||||
|
||||
redis:
|
||||
host: "redis.default.svc.cluster.local"
|
||||
port: 6379
|
||||
database: 0
|
||||
# Leave password empty if Redis has no authentication
|
||||
|
||||
config:
|
||||
authUrl: "https://norish.example.com"
|
||||
masterKey:
|
||||
value: "<your-32-byte-base64-key>"
|
||||
# passwordAuthEnabled defaults to true when no OAuth/OIDC is configured
|
||||
|
||||
ingress:
|
||||
enabled: true
|
||||
hosts:
|
||||
- host: norish.example.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- norish.example.com
|
||||
```
|
||||
|
||||
Install with:
|
||||
```bash
|
||||
$ helm repo add helm-charts https://rtomik.github.io/helm-charts
|
||||
$ helm install norish helm-charts/norish -f values.yaml
|
||||
```
|
||||
|
||||
### Example: Installation with OIDC
|
||||
|
||||
For enterprise deployments with an external identity provider:
|
||||
|
||||
```yaml
|
||||
# values.yaml
|
||||
database:
|
||||
host: "postgresql.default.svc.cluster.local"
|
||||
port: 5432
|
||||
name: norish
|
||||
username: norish
|
||||
password: "secure-password"
|
||||
|
||||
config:
|
||||
authUrl: "https://norish.example.com"
|
||||
masterKey:
|
||||
value: "<your-32-byte-base64-key>"
|
||||
# Optional: Allow both OIDC and password authentication
|
||||
passwordAuthEnabled: "true"
|
||||
auth:
|
||||
oidc:
|
||||
enabled: true
|
||||
name: "MyAuth"
|
||||
issuer: "https://auth.example.com"
|
||||
clientId: "<your-client-id>"
|
||||
clientSecret: "<your-client-secret>"
|
||||
|
||||
ingress:
|
||||
enabled: true
|
||||
hosts:
|
||||
- host: norish.example.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- norish.example.com
|
||||
```
|
||||
|
||||
Install with:
|
||||
```bash
|
||||
$ helm repo add helm-charts https://rtomik.github.io/helm-charts
|
||||
$ helm install norish helm-charts/norish -f values.yaml
|
||||
```
|
||||
|
||||
### Example: Using Existing Secrets
|
||||
|
||||
For production deployments, store sensitive data in Kubernetes secrets:
|
||||
|
||||
```yaml
|
||||
# values.yaml
|
||||
database:
|
||||
host: "postgresql.default.svc.cluster.local"
|
||||
existingSecret: "norish-db-secret"
|
||||
usernameKey: "username"
|
||||
passwordKey: "password"
|
||||
|
||||
config:
|
||||
masterKey:
|
||||
existingSecret: "norish-master-key"
|
||||
secretKey: "master-key"
|
||||
auth:
|
||||
oidc:
|
||||
enabled: true
|
||||
name: "MyAuth"
|
||||
issuer: "https://auth.example.com"
|
||||
existingSecret: "norish-oidc-secret"
|
||||
clientIdKey: "client-id"
|
||||
clientSecretKey: "client-secret"
|
||||
```
|
||||
|
||||
Create the secrets:
|
||||
```bash
|
||||
# Database credentials
|
||||
kubectl create secret generic norish-db-secret \
|
||||
--from-literal=username="norish" \
|
||||
--from-literal=password="secure-db-password"
|
||||
|
||||
# Master encryption key
|
||||
kubectl create secret generic norish-master-key \
|
||||
--from-literal=master-key="$(openssl rand -base64 32)"
|
||||
|
||||
# OIDC credentials
|
||||
kubectl create secret generic norish-oidc-secret \
|
||||
--from-literal=client-id="<your-client-id>" \
|
||||
--from-literal=client-secret="<your-client-secret>"
|
||||
```
|
||||
|
||||
### Example: Using Existing PVC
|
||||
|
||||
If you want to use an existing PersistentVolumeClaim for uploads storage:
|
||||
|
||||
```yaml
|
||||
# values.yaml
|
||||
persistence:
|
||||
enabled: true
|
||||
existingClaim: "my-existing-pvc"
|
||||
```
|
||||
|
||||
This is useful when:
|
||||
- You want to reuse storage from a previous installation
|
||||
- You have pre-provisioned PVCs with specific configurations
|
||||
- You're managing PVCs separately from the Helm chart
|
||||
|
||||
### Optional Configuration
|
||||
|
||||
Version v0.13.6-beta introduces additional optional configuration options:
|
||||
|
||||
```yaml
|
||||
config:
|
||||
# Log level configuration
|
||||
logLevel: "info" # Options: trace, debug, info, warn, error, fatal
|
||||
|
||||
# Additional trusted origins (useful when behind a proxy or using multiple domains)
|
||||
trustedOrigins: "http://192.168.1.100:3000,https://norish.example.com"
|
||||
|
||||
# Enable/disable password authentication
|
||||
# Defaults to true when no OAuth/OIDC is configured, false otherwise
|
||||
# Set to "true" to enable password auth alongside OAuth/OIDC
|
||||
passwordAuthEnabled: "true"
|
||||
|
||||
auth:
|
||||
oidc:
|
||||
enabled: true
|
||||
name: "MyAuth"
|
||||
issuer: "https://auth.example.com"
|
||||
# Optional: Custom well-known configuration URL
|
||||
# By default derived from issuer
|
||||
wellKnown: "https://auth.example.com/.well-known/openid-configuration"
|
||||
clientId: "<your-client-id>"
|
||||
clientSecret: "<your-client-secret>"
|
||||
```
|
||||
|
||||
### Customizing Chrome Headless Resources
|
||||
|
||||
Chrome headless is required but you can customize its resource limits:
|
||||
|
||||
```yaml
|
||||
chrome:
|
||||
enabled: true # Must be true for v0.13.6+
|
||||
resources:
|
||||
limits:
|
||||
cpu: 500m
|
||||
memory: 512Mi
|
||||
requests:
|
||||
cpu: 100m
|
||||
memory: 256Mi
|
||||
```
|
||||
|
||||
### Setting Up PostgreSQL Database
|
||||
|
||||
You need to create the database before deploying this chart:
|
||||
|
||||
```sql
|
||||
-- Connect to your PostgreSQL server
|
||||
CREATE DATABASE norish;
|
||||
CREATE USER norish WITH ENCRYPTED PASSWORD 'secure-password';
|
||||
GRANT ALL PRIVILEGES ON DATABASE norish TO norish;
|
||||
```
|
||||
|
||||
Or if using a centralized PostgreSQL Helm chart or service, ensure the database is created and accessible from your Kubernetes cluster.
|
||||
|
||||
## Parameters
|
||||
|
||||
### Global Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `nameOverride` | Override the chart name | `""` |
|
||||
| `fullnameOverride` | Override the full resource names | `""` |
|
||||
|
||||
### Image Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `image.repository` | Norish image repository | `norishapp/norish` |
|
||||
| `image.tag` | Norish image tag | `v0.15.4-beta` |
|
||||
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
||||
| `imagePullSecrets` | Image pull secrets | `[]` |
|
||||
|
||||
### Deployment Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `replicaCount` | Number of replicas | `1` |
|
||||
| `revisionHistoryLimit` | Number of old ReplicaSets to retain | `3` |
|
||||
|
||||
### Service Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `service.type` | Kubernetes service type | `ClusterIP` |
|
||||
| `service.port` | Service port | `3000` |
|
||||
| `service.annotations` | Service annotations | `{}` |
|
||||
|
||||
### Ingress Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `ingress.enabled` | Enable ingress | `false` |
|
||||
| `ingress.className` | Ingress class name | `""` |
|
||||
| `ingress.annotations` | Ingress annotations | `{"traefik.ingress.kubernetes.io/router.entrypoints": "websecure"}` |
|
||||
| `ingress.hosts` | Ingress hosts configuration | See values.yaml |
|
||||
| `ingress.tls` | Ingress TLS configuration | See values.yaml |
|
||||
|
||||
### Persistence Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `persistence.enabled` | Enable persistent storage | `true` |
|
||||
| `persistence.existingClaim` | Use an existing PVC instead of creating a new one | `""` |
|
||||
| `persistence.storageClass` | Storage class name | `""` |
|
||||
| `persistence.accessMode` | Access mode | `ReadWriteOnce` |
|
||||
| `persistence.size` | Storage size | `5Gi` |
|
||||
| `persistence.annotations` | PVC annotations | `{}` |
|
||||
|
||||
### Application Configuration
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `config.authUrl` | Application URL (required) | `"http://norish.domain.com"` |
|
||||
| `config.masterKey.value` | Master encryption key | `""` |
|
||||
| `config.masterKey.existingSecret` | Use existing secret for master key | `""` |
|
||||
| `config.logLevel` | Log level: trace, debug, info, warn, error, fatal | `""` |
|
||||
| `config.trustedOrigins` | Additional trusted origins (comma-separated) | `""` |
|
||||
| `config.passwordAuthEnabled` | Enable/disable password authentication (defaults to true when no OAuth/OIDC configured) | `""` |
|
||||
| `config.auth.oidc.enabled` | Enable OIDC authentication | `false` |
|
||||
| `config.auth.oidc.name` | OIDC provider name | `"MyAuth"` |
|
||||
| `config.auth.oidc.issuer` | OIDC issuer URL | `""` |
|
||||
| `config.auth.oidc.wellKnown` | OIDC well-known configuration URL (optional) | `""` |
|
||||
| `config.auth.oidc.clientId` | OIDC client ID | `""` |
|
||||
| `config.auth.oidc.clientSecret` | OIDC client secret | `""` |
|
||||
| `config.auth.github.enabled` | Enable GitHub OAuth | `false` |
|
||||
| `config.auth.github.clientId` | GitHub client ID | `""` |
|
||||
| `config.auth.github.clientSecret` | GitHub client secret | `""` |
|
||||
| `config.auth.google.enabled` | Enable Google OAuth | `false` |
|
||||
| `config.auth.google.clientId` | Google client ID | `""` |
|
||||
| `config.auth.google.clientSecret` | Google client secret | `""` |
|
||||
|
||||
### Database Parameters (REQUIRED)
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `database.host` | PostgreSQL database host (required) | `""` |
|
||||
| `database.port` | PostgreSQL database port | `5432` |
|
||||
| `database.name` | PostgreSQL database name | `norish` |
|
||||
| `database.username` | PostgreSQL username | `postgres` |
|
||||
| `database.password` | PostgreSQL password | `""` |
|
||||
| `database.existingSecret` | Use existing secret for database credentials | `""` |
|
||||
| `database.usernameKey` | Key in secret for username | `"username"` |
|
||||
| `database.passwordKey` | Key in secret for password | `"password"` |
|
||||
| `database.databaseKey` | Key in secret for database name | `"database"` |
|
||||
| `database.hostKey` | Key in secret for host | `"host"` |
|
||||
|
||||
### Redis Parameters (REQUIRED for v0.14.0+)
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `redis.host` | Redis server hostname (required) | `""` |
|
||||
| `redis.port` | Redis server port | `6379` |
|
||||
| `redis.database` | Redis database number | `0` |
|
||||
| `redis.username` | Redis username (Redis 6.0+, optional) | `""` |
|
||||
| `redis.password` | Redis password (leave empty if no auth) | `""` |
|
||||
| `redis.existingSecret` | Use existing secret for Redis URL (recommended for production) | `""` |
|
||||
| `redis.urlKey` | Key in existingSecret containing the full Redis URL | `"redis-url"` |
|
||||
| `redis.passwordKey` | Key in existingSecret for password (for compatibility) | `"password"` |
|
||||
|
||||
### Chrome Headless Parameters (REQUIRED)
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `chrome.enabled` | Enable Chrome headless sidecar (required for v0.13.6+) | `true` |
|
||||
| `chrome.image.repository` | Chrome headless image repository | `zenika/alpine-chrome` |
|
||||
| `chrome.image.tag` | Chrome headless image tag | `latest` |
|
||||
| `chrome.image.pullPolicy` | Chrome image pull policy | `IfNotPresent` |
|
||||
| `chrome.port` | Chrome remote debugging port | `3000` |
|
||||
| `chrome.resources` | Chrome container resource limits/requests | `{}` |
|
||||
|
||||
### Security Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `podSecurityContext.runAsNonRoot` | Run as non-root user | `true` |
|
||||
| `podSecurityContext.runAsUser` | User ID to run as | `1000` |
|
||||
| `podSecurityContext.fsGroup` | Group ID for filesystem | `1000` |
|
||||
|
||||
### Resource Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `resources` | CPU/Memory resource requests/limits | `{}` |
|
||||
|
||||
### Health Check Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `probes.startup.enabled` | Enable startup probe | `true` |
|
||||
| `probes.liveness.enabled` | Enable liveness probe | `true` |
|
||||
| `probes.readiness.enabled` | Enable readiness probe | `true` |
|
||||
|
||||
## What's New in v0.13.6-beta
|
||||
|
||||
This version introduces several improvements and new features:
|
||||
|
||||
**UI/UX Improvements:**
|
||||
- Ability to change prompts used in Settings → Admin
|
||||
- Improved transcriber logic
|
||||
- Double tapping/clicking planned recipes now opens the recipe page
|
||||
- Small icon that opens the original recipe page
|
||||
- Add recipes button now opens a dropdown instead of instantly redirecting to manual creation
|
||||
|
||||
**New Features:**
|
||||
- Support for trusting additional origins using `TRUSTED_ORIGINS` environment variable (comma-separated)
|
||||
- Customizable password authentication via `PASSWORD_AUTH_ENABLED` flag
|
||||
- Configurable log level via `NEXT_PUBLIC_LOG_LEVEL`
|
||||
|
||||
**Bug Fixes:**
|
||||
- User menu remaining open when clicking import
|
||||
- Text truncation no longer uses the tailwind truncate class in the calendar
|
||||
- Comma decimals being parsed as nothing (e.g., 2,5 ended up as 25)
|
||||
- Unicode character handling
|
||||
|
||||
**Breaking Changes:**
|
||||
- Chrome headless is now mandatory for improved parsing functionality
|
||||
|
||||
## Authentication Setup
|
||||
|
||||
Norish v0.13.6-beta and later support multiple authentication methods:
|
||||
|
||||
### Password Authentication (Default)
|
||||
|
||||
When no external authentication provider is configured, Norish automatically enables password-based authentication. Users can:
|
||||
- Register new accounts with email and password
|
||||
- Log in using their credentials
|
||||
- Manage their account through the web interface
|
||||
|
||||
This is the simplest setup and perfect for:
|
||||
- Self-hosted, single-user or family deployments
|
||||
- Testing and development environments
|
||||
- Scenarios where external OAuth providers are not needed
|
||||
|
||||
### External Authentication Providers (Optional)
|
||||
|
||||
For enterprise or multi-tenant deployments, you can configure external authentication providers. After configuring a provider, you can manage additional authentication methods through the Settings → Admin interface.
|
||||
|
||||
### OIDC/OAuth2
|
||||
|
||||
```yaml
|
||||
config:
|
||||
auth:
|
||||
oidc:
|
||||
enabled: true
|
||||
name: "Authentik" # Display name
|
||||
issuer: "https://auth.example.com/application/o/norish/"
|
||||
clientId: "<your-client-id>"
|
||||
clientSecret: "<your-client-secret>"
|
||||
```
|
||||
|
||||
### GitHub OAuth
|
||||
|
||||
1. Create a GitHub OAuth App at https://github.com/settings/developers
|
||||
2. Set Authorization callback URL to: `https://norish.example.com/api/auth/callback/github`
|
||||
|
||||
```yaml
|
||||
config:
|
||||
auth:
|
||||
github:
|
||||
enabled: true
|
||||
clientId: "<your-github-client-id>"
|
||||
clientSecret: "<your-github-client-secret>"
|
||||
```
|
||||
|
||||
### Google OAuth
|
||||
|
||||
1. Create OAuth credentials at https://console.cloud.google.com/apis/credentials
|
||||
2. Set Authorized redirect URI to: `https://norish.example.com/api/auth/callback/google`
|
||||
|
||||
```yaml
|
||||
config:
|
||||
auth:
|
||||
google:
|
||||
enabled: true
|
||||
clientId: "<your-google-client-id>"
|
||||
clientSecret: "<your-google-client-secret>"
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Check Pod Status
|
||||
|
||||
```bash
|
||||
kubectl get pods -l app.kubernetes.io/name=norish
|
||||
kubectl logs -l app.kubernetes.io/name=norish
|
||||
```
|
||||
|
||||
### Check Database Connection
|
||||
|
||||
```bash
|
||||
# Test connection from app pod
|
||||
kubectl exec -it deployment/norish -- sh
|
||||
nc -zv <your-postgres-host> 5432
|
||||
```
|
||||
|
||||
### Common Issues
|
||||
|
||||
1. **Master Key Not Set**: Ensure you've generated and configured a master key
|
||||
2. **Cannot Log In**:
|
||||
- Password authentication is enabled by default when no OAuth/OIDC is configured
|
||||
- If you configured an external provider, ensure the client ID/secret are correct
|
||||
- Check the callback URL matches your ingress hostname
|
||||
3. **Database Connection Failed**:
|
||||
- Verify database host is correct and accessible from the cluster
|
||||
- Check database credentials
|
||||
- Ensure the database exists
|
||||
- Verify network policies allow connections to the database
|
||||
4. **Application Not Accessible**: Verify ingress configuration and DNS records
|
||||
5. **Chrome Headless Issues**:
|
||||
- Chrome requires `SYS_ADMIN` capability for proper operation
|
||||
- If pod fails to start, check if your cluster's security policies allow the required capabilities
|
||||
- Chrome container may require additional memory (256Mi-512Mi recommended)
|
||||
- Check Chrome container logs: `kubectl logs -l app.kubernetes.io/name=norish -c chrome-headless`
|
||||
6. **Recipe Parsing Failures**:
|
||||
- Ensure Chrome headless is running: `kubectl get pods -l app.kubernetes.io/name=norish`
|
||||
- Verify `CHROME_WS_ENDPOINT` is set correctly (automatically configured by the chart)
|
||||
- Check if Chrome is accessible from the Norish container
|
||||
|
||||
## Upgrading
|
||||
|
||||
To upgrade the chart:
|
||||
|
||||
```bash
|
||||
$ helm upgrade norish helm-charts/norish -f values.yaml
|
||||
```
|
||||
|
||||
### Upgrading from v0.13.x to v0.14.x
|
||||
|
||||
**BREAKING CHANGE:** Norish v0.14.0+ requires Redis for background job processing.
|
||||
|
||||
Before upgrading, you **must** configure Redis:
|
||||
|
||||
**Option 1: Using an existing Redis cluster (Recommended for production)**
|
||||
|
||||
Update your `values.yaml`:
|
||||
|
||||
```yaml
|
||||
redis:
|
||||
host: "redis.default.svc.cluster.local" # Your Redis server
|
||||
port: 6379
|
||||
database: 0
|
||||
# If Redis requires authentication:
|
||||
existingSecret: "my-redis-secret" # Secret containing redis-url key
|
||||
urlKey: "redis-url"
|
||||
```
|
||||
|
||||
Create the Redis secret with the full URL:
|
||||
|
||||
```bash
|
||||
# For Redis with authentication
|
||||
kubectl create secret generic my-redis-secret \
|
||||
--from-literal=redis-url="redis://username:password@redis.default.svc.cluster.local:6379/0"
|
||||
|
||||
# For Redis without authentication
|
||||
kubectl create secret generic my-redis-secret \
|
||||
--from-literal=redis-url="redis://redis.default.svc.cluster.local:6379/0"
|
||||
```
|
||||
|
||||
**Option 2: Using plain password in values (Simple setup)**
|
||||
|
||||
```yaml
|
||||
redis:
|
||||
host: "redis.default.svc.cluster.local"
|
||||
port: 6379
|
||||
database: 0
|
||||
username: "default" # Optional
|
||||
password: "mypassword" # Chart will auto-generate redis-url
|
||||
```
|
||||
|
||||
**Option 3: Redis without authentication**
|
||||
|
||||
```yaml
|
||||
redis:
|
||||
host: "redis.default.svc.cluster.local"
|
||||
port: 6379
|
||||
database: 0
|
||||
# No password or existingSecret - chart will generate simple URL
|
||||
```
|
||||
|
||||
After configuring Redis, upgrade the chart:
|
||||
|
||||
```bash
|
||||
$ helm upgrade norish helm-charts/norish -f values.yaml
|
||||
```
|
||||
|
||||
### What's New in v0.14.x
|
||||
|
||||
**Breaking Changes:**
|
||||
- Redis is now required for the application to function
|
||||
- See the [upgrade guide](#upgrading-from-v013x-to-v014x) above
|
||||
|
||||
**New Features:**
|
||||
- Recipe improvements:
|
||||
- Full redesign of the recipe desktop page
|
||||
- Recipe linking and headings in description/instruction steps
|
||||
- Attach images to steps as reference material
|
||||
- Keep screen on during cooking
|
||||
- Drag and drop ingredient and step reordering
|
||||
- Manual or AI-powered macro nutrient estimation
|
||||
- New creation options:
|
||||
- Recipe creation by image (supports multiple images, requires AI)
|
||||
- Recipe creation via plain recipe text
|
||||
- "Always use AI to import" override in admin settings
|
||||
- Allergy MVP:
|
||||
- Users can set allergies in their settings page
|
||||
- Warnings when planning recipes with matching allergies
|
||||
- Rating and liking recipes (including filtering)
|
||||
|
||||
**Technical Improvements:**
|
||||
- Redis + BullMQ for importing and other background tasks
|
||||
- Removed puppeteer in favor of playwright
|
||||
- All dependencies updated
|
||||
- Improved reverse proxy support
|
||||
- Rate limiting for brute force attacks
|
||||
|
||||
**Bug Fixes:**
|
||||
- User menu not opening import modal
|
||||
- User menu creation not linking
|
||||
- Improved pre-fetching of recipes and virtualization
|
||||
|
||||
## Support
|
||||
|
||||
- Norish Repository: https://github.com/norishapp/norish
|
||||
- Chart Repository: https://github.com/rtomik/helm-charts
|
||||
- Issue Tracker: https://github.com/rtomik/helm-charts/issues
|
||||
|
||||
## License
|
||||
|
||||
This Helm chart is provided as-is under the same license as the Norish application.
|
||||
74
charts/norish/templates/NOTES.txt
Normal file
74
charts/norish/templates/NOTES.txt
Normal file
@ -0,0 +1,74 @@
|
||||
Thank you for installing {{ .Chart.Name }}!
|
||||
|
||||
Your release is named {{ .Release.Name }}.
|
||||
|
||||
To learn more about the release, try:
|
||||
|
||||
$ helm status {{ .Release.Name }} -n {{ .Release.Namespace }}
|
||||
$ helm get all {{ .Release.Name }} -n {{ .Release.Namespace }}
|
||||
|
||||
{{- if .Values.ingress.enabled }}
|
||||
|
||||
Application URL:
|
||||
{{- range .Values.ingress.hosts }}
|
||||
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .host }}{{ range .paths }}{{ .path }}{{ end }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
|
||||
Get the application URL by running these commands:
|
||||
{{- if contains "NodePort" .Values.service.type }}
|
||||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "norish.fullname" . }})
|
||||
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
|
||||
echo http://$NODE_IP:$NODE_PORT
|
||||
{{- else if contains "LoadBalancer" .Values.service.type }}
|
||||
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
|
||||
You can watch the status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "norish.fullname" . }}'
|
||||
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "norish.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
|
||||
echo http://$SERVICE_IP:{{ .Values.service.port }}
|
||||
{{- else if contains "ClusterIP" .Values.service.type }}
|
||||
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "norish.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
|
||||
export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
|
||||
echo "Visit http://127.0.0.1:8080 to use your application"
|
||||
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
IMPORTANT CONFIGURATION NOTES:
|
||||
|
||||
1. Database Configuration:
|
||||
{{- if .Values.database.host }}
|
||||
Using external PostgreSQL at: {{ .Values.database.host }}:{{ .Values.database.port }}
|
||||
{{- else }}
|
||||
⚠️ WARNING: Database host is not configured!
|
||||
Configure database.host to point to your PostgreSQL server.
|
||||
{{- end }}
|
||||
|
||||
2. Master Key:
|
||||
{{- if .Values.config.masterKey.existingSecret }}
|
||||
Using existing secret: {{ .Values.config.masterKey.existingSecret }}
|
||||
{{- else }}
|
||||
{{- if not .Values.config.masterKey.value }}
|
||||
⚠️ WARNING: Master key is not set! Generate one with: openssl rand -base64 32
|
||||
{{- else }}
|
||||
Master key configured from values.yaml
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
3. Authentication:
|
||||
{{- if or .Values.config.auth.oidc.enabled .Values.config.auth.github.enabled .Values.config.auth.google.enabled }}
|
||||
{{- if .Values.config.auth.oidc.enabled }}
|
||||
- OIDC provider: {{ .Values.config.auth.oidc.name }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.auth.github.enabled }}
|
||||
- GitHub OAuth enabled
|
||||
{{- end }}
|
||||
{{- if .Values.config.auth.google.enabled }}
|
||||
- Google OAuth enabled
|
||||
{{- end }}
|
||||
After first login, configure additional providers in Settings → Admin
|
||||
{{- else }}
|
||||
⚠️ WARNING: No authentication provider configured!
|
||||
Configure ONE provider (OIDC, GitHub, or Google) to create your admin account.
|
||||
{{- end }}
|
||||
|
||||
For more information, visit: https://github.com/norishapp/norish
|
||||
97
charts/norish/templates/_helpers.tpl
Normal file
97
charts/norish/templates/_helpers.tpl
Normal file
@ -0,0 +1,97 @@
|
||||
{{/*
|
||||
Expand the name of the chart.
|
||||
*/}}
|
||||
{{- define "norish.name" -}}
|
||||
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create a default fully qualified app name.
|
||||
*/}}
|
||||
{{- define "norish.fullname" -}}
|
||||
{{- if .Values.fullnameOverride }}
|
||||
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- else }}
|
||||
{{- $name := default .Chart.Name .Values.nameOverride }}
|
||||
{{- printf "%s" $name | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create chart name and version as used by the chart label.
|
||||
*/}}
|
||||
{{- define "norish.chart" -}}
|
||||
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Common labels
|
||||
*/}}
|
||||
{{- define "norish.labels" -}}
|
||||
helm.sh/chart: {{ include "norish.chart" . }}
|
||||
{{ include "norish.selectorLabels" . }}
|
||||
{{- if .Chart.AppVersion }}
|
||||
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
|
||||
{{- end }}
|
||||
app.kubernetes.io/managed-by: {{ .Release.Service }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Selector labels
|
||||
*/}}
|
||||
{{- define "norish.selectorLabels" -}}
|
||||
app.kubernetes.io/name: {{ include "norish.name" . }}
|
||||
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Database connection URL
|
||||
*/}}
|
||||
{{- define "norish.databaseUrl" -}}
|
||||
{{- $username := .Values.database.username }}
|
||||
{{- $password := .Values.database.password }}
|
||||
{{- $host := .Values.database.host }}
|
||||
{{- $port := .Values.database.port }}
|
||||
{{- $database := .Values.database.name }}
|
||||
{{- printf "postgres://%s:%s@%s:%d/%s" $username $password $host (int $port) $database }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Redis URL (for non-authenticated Redis)
|
||||
Constructs the Redis URL without authentication.
|
||||
Format: redis://host:port/database
|
||||
*/}}
|
||||
{{- define "norish.redis.url.noauth" -}}
|
||||
{{- $host := .Values.redis.host }}
|
||||
{{- $port := .Values.redis.port }}
|
||||
{{- $database := .Values.redis.database | toString }}
|
||||
{{- printf "redis://%s:%d/%s" $host (int $port) $database }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Check if Redis authentication is configured
|
||||
Returns true if either existingSecret or password is set
|
||||
*/}}
|
||||
{{- define "norish.redis.hasAuth" -}}
|
||||
{{- if or .Values.redis.existingSecret .Values.redis.password }}
|
||||
{{- "true" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Redis URL with authentication (for secret generation)
|
||||
Constructs the Redis URL with password interpolation for use in secrets.
|
||||
Format: redis://[username]:[password]@host:port/database
|
||||
*/}}
|
||||
{{- define "norish.redis.url.withPassword" -}}
|
||||
{{- $host := .Values.redis.host }}
|
||||
{{- $port := .Values.redis.port }}
|
||||
{{- $database := .Values.redis.database | toString }}
|
||||
{{- $username := .Values.redis.username | default "" }}
|
||||
{{- $password := .Values.redis.password | default "" }}
|
||||
{{- if $username }}
|
||||
{{- printf "redis://%s:%s@%s:%d/%s" $username $password $host (int $port) $database }}
|
||||
{{- else }}
|
||||
{{- printf "redis://:%s@%s:%d/%s" $password $host (int $port) $database }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
292
charts/norish/templates/deployment-app.yaml
Normal file
292
charts/norish/templates/deployment-app.yaml
Normal file
@ -0,0 +1,292 @@
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: {{ include "norish.fullname" . }}
|
||||
labels:
|
||||
{{- include "norish.labels" . | nindent 4 }}
|
||||
app.kubernetes.io/component: app
|
||||
annotations:
|
||||
checksum/secret: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
|
||||
spec:
|
||||
replicas: {{ .Values.replicaCount }}
|
||||
revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
|
||||
selector:
|
||||
matchLabels:
|
||||
{{- include "norish.selectorLabels" . | nindent 6 }}
|
||||
strategy:
|
||||
type: RollingUpdate
|
||||
rollingUpdate:
|
||||
maxUnavailable: 1
|
||||
maxSurge: 1
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
{{- include "norish.selectorLabels" . | nindent 8 }}
|
||||
annotations:
|
||||
checksum/secret: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
|
||||
{{- with .Values.podAnnotations }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- with .Values.imagePullSecrets }}
|
||||
imagePullSecrets:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.podSecurityContext | nindent 8 }}
|
||||
containers:
|
||||
- name: {{ .Chart.Name }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.containerSecurityContext | nindent 12 }}
|
||||
image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
|
||||
imagePullPolicy: {{ .Values.image.pullPolicy }}
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: {{ .Values.service.port }}
|
||||
protocol: TCP
|
||||
{{- if .Values.probes.startup.enabled }}
|
||||
startupProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.startup.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.startup.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.startup.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.startup.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.startup.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.startup.successThreshold }}
|
||||
{{- end }}
|
||||
{{- if .Values.probes.liveness.enabled }}
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.liveness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.liveness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.liveness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.liveness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.liveness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.liveness.successThreshold }}
|
||||
{{- end }}
|
||||
{{- if .Values.probes.readiness.enabled }}
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.readiness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.readiness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.readiness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.readiness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.readiness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.readiness.successThreshold }}
|
||||
{{- end }}
|
||||
env:
|
||||
- name: AUTH_URL
|
||||
value: {{ .Values.config.authUrl | quote }}
|
||||
{{- if .Values.chrome.enabled }}
|
||||
- name: CHROME_WS_ENDPOINT
|
||||
value: "ws://localhost:{{ .Values.chrome.port }}"
|
||||
{{- end }}
|
||||
{{- if .Values.config.logLevel }}
|
||||
- name: NEXT_PUBLIC_LOG_LEVEL
|
||||
value: {{ .Values.config.logLevel | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.trustedOrigins }}
|
||||
- name: TRUSTED_ORIGINS
|
||||
value: {{ .Values.config.trustedOrigins | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.passwordAuthEnabled }}
|
||||
- name: PASSWORD_AUTH_ENABLED
|
||||
value: {{ .Values.config.passwordAuthEnabled | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.database.existingSecret }}
|
||||
- name: DB_USERNAME
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.database.existingSecret }}
|
||||
key: {{ .Values.database.usernameKey }}
|
||||
- name: DB_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.database.existingSecret }}
|
||||
key: {{ .Values.database.passwordKey }}
|
||||
{{- if .Values.database.databaseKey }}
|
||||
- name: DB_NAME
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.database.existingSecret }}
|
||||
key: {{ .Values.database.databaseKey }}
|
||||
{{- else }}
|
||||
- name: DB_NAME
|
||||
value: {{ .Values.database.name | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.database.hostKey }}
|
||||
- name: DB_HOST
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.database.existingSecret }}
|
||||
key: {{ .Values.database.hostKey }}
|
||||
{{- else }}
|
||||
- name: DB_HOST
|
||||
value: {{ .Values.database.host | quote }}
|
||||
{{- end }}
|
||||
- name: DB_PORT
|
||||
value: {{ .Values.database.port | quote }}
|
||||
- name: DATABASE_URL
|
||||
value: "postgres://$(DB_USERNAME):$(DB_PASSWORD)@$(DB_HOST):$(DB_PORT)/$(DB_NAME)"
|
||||
{{- else }}
|
||||
- name: DATABASE_URL
|
||||
value: {{ include "norish.databaseUrl" . | quote }}
|
||||
{{- end }}
|
||||
- name: MASTER_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
{{- if .Values.config.masterKey.existingSecret }}
|
||||
name: {{ .Values.config.masterKey.existingSecret }}
|
||||
key: {{ .Values.config.masterKey.secretKey }}
|
||||
{{- else }}
|
||||
name: {{ include "norish.fullname" . }}-secret
|
||||
key: master-key
|
||||
{{- end }}
|
||||
- name: REDIS_URL
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
{{- if .Values.redis.existingSecret }}
|
||||
name: {{ .Values.redis.existingSecret }}
|
||||
key: {{ .Values.redis.urlKey | default "redis-url" }}
|
||||
{{- else }}
|
||||
name: {{ include "norish.fullname" . }}-secret
|
||||
key: redis-url
|
||||
{{- end }}
|
||||
{{- if .Values.config.auth.oidc.enabled }}
|
||||
- name: OIDC_NAME
|
||||
value: {{ .Values.config.auth.oidc.name | quote }}
|
||||
- name: OIDC_ISSUER
|
||||
value: {{ .Values.config.auth.oidc.issuer | quote }}
|
||||
{{- if .Values.config.auth.oidc.wellKnown }}
|
||||
- name: OIDC_WELLKNOWN
|
||||
value: {{ .Values.config.auth.oidc.wellKnown | quote }}
|
||||
{{- end }}
|
||||
- name: OIDC_CLIENT_ID
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
{{- if .Values.config.auth.oidc.existingSecret }}
|
||||
name: {{ .Values.config.auth.oidc.existingSecret }}
|
||||
key: {{ .Values.config.auth.oidc.clientIdKey }}
|
||||
{{- else }}
|
||||
name: {{ include "norish.fullname" . }}-secret
|
||||
key: oidc-client-id
|
||||
{{- end }}
|
||||
- name: OIDC_CLIENT_SECRET
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
{{- if .Values.config.auth.oidc.existingSecret }}
|
||||
name: {{ .Values.config.auth.oidc.existingSecret }}
|
||||
key: {{ .Values.config.auth.oidc.clientSecretKey }}
|
||||
{{- else }}
|
||||
name: {{ include "norish.fullname" . }}-secret
|
||||
key: oidc-client-secret
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.auth.github.enabled }}
|
||||
- name: GITHUB_CLIENT_ID
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
{{- if .Values.config.auth.github.existingSecret }}
|
||||
name: {{ .Values.config.auth.github.existingSecret }}
|
||||
key: {{ .Values.config.auth.github.clientIdKey }}
|
||||
{{- else }}
|
||||
name: {{ include "norish.fullname" . }}-secret
|
||||
key: github-client-id
|
||||
{{- end }}
|
||||
- name: GITHUB_CLIENT_SECRET
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
{{- if .Values.config.auth.github.existingSecret }}
|
||||
name: {{ .Values.config.auth.github.existingSecret }}
|
||||
key: {{ .Values.config.auth.github.clientSecretKey }}
|
||||
{{- else }}
|
||||
name: {{ include "norish.fullname" . }}-secret
|
||||
key: github-client-secret
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.auth.google.enabled }}
|
||||
- name: GOOGLE_CLIENT_ID
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
{{- if .Values.config.auth.google.existingSecret }}
|
||||
name: {{ .Values.config.auth.google.existingSecret }}
|
||||
key: {{ .Values.config.auth.google.clientIdKey }}
|
||||
{{- else }}
|
||||
name: {{ include "norish.fullname" . }}-secret
|
||||
key: google-client-id
|
||||
{{- end }}
|
||||
- name: GOOGLE_CLIENT_SECRET
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
{{- if .Values.config.auth.google.existingSecret }}
|
||||
name: {{ .Values.config.auth.google.existingSecret }}
|
||||
key: {{ .Values.config.auth.google.clientSecretKey }}
|
||||
{{- else }}
|
||||
name: {{ include "norish.fullname" . }}-secret
|
||||
key: google-client-secret
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- with .Values.config.extraEnv }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
volumeMounts:
|
||||
- name: uploads
|
||||
mountPath: /app/uploads
|
||||
{{- with .Values.extraVolumeMounts }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
resources:
|
||||
{{- toYaml .Values.resources | nindent 12 }}
|
||||
{{- if .Values.chrome.enabled }}
|
||||
- name: chrome-headless
|
||||
image: "{{ .Values.chrome.image.repository }}:{{ .Values.chrome.image.tag }}"
|
||||
imagePullPolicy: {{ .Values.chrome.image.pullPolicy }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.chrome.securityContext | nindent 12 }}
|
||||
ports:
|
||||
- name: chrome
|
||||
containerPort: {{ .Values.chrome.port }}
|
||||
protocol: TCP
|
||||
command:
|
||||
- chromium-browser
|
||||
args:
|
||||
- "--no-sandbox"
|
||||
- "--disable-gpu"
|
||||
- "--disable-dev-shm-usage"
|
||||
- "--remote-debugging-address=0.0.0.0"
|
||||
- "--remote-debugging-port={{ .Values.chrome.port }}"
|
||||
- "--headless"
|
||||
resources:
|
||||
{{- toYaml .Values.chrome.resources | nindent 12 }}
|
||||
{{- end }}
|
||||
volumes:
|
||||
{{- if .Values.persistence.enabled }}
|
||||
- name: uploads
|
||||
persistentVolumeClaim:
|
||||
{{- if .Values.persistence.existingClaim }}
|
||||
claimName: {{ .Values.persistence.existingClaim }}
|
||||
{{- else }}
|
||||
claimName: {{ include "norish.fullname" . }}-uploads
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
- name: uploads
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
{{- with .Values.extraVolumes }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.nodeSelector }}
|
||||
nodeSelector:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.affinity }}
|
||||
affinity:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.tolerations }}
|
||||
tolerations:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
43
charts/norish/templates/ingress.yaml
Normal file
43
charts/norish/templates/ingress.yaml
Normal file
@ -0,0 +1,43 @@
|
||||
{{- if .Values.ingress.enabled -}}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: {{ include "norish.fullname" . }}
|
||||
labels:
|
||||
{{- include "norish.labels" . | nindent 4 }}
|
||||
{{- with .Values.ingress.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- if .Values.ingress.className }}
|
||||
ingressClassName: {{ .Values.ingress.className }}
|
||||
{{- end }}
|
||||
{{- if .Values.ingress.tls }}
|
||||
tls:
|
||||
{{- range .Values.ingress.tls }}
|
||||
- hosts:
|
||||
{{- range .hosts }}
|
||||
- {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- if .secretName }}
|
||||
secretName: {{ .secretName }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
rules:
|
||||
{{- range .Values.ingress.hosts }}
|
||||
- host: {{ .host | quote }}
|
||||
http:
|
||||
paths:
|
||||
{{- range .paths }}
|
||||
- path: {{ .path }}
|
||||
pathType: {{ .pathType }}
|
||||
backend:
|
||||
service:
|
||||
name: {{ include "norish.fullname" $ }}
|
||||
port:
|
||||
number: {{ $.Values.service.port }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
22
charts/norish/templates/pvc.yaml
Normal file
22
charts/norish/templates/pvc.yaml
Normal file
@ -0,0 +1,22 @@
|
||||
{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "norish.fullname" . }}-uploads
|
||||
labels:
|
||||
{{- include "norish.labels" . | nindent 4 }}
|
||||
app.kubernetes.io/component: app
|
||||
{{- with .Values.persistence.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.accessMode }}
|
||||
{{- if .Values.persistence.storageClass }}
|
||||
storageClassName: {{ .Values.persistence.storageClass }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.size }}
|
||||
{{- end }}
|
||||
39
charts/norish/templates/secret.yaml
Normal file
39
charts/norish/templates/secret.yaml
Normal file
@ -0,0 +1,39 @@
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: {{ include "norish.fullname" . }}-secret
|
||||
labels:
|
||||
{{- include "norish.labels" . | nindent 4 }}
|
||||
type: Opaque
|
||||
stringData:
|
||||
{{- if not .Values.config.masterKey.existingSecret }}
|
||||
master-key: {{ .Values.config.masterKey.value | required "config.masterKey.value is required when config.masterKey.existingSecret is not set" | quote }}
|
||||
{{- end }}
|
||||
{{- if not .Values.database.existingSecret }}
|
||||
database-url: {{ include "norish.databaseUrl" . | quote }}
|
||||
{{- end }}
|
||||
{{- if not .Values.redis.existingSecret }}
|
||||
{{- if .Values.redis.password }}
|
||||
redis-url: {{ include "norish.redis.url.withPassword" . | quote }}
|
||||
{{- else }}
|
||||
redis-url: {{ include "norish.redis.url.noauth" . | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.auth.oidc.enabled }}
|
||||
{{- if not .Values.config.auth.oidc.existingSecret }}
|
||||
oidc-client-id: {{ .Values.config.auth.oidc.clientId | quote }}
|
||||
oidc-client-secret: {{ .Values.config.auth.oidc.clientSecret | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.auth.github.enabled }}
|
||||
{{- if not .Values.config.auth.github.existingSecret }}
|
||||
github-client-id: {{ .Values.config.auth.github.clientId | quote }}
|
||||
github-client-secret: {{ .Values.config.auth.github.clientSecret | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.auth.google.enabled }}
|
||||
{{- if not .Values.config.auth.google.existingSecret }}
|
||||
google-client-id: {{ .Values.config.auth.google.clientId | quote }}
|
||||
google-client-secret: {{ .Values.config.auth.google.clientSecret | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
20
charts/norish/templates/service.yaml
Normal file
20
charts/norish/templates/service.yaml
Normal file
@ -0,0 +1,20 @@
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: {{ include "norish.fullname" . }}
|
||||
labels:
|
||||
{{- include "norish.labels" . | nindent 4 }}
|
||||
app.kubernetes.io/component: app
|
||||
{{- with .Values.service.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
type: {{ .Values.service.type }}
|
||||
ports:
|
||||
- port: {{ .Values.service.port }}
|
||||
targetPort: http
|
||||
protocol: TCP
|
||||
name: http
|
||||
selector:
|
||||
{{- include "norish.selectorLabels" . | nindent 4 }}
|
||||
259
charts/norish/values.yaml
Normal file
259
charts/norish/values.yaml
Normal file
@ -0,0 +1,259 @@
|
||||
## Global settings
|
||||
nameOverride: ""
|
||||
fullnameOverride: ""
|
||||
|
||||
## Image settings
|
||||
image:
|
||||
repository: norishapp/norish
|
||||
tag: "v0.15.4-beta"
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
imagePullSecrets: []
|
||||
|
||||
## Deployment settings
|
||||
replicaCount: 1
|
||||
revisionHistoryLimit: 3
|
||||
|
||||
# Pod security settings
|
||||
podSecurityContext:
|
||||
runAsNonRoot: true
|
||||
runAsUser: 1000
|
||||
fsGroup: 1000
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
readOnlyRootFilesystem: false
|
||||
capabilities:
|
||||
drop:
|
||||
- ALL
|
||||
|
||||
## Pod scheduling
|
||||
nodeSelector: {}
|
||||
tolerations: []
|
||||
affinity: {}
|
||||
|
||||
## Pod annotations
|
||||
podAnnotations: {}
|
||||
|
||||
## Service settings
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 3000
|
||||
annotations: {}
|
||||
|
||||
## Ingress settings
|
||||
ingress:
|
||||
enabled: false
|
||||
className: ""
|
||||
annotations:
|
||||
traefik.ingress.kubernetes.io/router.entrypoints: websecure
|
||||
hosts:
|
||||
- host: norish.domain.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- norish.domain.com
|
||||
# Optional: specify the name of an existing TLS secret
|
||||
# secretName: "existing-tls-secret"
|
||||
|
||||
## Persistence settings
|
||||
persistence:
|
||||
enabled: true
|
||||
# Use an existing PVC instead of creating a new one
|
||||
existingClaim: ""
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 5Gi
|
||||
annotations: {}
|
||||
|
||||
# Extra volume mounts
|
||||
extraVolumeMounts: []
|
||||
|
||||
# Extra volumes
|
||||
extraVolumes: []
|
||||
|
||||
## Resource limits and requests
|
||||
resources: {}
|
||||
# We usually recommend not to specify default resources and to leave this as a conscious
|
||||
# choice for the user. This also increases chances charts run on environments with little
|
||||
# resources, such as Minikube. If you do want to specify resources, uncomment the following
|
||||
# lines, adjust them as necessary, and remove the curly braces after 'resources:'.
|
||||
# limits:
|
||||
# cpu: 500m
|
||||
# memory: 512Mi
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 128Mi
|
||||
|
||||
## Application health checks
|
||||
probes:
|
||||
startup:
|
||||
enabled: true
|
||||
initialDelaySeconds: 10
|
||||
periodSeconds: 10
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 30
|
||||
successThreshold: 1
|
||||
path: /
|
||||
liveness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 10
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 6
|
||||
successThreshold: 1
|
||||
path: /
|
||||
readiness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 5
|
||||
periodSeconds: 5
|
||||
timeoutSeconds: 3
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
path: /
|
||||
|
||||
## Application configuration
|
||||
config:
|
||||
# Application URL (required)
|
||||
# This should match your ingress hostname
|
||||
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)
|
||||
# Generate with: openssl rand -base64 32
|
||||
# For production, use an existing Kubernetes Secret
|
||||
masterKey:
|
||||
existingSecret: "" # Name of existing Kubernetes secret
|
||||
secretKey: "master-key" # Key in the secret where master key is stored
|
||||
value: "" # Only used if existingSecret is not set (must be 32-byte base64)
|
||||
|
||||
# Optional configuration
|
||||
# Log level: trace, debug, info, warn, error, fatal
|
||||
# Defaults to info in production, debug in development
|
||||
logLevel: ""
|
||||
|
||||
# Additional trusted origins (comma-separated)
|
||||
# Useful when behind a proxy or using multiple domains
|
||||
# Example: "http://192.168.1.100:3000,https://norish.example.com"
|
||||
trustedOrigins: ""
|
||||
|
||||
# Enable/disable password authentication
|
||||
# Defaults to false if OIDC or OAuth is configured, true otherwise
|
||||
passwordAuthEnabled: ""
|
||||
|
||||
# Authentication provider configuration
|
||||
# Configure ONE provider for initial admin account creation
|
||||
# After first login, manage additional providers via Settings → Admin
|
||||
auth:
|
||||
# OIDC/OAuth2 provider
|
||||
oidc:
|
||||
enabled: false
|
||||
name: "MyAuth"
|
||||
issuer: ""
|
||||
clientId: ""
|
||||
clientSecret: ""
|
||||
# Optional: OIDC well-known configuration URL
|
||||
# By default derived from issuer by appending /.well-known/openid-configuration
|
||||
wellKnown: ""
|
||||
# Use existing secret for OIDC credentials
|
||||
existingSecret: ""
|
||||
clientIdKey: "oidc-client-id"
|
||||
clientSecretKey: "oidc-client-secret"
|
||||
|
||||
# GitHub OAuth
|
||||
github:
|
||||
enabled: false
|
||||
clientId: ""
|
||||
clientSecret: ""
|
||||
# Use existing secret for GitHub credentials
|
||||
existingSecret: ""
|
||||
clientIdKey: "github-client-id"
|
||||
clientSecretKey: "github-client-secret"
|
||||
|
||||
# Google OAuth
|
||||
google:
|
||||
enabled: false
|
||||
clientId: ""
|
||||
clientSecret: ""
|
||||
# Use existing secret for Google credentials
|
||||
existingSecret: ""
|
||||
clientIdKey: "google-client-id"
|
||||
clientSecretKey: "google-client-secret"
|
||||
|
||||
## External PostgreSQL database configuration (REQUIRED)
|
||||
## Norish requires a central PostgreSQL database
|
||||
## You must have a PostgreSQL server available before deploying this chart
|
||||
database:
|
||||
# Database connection details
|
||||
host: "" # Required: PostgreSQL server hostname
|
||||
port: 5432
|
||||
name: norish
|
||||
username: postgres
|
||||
password: ""
|
||||
|
||||
# Use existing secret for database credentials (recommended for production)
|
||||
existingSecret: "" # Name of existing Kubernetes secret
|
||||
usernameKey: "username" # Key in the secret for database username
|
||||
passwordKey: "password" # Key in the secret for database password
|
||||
databaseKey: "database" # Key in the secret for database name (optional)
|
||||
hostKey: "" # Key in the secret for database host (optional)
|
||||
|
||||
## External Redis configuration (REQUIRED for v0.14.0+)
|
||||
## Redis is required for job queues and background tasks starting from v0.14.0-beta
|
||||
redis:
|
||||
# Redis connection details
|
||||
host: "" # Required: Redis server hostname
|
||||
port: 6379
|
||||
database: 0
|
||||
# Authentication (leave empty if Redis has no auth)
|
||||
username: "" # Optional: Redis username (Redis 6.0+)
|
||||
password: "" # Redis password (leave empty if no auth)
|
||||
|
||||
# Use existing secret for Redis credentials (recommended for production)
|
||||
# NOTE: When using existingSecret, the secret MUST contain a key with the full Redis URL
|
||||
# Format: redis://[username]:[password]@host:port/database
|
||||
existingSecret: "" # Name of existing Kubernetes secret
|
||||
urlKey: "redis-url" # Key in existingSecret containing the full Redis URL
|
||||
passwordKey: "password" # Key in existingSecret for password (for compatibility)
|
||||
|
||||
## Chrome Headless configuration (REQUIRED)
|
||||
## Required for improved recipe parsing and scraping
|
||||
chrome:
|
||||
enabled: true
|
||||
image:
|
||||
repository: zenika/alpine-chrome
|
||||
tag: "latest"
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
# Chrome port for remote debugging
|
||||
port: 9222
|
||||
|
||||
# Chrome security context - requires specific capabilities
|
||||
securityContext:
|
||||
runAsNonRoot: false
|
||||
runAsUser: 0
|
||||
capabilities:
|
||||
add:
|
||||
- SYS_ADMIN
|
||||
|
||||
# Chrome resource limits
|
||||
resources: {}
|
||||
# limits:
|
||||
# cpu: 500m
|
||||
# memory: 512Mi
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 256Mi
|
||||
18
charts/paperless-ngx/Chart.yaml
Normal file
18
charts/paperless-ngx/Chart.yaml
Normal file
@ -0,0 +1,18 @@
|
||||
apiVersion: v2
|
||||
name: paperless-ngx
|
||||
description: Paperless-ngx helm chart for Kubernetes
|
||||
type: application
|
||||
version: 0.0.5
|
||||
appVersion: "2.20.3"
|
||||
maintainers:
|
||||
- name: Richard Tomik
|
||||
email: richard.tomik@proton.me
|
||||
keywords:
|
||||
- productivity
|
||||
- document-management
|
||||
- paperless
|
||||
- paperless-ngx
|
||||
- ocr
|
||||
home: https://github.com/rtomik/helm-charts
|
||||
sources:
|
||||
- https://github.com/paperless-ngx/paperless-ngx
|
||||
92
charts/paperless-ngx/NOTES.txt
Normal file
92
charts/paperless-ngx/NOTES.txt
Normal file
@ -0,0 +1,92 @@
|
||||
1. Get the application URL by running these commands:
|
||||
{{- if .Values.ingress.enabled }}
|
||||
{{- range $host := .Values.ingress.hosts }}
|
||||
{{- range .paths }}
|
||||
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- else if contains "NodePort" .Values.service.type }}
|
||||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "paperless-ngx.fullname" . }})
|
||||
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
|
||||
echo http://$NODE_IP:$NODE_PORT
|
||||
{{- else if contains "LoadBalancer" .Values.service.type }}
|
||||
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
|
||||
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "paperless-ngx.fullname" . }}'
|
||||
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "paperless-ngx.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
|
||||
echo http://$SERVICE_IP:{{ .Values.service.port }}
|
||||
{{- else if contains "ClusterIP" .Values.service.type }}
|
||||
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "paperless-ngx.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
|
||||
export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
|
||||
echo "Visit http://127.0.0.1:8000 to use your application"
|
||||
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8000:$CONTAINER_PORT
|
||||
{{- end }}
|
||||
|
||||
2. Application is accessible at port {{ .Values.service.port }}
|
||||
|
||||
3. Paperless-ngx is configured with:
|
||||
- Database: PostgreSQL (external)
|
||||
- Redis: External service
|
||||
- OCR Language: {{ .Values.config.ocr.language }}
|
||||
- Time Zone: {{ .Values.config.timeZone }}
|
||||
|
||||
4. External Dependencies Required:
|
||||
- PostgreSQL server: {{ include "paperless-ngx.postgresql.host" . }}:{{ include "paperless-ngx.postgresql.port" . }}
|
||||
- Redis server: {{ include "paperless-ngx.redis.host" . }}:{{ include "paperless-ngx.redis.port" . }}
|
||||
|
||||
{{- if or .Values.persistence.data.enabled .Values.persistence.media.enabled .Values.persistence.consume.enabled .Values.persistence.export.enabled }}
|
||||
5. Persistent Storage:
|
||||
{{- if .Values.persistence.data.enabled }}
|
||||
- Data directory: {{ include "paperless-ngx.fullname" . }}-data ({{ .Values.persistence.data.size }})
|
||||
{{- end }}
|
||||
{{- if .Values.persistence.media.enabled }}
|
||||
- Media directory: {{ include "paperless-ngx.fullname" . }}-media ({{ .Values.persistence.media.size }})
|
||||
{{- end }}
|
||||
{{- if .Values.persistence.consume.enabled }}
|
||||
- Consume directory: {{ include "paperless-ngx.fullname" . }}-consume ({{ .Values.persistence.consume.size }})
|
||||
{{- end }}
|
||||
{{- if .Values.persistence.export.enabled }}
|
||||
- Export directory: {{ include "paperless-ngx.fullname" . }}-export ({{ .Values.persistence.export.size }})
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
5. WARNING: No persistent storage enabled. Data will be lost when pods are restarted.
|
||||
Enable persistence in values.yaml for production use.
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.config.admin.user }}
|
||||
6. Admin User: {{ .Values.config.admin.user }}
|
||||
The admin user will be created automatically on first startup.
|
||||
{{- else }}
|
||||
6. No admin user configured. You'll need to create a superuser manually:
|
||||
kubectl exec -it deployment/{{ include "paperless-ngx.fullname" . }} -- python manage.py createsuperuser
|
||||
{{- end }}
|
||||
|
||||
{{- if or .Values.config.secretKey.existingSecret .Values.postgresql.external.existingSecret .Values.config.admin.existingSecret }}
|
||||
7. Using external secrets for sensitive information:
|
||||
{{- if .Values.config.secretKey.existingSecret }}
|
||||
- Secret key from: {{ .Values.config.secretKey.existingSecret }}
|
||||
{{- end }}
|
||||
{{- if .Values.postgresql.external.existingSecret }}
|
||||
- PostgreSQL password from: {{ .Values.postgresql.external.existingSecret }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.admin.existingSecret }}
|
||||
- Admin credentials from: {{ .Values.config.admin.existingSecret }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
7. SECURITY NOTE: For production use, it's recommended to store sensitive data in Kubernetes Secrets.
|
||||
- Set config.secretKey.existingSecret to use an external secret for the secret key
|
||||
- Set postgresql.external.existingSecret to use an external secret for database credentials
|
||||
- Set config.admin.existingSecret to use an external secret for admin credentials
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.config.consumer.barcodes.enabled }}
|
||||
8. Barcode processing is enabled with scanner: {{ .Values.config.consumer.barcodeScanner }}
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.config.tika.enabled }}
|
||||
9. Tika integration is enabled for Office document processing
|
||||
- Tika endpoint: {{ .Values.config.tika.endpoint }}
|
||||
- Gotenberg endpoint: {{ .Values.config.tika.gotenbergEndpoint }}
|
||||
{{- end }}
|
||||
|
||||
For more information about using this Helm chart and Paperless-ngx configuration,
|
||||
please refer to the README.md file and the official Paperless-ngx documentation.
|
||||
348
charts/paperless-ngx/readme.md
Normal file
348
charts/paperless-ngx/readme.md
Normal file
@ -0,0 +1,348 @@
|
||||
# Paperless-ngx Helm Chart
|
||||
|
||||
A Helm chart for deploying Paperless-ngx document management system on Kubernetes.
|
||||
|
||||
## Introduction
|
||||
|
||||
This chart deploys [Paperless-ngx](https://github.com/paperless-ngx/paperless-ngx) on a Kubernetes cluster using the Helm package manager.
|
||||
|
||||
Paperless-ngx is a community-supported supercharged version of paperless: scan, index and archive all your physical documents.
|
||||
|
||||
Source code can be found here:
|
||||
- https://github.com/rtomik/helm-charts/tree/main/charts/paperless-ngx
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
- Helm 3.0+
|
||||
- PV provisioner support in the underlying infrastructure
|
||||
- **External PostgreSQL database** (required)
|
||||
- **External Redis server** (required)
|
||||
|
||||
## External Dependencies
|
||||
|
||||
This chart requires external PostgreSQL and Redis services. It does not deploy these dependencies to avoid resource conflicts on centralized servers.
|
||||
|
||||
### PostgreSQL Setup
|
||||
Paperless-ngx requires PostgreSQL 11+ as its database backend. Ensure you have:
|
||||
- A PostgreSQL database created for Paperless-ngx
|
||||
- Database credentials configured in values.yaml or via secrets
|
||||
|
||||
### Redis Setup
|
||||
Redis is required for background task processing. Ensure you have:
|
||||
- A Redis server accessible from the cluster
|
||||
- Connection details configured in values.yaml
|
||||
- Optional: Redis authentication credentials (username/password)
|
||||
- Optional: Redis key prefix for sharing one Redis server among multiple Paperless instances
|
||||
|
||||
The chart supports all Redis authentication methods:
|
||||
- No authentication: `redis://host:port/database`
|
||||
- Password only (requirepass): `redis://:password@host:port/database`
|
||||
- Username and password (Redis 6.0+ ACL): `redis://username:password@host:port/database`
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `paperless-ngx`:
|
||||
|
||||
```bash
|
||||
$ helm repo add paperless-chart https://rtomik.github.io/helm-charts
|
||||
$ helm install paperless-ngx paperless-chart/paperless-ngx
|
||||
```
|
||||
|
||||
Or install directly from this repository:
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/rtomik/helm-charts.git
|
||||
$ cd helm-charts/charts/paperless-ngx
|
||||
$ helm install paperless-ngx .
|
||||
```
|
||||
|
||||
> **Tip**: List all releases using `helm list`
|
||||
|
||||
## Configuration
|
||||
|
||||
The following table lists the configurable parameters and their default values.
|
||||
|
||||
### Global Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------------------------|-------------------------------------------------------------------------------------|-------|
|
||||
| `nameOverride` | String to partially override the release name | `""` |
|
||||
| `fullnameOverride` | String to fully override the release name | `""` |
|
||||
|
||||
### Image Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------|--------------------------------------------------------------------------------------|--------------------|
|
||||
| `image.repository` | Paperless-ngx image repository | `ghcr.io/paperless-ngx/paperless-ngx` |
|
||||
| `image.tag` | Paperless-ngx image tag | `latest` |
|
||||
| `image.pullPolicy` | Paperless-ngx image pull policy | `IfNotPresent` |
|
||||
|
||||
### External Dependencies
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|--------------------------------------------------------------------|-------------------------------------------|
|
||||
| `postgresql.external.enabled` | Enable external PostgreSQL configuration | `true` |
|
||||
| `postgresql.external.host` | External PostgreSQL host | `postgresql.default.svc.cluster.local` |
|
||||
| `postgresql.external.port` | External PostgreSQL port | `5432` |
|
||||
| `postgresql.external.database` | External PostgreSQL database name | `paperless` |
|
||||
| `postgresql.external.username` | External PostgreSQL username | `paperless` |
|
||||
| `postgresql.external.existingSecret` | Existing secret with PostgreSQL credentials | `""` |
|
||||
| `postgresql.external.passwordKey` | Key in existing secret for PostgreSQL password | `postgresql-password` |
|
||||
| `redis.external.enabled` | Enable external Redis configuration | `true` |
|
||||
| `redis.external.host` | External Redis host | `redis.default.svc.cluster.local` |
|
||||
| `redis.external.port` | External Redis port | `6379` |
|
||||
| `redis.external.database` | External Redis database number | `0` |
|
||||
| `redis.external.username` | Redis username (Redis 6.0+ with ACL) | `""` |
|
||||
| `redis.external.password` | Redis password (leave empty if no auth required) | `""` |
|
||||
| `redis.external.existingSecret` | Existing secret with Redis credentials | `""` |
|
||||
| `redis.external.passwordKey` | Key in existing secret for Redis password | `redis-password` |
|
||||
| `redis.external.prefix` | Prefix for Redis keys/channels (for multi-instance) | `""` |
|
||||
|
||||
### Security Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|--------------------------------------------------------------------|---------------------|
|
||||
| `config.secretKey.existingSecret` | Name of existing secret for Django secret key | `""` |
|
||||
| `config.secretKey.secretKey` | Key in the existing secret for Django secret key | `secret-key` |
|
||||
| `config.admin.user` | Admin username to create on startup | `""` |
|
||||
| `config.admin.password` | Admin password (use existingSecret for production) | `""` |
|
||||
| `config.admin.email` | Admin email address | `root@localhost` |
|
||||
| `config.admin.existingSecret` | Name of existing secret for admin credentials | `""` |
|
||||
|
||||
### Application Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|--------------------------------------------------------------------|---------------------|
|
||||
| `config.url` | External URL for Paperless-ngx (e.g., https://paperless.domain.com) | `""` |
|
||||
| `config.allowedHosts` | Comma-separated list of allowed hosts | `*` |
|
||||
| `config.timeZone` | Application timezone | `UTC` |
|
||||
| `config.ocr.language` | OCR language (3-letter code) | `eng` |
|
||||
| `config.ocr.mode` | OCR mode (skip, redo, force) | `skip` |
|
||||
| `config.consumer.recursive` | Enable recursive consumption directory watching | `false` |
|
||||
| `config.consumer.subdirsAsTags` | Use subdirectory names as tags | `false` |
|
||||
|
||||
### Persistence Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|--------------------------------------------------------------------|---------------------|
|
||||
| `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.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.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.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` |
|
||||
|
||||
### Service Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------|------------------------------------------------------|-------------|
|
||||
| `service.type` | Kubernetes Service type | `ClusterIP` |
|
||||
| `service.port` | Service HTTP port | `8000` |
|
||||
|
||||
### Ingress Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------|------------------------------------------------------|----------------------|
|
||||
| `ingress.enabled` | Enable ingress record generation | `false` |
|
||||
| `ingress.className` | IngressClass name | `""` |
|
||||
| `ingress.annotations` | Additional annotations for the Ingress resource | See values.yaml |
|
||||
| `ingress.hosts` | Array of host and path objects | See values.yaml |
|
||||
| `ingress.tls` | TLS configuration | See values.yaml |
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic Installation
|
||||
|
||||
```bash
|
||||
helm install paperless-ngx . \
|
||||
--set postgresql.external.host=my-postgres.example.com \
|
||||
--set postgresql.external.password=secretpassword \
|
||||
--set redis.external.host=my-redis.example.com
|
||||
```
|
||||
|
||||
### Production Installation with External Secrets
|
||||
|
||||
```yaml
|
||||
# values-production.yaml
|
||||
config:
|
||||
url: "https://paperless.example.com"
|
||||
allowedHosts: "paperless.example.com"
|
||||
secretKey:
|
||||
existingSecret: "paperless-secrets"
|
||||
secretKey: "django-secret-key"
|
||||
admin:
|
||||
user: "admin"
|
||||
existingSecret: "paperless-admin-secrets"
|
||||
|
||||
postgresql:
|
||||
# External PostgreSQL connection details
|
||||
external:
|
||||
enabled: true
|
||||
host: "postgres-cluster-pooler.dbs.svc.cluster.local"
|
||||
port: 5432
|
||||
database: "paperless"
|
||||
username: "paperless"
|
||||
# Use existingSecret for credentials
|
||||
existingSecret: "paperless-db-credentials"
|
||||
passwordKey: "password"
|
||||
|
||||
redis:
|
||||
external:
|
||||
host: "redis.cache.svc.cluster.local"
|
||||
port: 6379
|
||||
database: 0
|
||||
# Use existingSecret for Redis credentials
|
||||
existingSecret: "paperless-redis-credentials"
|
||||
passwordKey: "password"
|
||||
# Optional: Use prefix to share Redis among multiple instances
|
||||
prefix: "paperless-prod"
|
||||
|
||||
ingress:
|
||||
enabled: true
|
||||
className: "nginx"
|
||||
hosts:
|
||||
- host: paperless.example.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- secretName: paperless-tls
|
||||
hosts:
|
||||
- paperless.example.com
|
||||
```
|
||||
|
||||
```bash
|
||||
helm install paperless-ngx . -f values-production.yaml
|
||||
```
|
||||
|
||||
### Redis Authentication Examples
|
||||
|
||||
#### Redis with Password Only (requirepass)
|
||||
|
||||
```bash
|
||||
helm install paperless-ngx . \
|
||||
--set redis.external.host=redis.example.com \
|
||||
--set redis.external.password=myredispassword
|
||||
```
|
||||
|
||||
Or with existing secret:
|
||||
|
||||
```yaml
|
||||
redis:
|
||||
external:
|
||||
host: "redis.example.com"
|
||||
existingSecret: "redis-auth-secret"
|
||||
passwordKey: "redis-password"
|
||||
```
|
||||
|
||||
#### Redis with Username and Password (Redis 6.0+ ACL)
|
||||
|
||||
```bash
|
||||
helm install paperless-ngx . \
|
||||
--set redis.external.host=redis.example.com \
|
||||
--set redis.external.username=paperless-user \
|
||||
--set redis.external.password=myredispassword
|
||||
```
|
||||
|
||||
#### Multiple Paperless Instances on One Redis Server
|
||||
|
||||
Use the `prefix` parameter to avoid key collisions:
|
||||
|
||||
```yaml
|
||||
# Instance 1
|
||||
redis:
|
||||
external:
|
||||
host: "shared-redis.example.com"
|
||||
password: "sharedpassword"
|
||||
prefix: "paperless-prod"
|
||||
|
||||
# Instance 2
|
||||
redis:
|
||||
external:
|
||||
host: "shared-redis.example.com"
|
||||
password: "sharedpassword"
|
||||
prefix: "paperless-staging"
|
||||
```
|
||||
|
||||
## Security Considerations
|
||||
|
||||
1. **Use external secrets** for production deployments to store sensitive data like database passwords, Redis passwords, and the Django secret key.
|
||||
2. **Set a proper PAPERLESS_URL** when exposing the application externally.
|
||||
3. **Configure ALLOWED_HOSTS** to restrict which hosts can access the application.
|
||||
4. **Use HTTPS** when exposing the application to the internet.
|
||||
5. **Secure Redis**: Always use authentication (password or username/password) for Redis in production environments. Use `existingSecret` instead of plain text passwords.
|
||||
6. **Container Security**: The container runs as root initially to allow s6-overlay to set up the runtime environment, then drops privileges to UID 1000. This is required for the Paperless-ngx Docker image to function properly.
|
||||
|
||||
## Volumes and Data
|
||||
|
||||
Paperless-ngx uses several directories:
|
||||
|
||||
- **Data directory**: Contains the search index, classification model, and SQLite database (if used)
|
||||
- **Media directory**: Contains all uploaded documents and thumbnails
|
||||
- **Consume directory**: Drop documents here for automatic processing
|
||||
- **Export directory**: Used for document exports
|
||||
|
||||
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
|
||||
|
||||
To uninstall/delete the `paperless-ngx` deployment:
|
||||
|
||||
```bash
|
||||
helm uninstall paperless-ngx
|
||||
```
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
||||
|
||||
## Contributing
|
||||
|
||||
Please feel free to contribute by opening issues or pull requests at:
|
||||
https://github.com/rtomik/helm-charts
|
||||
|
||||
## License
|
||||
|
||||
This Helm chart is licensed under the MIT License.
|
||||
|
||||
## Links
|
||||
|
||||
- [Paperless-ngx Documentation](https://docs.paperless-ngx.com/)
|
||||
- [Paperless-ngx GitHub Repository](https://github.com/paperless-ngx/paperless-ngx)
|
||||
- [Docker Hub](https://hub.docker.com/r/ghcr.io/paperless-ngx/paperless-ngx)
|
||||
130
charts/paperless-ngx/templates/_helpers.tpl
Normal file
130
charts/paperless-ngx/templates/_helpers.tpl
Normal file
@ -0,0 +1,130 @@
|
||||
{{/*
|
||||
Expand the name of the chart.
|
||||
*/}}
|
||||
{{- define "paperless-ngx.name" -}}
|
||||
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create a default fully qualified app name.
|
||||
*/}}
|
||||
{{- define "paperless-ngx.fullname" -}}
|
||||
{{- if .Values.fullnameOverride }}
|
||||
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- else }}
|
||||
{{- $name := default .Chart.Name .Values.nameOverride }}
|
||||
{{- printf "%s" $name | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create chart name and version as used by the chart label.
|
||||
*/}}
|
||||
{{- define "paperless-ngx.chart" -}}
|
||||
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Common labels
|
||||
*/}}
|
||||
{{- define "paperless-ngx.labels" -}}
|
||||
helm.sh/chart: {{ include "paperless-ngx.chart" . }}
|
||||
{{ include "paperless-ngx.selectorLabels" . }}
|
||||
{{- if .Chart.AppVersion }}
|
||||
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
|
||||
{{- end }}
|
||||
app.kubernetes.io/managed-by: {{ .Release.Service }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Selector labels
|
||||
*/}}
|
||||
{{- define "paperless-ngx.selectorLabels" -}}
|
||||
app.kubernetes.io/name: {{ include "paperless-ngx.name" . }}
|
||||
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
PostgreSQL host
|
||||
*/}}
|
||||
{{- define "paperless-ngx.postgresql.host" -}}
|
||||
{{- if .Values.postgresql.external.enabled }}
|
||||
{{- .Values.postgresql.external.host }}
|
||||
{{- else }}
|
||||
{{- printf "%s-postgresql" (include "paperless-ngx.fullname" .) }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
PostgreSQL port
|
||||
*/}}
|
||||
{{- define "paperless-ngx.postgresql.port" -}}
|
||||
{{- if .Values.postgresql.external.enabled }}
|
||||
{{- .Values.postgresql.external.port | toString }}
|
||||
{{- else }}
|
||||
{{- "5432" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Redis host
|
||||
*/}}
|
||||
{{- define "paperless-ngx.redis.host" -}}
|
||||
{{- if .Values.redis.external.enabled }}
|
||||
{{- .Values.redis.external.host }}
|
||||
{{- else }}
|
||||
{{- printf "%s-redis" (include "paperless-ngx.fullname" .) }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Redis port
|
||||
*/}}
|
||||
{{- define "paperless-ngx.redis.port" -}}
|
||||
{{- if .Values.redis.external.enabled }}
|
||||
{{- .Values.redis.external.port | toString }}
|
||||
{{- else }}
|
||||
{{- "6379" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Redis URL (for non-authenticated Redis)
|
||||
Constructs the Redis URL without authentication.
|
||||
Format: redis://host:port/database
|
||||
*/}}
|
||||
{{- define "paperless-ngx.redis.url.noauth" -}}
|
||||
{{- $host := include "paperless-ngx.redis.host" . }}
|
||||
{{- $port := include "paperless-ngx.redis.port" . }}
|
||||
{{- $database := .Values.redis.external.database | toString }}
|
||||
{{- printf "redis://%s:%s/%s" $host $port $database }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Check if Redis authentication is configured
|
||||
Returns true if either existingSecret or password is set
|
||||
*/}}
|
||||
{{- define "paperless-ngx.redis.hasAuth" -}}
|
||||
{{- if or .Values.redis.external.existingSecret .Values.redis.external.password }}
|
||||
{{- "true" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Redis URL with authentication (for secret generation)
|
||||
Constructs the Redis URL with password interpolation for use in secrets.
|
||||
This uses the actual password value when building the secret.
|
||||
Format: redis://[username]:[password]@host:port/database
|
||||
*/}}
|
||||
{{- define "paperless-ngx.redis.url.withPassword" -}}
|
||||
{{- $host := include "paperless-ngx.redis.host" . }}
|
||||
{{- $port := include "paperless-ngx.redis.port" . }}
|
||||
{{- $database := .Values.redis.external.database | toString }}
|
||||
{{- $username := .Values.redis.external.username | default "" }}
|
||||
{{- $password := .Values.redis.external.password | default "" }}
|
||||
{{- if $username }}
|
||||
{{- printf "redis://%s:%s@%s:%s/%s" $username $password $host $port $database }}
|
||||
{{- else }}
|
||||
{{- printf "redis://:%s@%s:%s/%s" $password $host $port $database }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
13
charts/paperless-ngx/templates/configmap.yaml
Normal file
13
charts/paperless-ngx/templates/configmap.yaml
Normal file
@ -0,0 +1,13 @@
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
name: {{ include "paperless-ngx.fullname" . }}-configmap
|
||||
labels:
|
||||
{{- include "paperless-ngx.labels" . | nindent 4 }}
|
||||
data:
|
||||
# Additional configuration files can be added here if needed
|
||||
# Most Paperless-ngx configuration is handled via environment variables
|
||||
README.txt: |
|
||||
This ConfigMap can be used to store additional configuration files
|
||||
for Paperless-ngx if needed. The main configuration is handled via
|
||||
environment variables in the deployment.
|
||||
381
charts/paperless-ngx/templates/deployment.yaml
Normal file
381
charts/paperless-ngx/templates/deployment.yaml
Normal file
@ -0,0 +1,381 @@
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: {{ include "paperless-ngx.fullname" . }}
|
||||
labels:
|
||||
{{- include "paperless-ngx.labels" . | nindent 4 }}
|
||||
annotations:
|
||||
checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }}
|
||||
checksum/secret: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
|
||||
spec:
|
||||
replicas: {{ .Values.replicaCount }}
|
||||
revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
|
||||
selector:
|
||||
matchLabels:
|
||||
{{- include "paperless-ngx.selectorLabels" . | nindent 6 }}
|
||||
strategy:
|
||||
type: RollingUpdate
|
||||
rollingUpdate:
|
||||
maxUnavailable: 1
|
||||
maxSurge: 1
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
{{- include "paperless-ngx.selectorLabels" . | nindent 8 }}
|
||||
annotations:
|
||||
{{- with .Values.podAnnotations }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- with .Values.imagePullSecrets }}
|
||||
imagePullSecrets:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.podSecurityContext | nindent 8 }}
|
||||
containers:
|
||||
- name: {{ .Chart.Name }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.containerSecurityContext | nindent 12 }}
|
||||
image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
|
||||
imagePullPolicy: {{ .Values.image.pullPolicy }}
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: {{ .Values.service.port }}
|
||||
protocol: TCP
|
||||
{{- if .Values.probes.liveness.enabled }}
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.liveness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.liveness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.liveness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.liveness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.liveness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.liveness.successThreshold }}
|
||||
{{- end }}
|
||||
{{- if .Values.probes.readiness.enabled }}
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.readiness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.readiness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.readiness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.readiness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.readiness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.readiness.successThreshold }}
|
||||
{{- end }}
|
||||
env:
|
||||
# Required services
|
||||
{{- if include "paperless-ngx.redis.hasAuth" . }}
|
||||
# When Redis has authentication, read the full URL from secret
|
||||
- name: PAPERLESS_REDIS
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.redis.external.existingSecret | default (printf "%s-secrets" (include "paperless-ngx.fullname" .)) }}
|
||||
key: {{ .Values.redis.external.urlKey | default "redis-url" }}
|
||||
{{- else }}
|
||||
# When Redis has no authentication, use the simple URL
|
||||
- name: PAPERLESS_REDIS
|
||||
value: {{ include "paperless-ngx.redis.url.noauth" . | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.redis.external.prefix }}
|
||||
- name: PAPERLESS_REDIS_PREFIX
|
||||
value: {{ .Values.redis.external.prefix | quote }}
|
||||
{{- end }}
|
||||
|
||||
- name: PAPERLESS_DBHOST
|
||||
value: {{ include "paperless-ngx.postgresql.host" . | quote }}
|
||||
- name: PAPERLESS_DBPORT
|
||||
value: {{ include "paperless-ngx.postgresql.port" . | quote }}
|
||||
- name: PAPERLESS_DBNAME
|
||||
value: {{ .Values.postgresql.external.database | quote }}
|
||||
- name: PAPERLESS_DBUSER
|
||||
value: {{ .Values.postgresql.external.username | quote }}
|
||||
|
||||
# Database password from secret
|
||||
- name: PAPERLESS_DBPASS
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.postgresql.external.existingSecret | default (printf "%s-secrets" (include "paperless-ngx.fullname" .)) }}
|
||||
key: {{ .Values.postgresql.external.passwordKey | default "postgresql-password" }}
|
||||
|
||||
# Security
|
||||
- name: PAPERLESS_SECRET_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.secretKey.existingSecret | default (printf "%s-secrets" (include "paperless-ngx.fullname" .)) }}
|
||||
key: {{ .Values.config.secretKey.secretKey | default "secret-key" }}
|
||||
|
||||
# Basic configuration
|
||||
{{- if .Values.config.url }}
|
||||
- name: PAPERLESS_URL
|
||||
value: {{ .Values.config.url | quote }}
|
||||
{{- end }}
|
||||
- name: PAPERLESS_ALLOWED_HOSTS
|
||||
value: {{ .Values.config.allowedHosts | quote }}
|
||||
{{- if .Values.config.csrfTrustedOrigins }}
|
||||
- name: PAPERLESS_CSRF_TRUSTED_ORIGINS
|
||||
value: {{ .Values.config.csrfTrustedOrigins | quote }}
|
||||
{{- end }}
|
||||
- name: PAPERLESS_CORS_ALLOWED_HOSTS
|
||||
value: {{ .Values.config.corsAllowedHosts | quote }}
|
||||
{{- if .Values.config.forceScriptName }}
|
||||
- name: PAPERLESS_FORCE_SCRIPT_NAME
|
||||
value: {{ .Values.config.forceScriptName | quote }}
|
||||
{{- end }}
|
||||
|
||||
# Paths
|
||||
- name: PAPERLESS_DATA_DIR
|
||||
value: "/usr/src/paperless/data"
|
||||
- name: PAPERLESS_MEDIA_ROOT
|
||||
value: "/usr/src/paperless/media"
|
||||
- name: PAPERLESS_CONSUMPTION_DIR
|
||||
value: "/usr/src/paperless/consume"
|
||||
|
||||
# Docker/User settings (s6-overlay compatible)
|
||||
- name: USERMAP_UID
|
||||
value: "1000"
|
||||
- name: USERMAP_GID
|
||||
value: "1000"
|
||||
|
||||
# OCR settings
|
||||
- name: PAPERLESS_OCR_LANGUAGE
|
||||
value: {{ .Values.config.ocr.language | quote }}
|
||||
- name: PAPERLESS_OCR_MODE
|
||||
value: {{ .Values.config.ocr.mode | quote }}
|
||||
- name: PAPERLESS_OCR_SKIP_ARCHIVE_FILE
|
||||
value: {{ .Values.config.ocr.skipArchiveFile | quote }}
|
||||
- name: PAPERLESS_OCR_CLEAN
|
||||
value: {{ .Values.config.ocr.clean | quote }}
|
||||
- name: PAPERLESS_OCR_DESKEW
|
||||
value: {{ .Values.config.ocr.deskew | quote }}
|
||||
- name: PAPERLESS_OCR_ROTATE_PAGES
|
||||
value: {{ .Values.config.ocr.rotatePages | quote }}
|
||||
- name: PAPERLESS_OCR_ROTATE_PAGES_THRESHOLD
|
||||
value: {{ .Values.config.ocr.rotatePagesThreshold | quote }}
|
||||
- name: PAPERLESS_OCR_OUTPUT_TYPE
|
||||
value: {{ .Values.config.ocr.outputType | quote }}
|
||||
{{- if ne (.Values.config.ocr.pages | int) 0 }}
|
||||
- name: PAPERLESS_OCR_PAGES
|
||||
value: {{ .Values.config.ocr.pages | quote }}
|
||||
{{- end }}
|
||||
{{- if ne (.Values.config.ocr.imageDpi | int) 0 }}
|
||||
- name: PAPERLESS_OCR_IMAGE_DPI
|
||||
value: {{ .Values.config.ocr.imageDpi | quote }}
|
||||
{{- end }}
|
||||
{{- if ne (.Values.config.ocr.maxImagePixels | int) 0 }}
|
||||
- name: PAPERLESS_OCR_MAX_IMAGE_PIXELS
|
||||
value: {{ .Values.config.ocr.maxImagePixels | quote }}
|
||||
{{- end }}
|
||||
{{- if ne .Values.config.ocr.userArgs "{}" }}
|
||||
- name: PAPERLESS_OCR_USER_ARGS
|
||||
value: {{ .Values.config.ocr.userArgs | quote }}
|
||||
{{- end }}
|
||||
|
||||
# Time and locale
|
||||
- name: PAPERLESS_TIME_ZONE
|
||||
value: {{ .Values.config.timeZone | quote }}
|
||||
|
||||
# Consumer settings
|
||||
- name: PAPERLESS_CONSUMER_RECURSIVE
|
||||
value: {{ .Values.config.consumer.recursive | quote }}
|
||||
- name: PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS
|
||||
value: {{ .Values.config.consumer.subdirsAsTags | quote }}
|
||||
- name: PAPERLESS_CONSUMER_DELETE_DUPLICATES
|
||||
value: {{ .Values.config.consumer.deleteDocumentDuplicates | quote }}
|
||||
- name: PAPERLESS_CONSUMER_IGNORE_PATTERNS
|
||||
value: {{ .Values.config.consumer.ignorePatterns | quote }}
|
||||
- name: PAPERLESS_CONSUMER_BARCODE_SCANNER
|
||||
value: {{ .Values.config.consumer.barcodeScanner | quote }}
|
||||
|
||||
# Barcode settings
|
||||
{{- if .Values.config.consumer.barcodes.enabled }}
|
||||
- name: PAPERLESS_CONSUMER_ENABLE_BARCODES
|
||||
value: "true"
|
||||
- name: PAPERLESS_CONSUMER_BARCODE_TIFF_SUPPORT
|
||||
value: {{ .Values.config.consumer.barcodes.tiffSupport | quote }}
|
||||
- name: PAPERLESS_CONSUMER_BARCODE_STRING
|
||||
value: {{ .Values.config.consumer.barcodes.string | quote }}
|
||||
- name: PAPERLESS_CONSUMER_BARCODE_RETAIN_SPLIT_PAGES
|
||||
value: {{ .Values.config.consumer.barcodes.retainSplitPages | quote }}
|
||||
{{- if ne (.Values.config.consumer.barcodes.upscale | float64) 0.0 }}
|
||||
- name: PAPERLESS_CONSUMER_BARCODE_UPSCALE
|
||||
value: {{ .Values.config.consumer.barcodes.upscale | quote }}
|
||||
{{- end }}
|
||||
- name: PAPERLESS_CONSUMER_BARCODE_DPI
|
||||
value: {{ .Values.config.consumer.barcodes.dpi | quote }}
|
||||
{{- if ne (.Values.config.consumer.barcodes.maxPages | int) 0 }}
|
||||
- name: PAPERLESS_CONSUMER_BARCODE_MAX_PAGES
|
||||
value: {{ .Values.config.consumer.barcodes.maxPages | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
# ASN barcode settings
|
||||
{{- if .Values.config.consumer.barcodes.asnEnabled }}
|
||||
- name: PAPERLESS_CONSUMER_ENABLE_ASN_BARCODE
|
||||
value: "true"
|
||||
- name: PAPERLESS_CONSUMER_ASN_BARCODE_PREFIX
|
||||
value: {{ .Values.config.consumer.barcodes.asnPrefix | quote }}
|
||||
{{- end }}
|
||||
|
||||
# Tag barcode settings
|
||||
{{- if .Values.config.consumer.barcodes.tagEnabled }}
|
||||
- name: PAPERLESS_CONSUMER_ENABLE_TAG_BARCODE
|
||||
value: "true"
|
||||
- name: PAPERLESS_CONSUMER_TAG_BARCODE_MAPPING
|
||||
value: {{ .Values.config.consumer.barcodes.tagMapping | quote }}
|
||||
{{- end }}
|
||||
|
||||
# Tika settings
|
||||
{{- if .Values.config.tika.enabled }}
|
||||
- name: PAPERLESS_TIKA_ENABLED
|
||||
value: "true"
|
||||
- name: PAPERLESS_TIKA_ENDPOINT
|
||||
value: {{ .Values.config.tika.endpoint | quote }}
|
||||
- name: PAPERLESS_TIKA_GOTENBERG_ENDPOINT
|
||||
value: {{ .Values.config.tika.gotenbergEndpoint | quote }}
|
||||
{{- end }}
|
||||
|
||||
# Admin user
|
||||
{{- if .Values.config.admin.user }}
|
||||
- name: PAPERLESS_ADMIN_USER
|
||||
value: {{ .Values.config.admin.user | quote }}
|
||||
- name: PAPERLESS_ADMIN_MAIL
|
||||
value: {{ .Values.config.admin.email | quote }}
|
||||
- name: PAPERLESS_ADMIN_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.admin.existingSecret | default (printf "%s-secrets" (include "paperless-ngx.fullname" .)) }}
|
||||
key: {{ .Values.config.admin.passwordKey | default "admin-password" }}
|
||||
{{- end }}
|
||||
|
||||
# Email settings
|
||||
{{- if .Values.config.email.host }}
|
||||
- name: PAPERLESS_EMAIL_HOST
|
||||
value: {{ .Values.config.email.host | quote }}
|
||||
- name: PAPERLESS_EMAIL_PORT
|
||||
value: {{ .Values.config.email.port | quote }}
|
||||
{{- if .Values.config.email.user }}
|
||||
- name: PAPERLESS_EMAIL_HOST_USER
|
||||
value: {{ .Values.config.email.user | quote }}
|
||||
- name: PAPERLESS_EMAIL_HOST_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.email.existingSecret | default (printf "%s-secrets" (include "paperless-ngx.fullname" .)) }}
|
||||
key: {{ .Values.config.email.passwordKey | default "email-password" }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.email.from }}
|
||||
- name: PAPERLESS_EMAIL_FROM
|
||||
value: {{ .Values.config.email.from | quote }}
|
||||
{{- end }}
|
||||
- name: PAPERLESS_EMAIL_USE_TLS
|
||||
value: {{ .Values.config.email.useTls | quote }}
|
||||
- name: PAPERLESS_EMAIL_USE_SSL
|
||||
value: {{ .Values.config.email.useSsl | quote }}
|
||||
{{- end }}
|
||||
|
||||
# Task processing
|
||||
- name: PAPERLESS_TASK_WORKERS
|
||||
value: {{ .Values.config.taskWorkers | quote }}
|
||||
- name: PAPERLESS_THREADS_PER_WORKER
|
||||
value: {{ .Values.config.threadsPerWorker | quote }}
|
||||
- name: PAPERLESS_WORKER_TIMEOUT
|
||||
value: {{ .Values.config.workerTimeout | quote }}
|
||||
|
||||
# Advanced settings
|
||||
- name: PAPERLESS_ENABLE_NLTK
|
||||
value: {{ .Values.config.enableNltk | quote }}
|
||||
{{- if .Values.config.filenameFormat }}
|
||||
- name: PAPERLESS_FILENAME_FORMAT
|
||||
value: {{ .Values.config.filenameFormat | quote }}
|
||||
- name: PAPERLESS_FILENAME_FORMAT_REMOVE_NONE
|
||||
value: {{ .Values.config.filenameFormatRemoveNone | quote }}
|
||||
{{- end }}
|
||||
{{- if ne (.Values.config.convertMemoryLimit | int) 0 }}
|
||||
- name: PAPERLESS_CONVERT_MEMORY_LIMIT
|
||||
value: {{ .Values.config.convertMemoryLimit | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.convertTmpDir }}
|
||||
- name: PAPERLESS_CONVERT_TMPDIR
|
||||
value: {{ .Values.config.convertTmpDir | quote }}
|
||||
{{- end }}
|
||||
{{- if ne (.Values.config.maxImagePixels | int) 0 }}
|
||||
- name: PAPERLESS_MAX_IMAGE_PIXELS
|
||||
value: {{ .Values.config.maxImagePixels | quote }}
|
||||
{{- end }}
|
||||
|
||||
# Custom environment variables
|
||||
{{- range .Values.env }}
|
||||
- name: {{ .name }}
|
||||
value: {{ .value | quote }}
|
||||
{{- end }}
|
||||
{{- with .Values.extraEnv }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
{{- with .Values.extraEnvFrom }}
|
||||
envFrom:
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
volumeMounts:
|
||||
- name: data
|
||||
mountPath: /usr/src/paperless/data
|
||||
- name: media
|
||||
mountPath: /usr/src/paperless/media
|
||||
- name: export
|
||||
mountPath: /usr/src/paperless/export
|
||||
- name: consume
|
||||
mountPath: /usr/src/paperless/consume
|
||||
{{- with .Values.extraVolumeMounts }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
resources:
|
||||
{{- toYaml .Values.resources | nindent 12 }}
|
||||
volumes:
|
||||
{{- if .Values.persistence.data.enabled }}
|
||||
- name: data
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ if .Values.persistence.data.existingClaim }}{{ .Values.persistence.data.existingClaim }}{{ else }}{{ include "paperless-ngx.fullname" . }}-data{{ end }}
|
||||
{{- else }}
|
||||
- name: data
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
{{- if .Values.persistence.media.enabled }}
|
||||
- name: media
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ if .Values.persistence.media.existingClaim }}{{ .Values.persistence.media.existingClaim }}{{ else }}{{ include "paperless-ngx.fullname" . }}-media{{ end }}
|
||||
{{- else }}
|
||||
- name: media
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
{{- if .Values.persistence.export.enabled }}
|
||||
- name: export
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ if .Values.persistence.export.existingClaim }}{{ .Values.persistence.export.existingClaim }}{{ else }}{{ include "paperless-ngx.fullname" . }}-export{{ end }}
|
||||
{{- else }}
|
||||
- name: export
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
{{- if .Values.persistence.consume.enabled }}
|
||||
- name: consume
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ if .Values.persistence.consume.existingClaim }}{{ .Values.persistence.consume.existingClaim }}{{ else }}{{ include "paperless-ngx.fullname" . }}-consume{{ end }}
|
||||
{{- else }}
|
||||
- name: consume
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
{{- with .Values.extraVolumes }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.nodeSelector }}
|
||||
nodeSelector:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.affinity }}
|
||||
affinity:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.tolerations }}
|
||||
tolerations:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
43
charts/paperless-ngx/templates/ingress.yaml
Normal file
43
charts/paperless-ngx/templates/ingress.yaml
Normal file
@ -0,0 +1,43 @@
|
||||
{{- if .Values.ingress.enabled -}}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: {{ include "paperless-ngx.fullname" . }}
|
||||
labels:
|
||||
{{- include "paperless-ngx.labels" . | nindent 4 }}
|
||||
{{- with .Values.ingress.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- if .Values.ingress.className }}
|
||||
ingressClassName: {{ .Values.ingress.className }}
|
||||
{{- end }}
|
||||
{{- if .Values.ingress.tls }}
|
||||
tls:
|
||||
{{- range .Values.ingress.tls }}
|
||||
- hosts:
|
||||
{{- range .hosts }}
|
||||
- {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- if .secretName }}
|
||||
secretName: {{ .secretName }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
rules:
|
||||
{{- range .Values.ingress.hosts }}
|
||||
- host: {{ .host | quote }}
|
||||
http:
|
||||
paths:
|
||||
{{- range .paths }}
|
||||
- path: {{ .path }}
|
||||
pathType: {{ .pathType }}
|
||||
backend:
|
||||
service:
|
||||
name: {{ include "paperless-ngx.fullname" $ }}
|
||||
port:
|
||||
number: {{ $.Values.service.port }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
90
charts/paperless-ngx/templates/pvc.yaml
Normal file
90
charts/paperless-ngx/templates/pvc.yaml
Normal file
@ -0,0 +1,90 @@
|
||||
{{- if and .Values.persistence.data.enabled (not .Values.persistence.data.existingClaim) }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "paperless-ngx.fullname" . }}-data
|
||||
labels:
|
||||
{{- include "paperless-ngx.labels" . | nindent 4 }}
|
||||
{{- with .Values.persistence.data.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.data.accessMode | quote }}
|
||||
{{- if .Values.persistence.data.storageClass }}
|
||||
storageClassName: {{ .Values.persistence.data.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.data.size | quote }}
|
||||
---
|
||||
{{- end }}
|
||||
|
||||
{{- if and .Values.persistence.media.enabled (not .Values.persistence.media.existingClaim) }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "paperless-ngx.fullname" . }}-media
|
||||
labels:
|
||||
{{- include "paperless-ngx.labels" . | nindent 4 }}
|
||||
{{- with .Values.persistence.media.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.media.accessMode | quote }}
|
||||
{{- if .Values.persistence.media.storageClass }}
|
||||
storageClassName: {{ .Values.persistence.media.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.media.size | quote }}
|
||||
---
|
||||
{{- end }}
|
||||
|
||||
{{- if and .Values.persistence.export.enabled (not .Values.persistence.export.existingClaim) }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "paperless-ngx.fullname" . }}-export
|
||||
labels:
|
||||
{{- include "paperless-ngx.labels" . | nindent 4 }}
|
||||
{{- with .Values.persistence.export.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.export.accessMode | quote }}
|
||||
{{- if .Values.persistence.export.storageClass }}
|
||||
storageClassName: {{ .Values.persistence.export.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.export.size | quote }}
|
||||
---
|
||||
{{- end }}
|
||||
|
||||
{{- if and .Values.persistence.consume.enabled (not .Values.persistence.consume.existingClaim) }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "paperless-ngx.fullname" . }}-consume
|
||||
labels:
|
||||
{{- include "paperless-ngx.labels" . | nindent 4 }}
|
||||
{{- with .Values.persistence.consume.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.consume.accessMode | quote }}
|
||||
{{- if .Values.persistence.consume.storageClass }}
|
||||
storageClassName: {{ .Values.persistence.consume.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.consume.size | quote }}
|
||||
{{- end }}
|
||||
45
charts/paperless-ngx/templates/secret.yaml
Normal file
45
charts/paperless-ngx/templates/secret.yaml
Normal file
@ -0,0 +1,45 @@
|
||||
{{- $needsSecret := false -}}
|
||||
{{- if not .Values.config.secretKey.existingSecret -}}
|
||||
{{- $needsSecret = true -}}
|
||||
{{- end -}}
|
||||
{{- if not .Values.postgresql.external.existingSecret -}}
|
||||
{{- $needsSecret = true -}}
|
||||
{{- end -}}
|
||||
{{- if and .Values.redis.external.password (not .Values.redis.external.existingSecret) -}}
|
||||
{{- $needsSecret = true -}}
|
||||
{{- end -}}
|
||||
{{- if and .Values.config.admin.user (not .Values.config.admin.existingSecret) -}}
|
||||
{{- $needsSecret = true -}}
|
||||
{{- end -}}
|
||||
{{- if and .Values.config.email.host .Values.config.email.user (not .Values.config.email.existingSecret) -}}
|
||||
{{- $needsSecret = true -}}
|
||||
{{- end -}}
|
||||
|
||||
{{- if $needsSecret }}
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: {{ include "paperless-ngx.fullname" . }}-secrets
|
||||
labels:
|
||||
{{- include "paperless-ngx.labels" . | nindent 4 }}
|
||||
type: Opaque
|
||||
data:
|
||||
{{- if not .Values.config.secretKey.existingSecret }}
|
||||
{{ .Values.config.secretKey.secretKey | default "secret-key" }}: {{ .Values.config.secretKey.value | default "change-me-paperless-secret-key-at-least-32-characters-long" | b64enc }}
|
||||
{{- end }}
|
||||
{{- if not .Values.postgresql.external.existingSecret }}
|
||||
{{ .Values.postgresql.external.passwordKey | default "postgresql-password" }}: {{ .Values.postgresql.external.password | default "paperless" | b64enc }}
|
||||
{{- end }}
|
||||
{{- if and .Values.redis.external.password (not .Values.redis.external.existingSecret) }}
|
||||
{{ .Values.redis.external.passwordKey | default "redis-password" }}: {{ .Values.redis.external.password | b64enc }}
|
||||
{{ .Values.redis.external.urlKey | default "redis-url" }}: {{ include "paperless-ngx.redis.url.withPassword" . | b64enc }}
|
||||
{{- end }}
|
||||
{{- if and .Values.config.admin.user (not .Values.config.admin.existingSecret) }}
|
||||
{{ .Values.config.admin.userKey | default "admin-user" }}: {{ .Values.config.admin.user | b64enc }}
|
||||
{{ .Values.config.admin.passwordKey | default "admin-password" }}: {{ .Values.config.admin.password | default "changeme" | b64enc }}
|
||||
{{- end }}
|
||||
{{- if and .Values.config.email.host .Values.config.email.user (not .Values.config.email.existingSecret) }}
|
||||
{{ .Values.config.email.userKey | default "email-user" }}: {{ .Values.config.email.user | b64enc }}
|
||||
{{ .Values.config.email.passwordKey | default "email-password" }}: {{ .Values.config.email.password | default "" | b64enc }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
15
charts/paperless-ngx/templates/service.yaml
Normal file
15
charts/paperless-ngx/templates/service.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: {{ include "paperless-ngx.fullname" . }}
|
||||
labels:
|
||||
{{- include "paperless-ngx.labels" . | nindent 4 }}
|
||||
spec:
|
||||
type: {{ .Values.service.type }}
|
||||
ports:
|
||||
- port: {{ .Values.service.port }}
|
||||
targetPort: http
|
||||
protocol: TCP
|
||||
name: http
|
||||
selector:
|
||||
{{- include "paperless-ngx.selectorLabels" . | nindent 4 }}
|
||||
302
charts/paperless-ngx/values.yaml
Normal file
302
charts/paperless-ngx/values.yaml
Normal file
@ -0,0 +1,302 @@
|
||||
## Global settings
|
||||
nameOverride: ""
|
||||
fullnameOverride: ""
|
||||
|
||||
## Image settings
|
||||
image:
|
||||
repository: ghcr.io/paperless-ngx/paperless-ngx
|
||||
tag: "2.20.3"
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
## Deployment settings
|
||||
replicaCount: 1
|
||||
revisionHistoryLimit: 3
|
||||
|
||||
# Pod security settings
|
||||
# Note: Paperless-ngx uses s6-overlay which requires root access during initialization
|
||||
# The container will drop privileges after setup
|
||||
podSecurityContext:
|
||||
runAsNonRoot: false
|
||||
runAsUser: 0
|
||||
fsGroup: 1000
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
readOnlyRootFilesystem: false
|
||||
capabilities:
|
||||
drop:
|
||||
- ALL
|
||||
add:
|
||||
- CHOWN
|
||||
- DAC_OVERRIDE
|
||||
- FOWNER
|
||||
- SETGID
|
||||
- SETUID
|
||||
|
||||
## Pod scheduling
|
||||
nodeSelector: {}
|
||||
tolerations: []
|
||||
affinity: {}
|
||||
|
||||
## Service settings
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 8000
|
||||
|
||||
## Ingress settings
|
||||
ingress:
|
||||
enabled: false
|
||||
className: ""
|
||||
annotations:
|
||||
traefik.ingress.kubernetes.io/router.entrypoints: websecure
|
||||
hosts:
|
||||
- host: paperless.domain.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- paperless.domain.com
|
||||
# Optional: specify the name of an existing TLS secret
|
||||
# secretName: "existing-tls-secret"
|
||||
|
||||
## Persistence settings
|
||||
persistence:
|
||||
# Paperless data directory (search index, classification model, etc.)
|
||||
data:
|
||||
enabled: true
|
||||
existingClaim: ""
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 1Gi
|
||||
annotations: {}
|
||||
# Paperless media directory (documents and thumbnails)
|
||||
media:
|
||||
enabled: true
|
||||
existingClaim: ""
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 10Gi
|
||||
annotations: {}
|
||||
# Export directory (for exporting documents)
|
||||
export:
|
||||
enabled: true
|
||||
existingClaim: ""
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 1Gi
|
||||
annotations: {}
|
||||
# Consume directory (for importing documents)
|
||||
consume:
|
||||
enabled: true
|
||||
existingClaim: ""
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 5Gi
|
||||
annotations: {}
|
||||
|
||||
# Extra volume mounts
|
||||
extraVolumeMounts: []
|
||||
|
||||
# Extra volumes
|
||||
extraVolumes: []
|
||||
|
||||
## Resource limits and requests
|
||||
# resources:
|
||||
# limits:
|
||||
# cpu: 1000m
|
||||
# memory: 1Gi
|
||||
# requests:
|
||||
# cpu: 200m
|
||||
# memory: 512Mi
|
||||
|
||||
## Application health checks
|
||||
probes:
|
||||
liveness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 60
|
||||
periodSeconds: 10
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 6
|
||||
successThreshold: 1
|
||||
path: /
|
||||
readiness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 5
|
||||
timeoutSeconds: 3
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
path: /
|
||||
|
||||
## Autoscaling configuration
|
||||
autoscaling:
|
||||
enabled: false
|
||||
minReplicas: 1
|
||||
maxReplicas: 3
|
||||
targetCPUUtilizationPercentage: 80
|
||||
targetMemoryUtilizationPercentage: 80
|
||||
|
||||
## External Dependencies Configuration
|
||||
## These should point to external PostgreSQL and Redis services
|
||||
|
||||
# External PostgreSQL database configuration
|
||||
postgresql:
|
||||
# External PostgreSQL connection details
|
||||
external:
|
||||
enabled: true
|
||||
host: "postgresql.default.svc.cluster.local"
|
||||
port: 5432
|
||||
database: "paperless"
|
||||
username: "paperless"
|
||||
# Use existingSecret for credentials
|
||||
existingSecret: ""
|
||||
passwordKey: "postgresql-password"
|
||||
# Or set password directly (not recommended for production)
|
||||
password: ""
|
||||
|
||||
# External Redis configuration
|
||||
redis:
|
||||
external:
|
||||
enabled: true
|
||||
host: "redis.default.svc.cluster.local"
|
||||
port: 6379
|
||||
database: 0
|
||||
# Authentication (leave empty if Redis has no auth)
|
||||
username: "" # Optional: Redis username (Redis 6.0+)
|
||||
# Use existingSecret for credentials if Redis has auth
|
||||
# NOTE: When using existingSecret, the secret MUST contain a key with the full Redis URL
|
||||
# Format: redis://[username]:[password]@host:port/database
|
||||
existingSecret: ""
|
||||
urlKey: "redis-url" # Key in existingSecret containing the full Redis URL
|
||||
passwordKey: "redis-password" # Key in existingSecret for password (for compatibility)
|
||||
# Or set password directly (leave empty if no auth)
|
||||
# When using plain password, the full Redis URL will be auto-generated in the secret
|
||||
password: ""
|
||||
# Optional: Prefix for Redis keys and channels
|
||||
# Useful for sharing one Redis server among multiple Paperless instances
|
||||
prefix: ""
|
||||
|
||||
## Paperless-ngx Configuration
|
||||
config:
|
||||
# Basic server configuration
|
||||
url: "" # Set to your external URL, e.g., https://paperless.domain.com
|
||||
allowedHosts: "*" # Comma-separated list of allowed hosts
|
||||
csrfTrustedOrigins: "" # Comma-separated list of trusted origins
|
||||
corsAllowedHosts: "http://localhost:8000"
|
||||
forceScriptName: "" # For hosting under subpath, e.g., /paperless
|
||||
|
||||
# Security settings
|
||||
secretKey:
|
||||
# Use existingSecret for production
|
||||
existingSecret: ""
|
||||
secretKey: "secret-key"
|
||||
# Or set directly (not recommended for production)
|
||||
value: ""
|
||||
|
||||
# OCR Configuration
|
||||
ocr:
|
||||
language: "eng" # OCR language (3-letter code)
|
||||
mode: "skip" # skip, redo, or force
|
||||
skipArchiveFile: "never" # never, with_text, always
|
||||
clean: "clean" # clean, clean-final, none
|
||||
deskew: true
|
||||
rotatePages: true
|
||||
rotatePagesThreshold: 12
|
||||
outputType: "pdfa"
|
||||
pages: 0 # 0 = all pages
|
||||
imageDpi: 0 # 0 = auto
|
||||
maxImagePixels: 0 # 0 = use Pillow default
|
||||
userArgs: "{}" # JSON string of additional OCRmyPDF arguments
|
||||
|
||||
# Time and locale settings
|
||||
timeZone: "UTC"
|
||||
|
||||
# Consumer settings
|
||||
consumer:
|
||||
recursive: false
|
||||
subdirsAsTags: false
|
||||
deleteDocumentDuplicates: false
|
||||
ignorePatterns: '[".DS_Store", ".DS_STORE", "._*", ".stfolder/*", ".stversions/*", ".localized/*", "desktop.ini", "@eaDir/*", "Thumbs.db"]'
|
||||
barcodeScanner: "PYZBAR"
|
||||
|
||||
# Barcode processing
|
||||
barcodes:
|
||||
enabled: false
|
||||
tiffSupport: false
|
||||
string: "PATCHT"
|
||||
retainSplitPages: false
|
||||
upscale: 0.0
|
||||
dpi: 300
|
||||
maxPages: 0
|
||||
|
||||
# ASN barcode settings
|
||||
asnEnabled: false
|
||||
asnPrefix: "ASN"
|
||||
|
||||
# Tag barcode settings
|
||||
tagEnabled: false
|
||||
tagMapping: '{"TAG:(.*)": "\\g<1>"}'
|
||||
|
||||
# Optional Tika settings (for Office documents)
|
||||
tika:
|
||||
enabled: false
|
||||
endpoint: "http://tika:9998"
|
||||
gotenbergEndpoint: "http://gotenberg:3000"
|
||||
|
||||
# Admin user creation (optional)
|
||||
admin:
|
||||
user: "" # Set to create admin user on startup
|
||||
password: "" # Required if admin.user is set
|
||||
email: "root@localhost"
|
||||
|
||||
# Use existingSecret for credentials
|
||||
existingSecret: ""
|
||||
userKey: "admin-user"
|
||||
passwordKey: "admin-password"
|
||||
|
||||
# Email configuration (optional)
|
||||
email:
|
||||
host: ""
|
||||
port: 25
|
||||
user: ""
|
||||
password: ""
|
||||
from: ""
|
||||
useTls: false
|
||||
useSsl: false
|
||||
|
||||
# Use existingSecret for credentials
|
||||
existingSecret: ""
|
||||
userKey: "email-user"
|
||||
passwordKey: "email-password"
|
||||
|
||||
# Logging
|
||||
logging:
|
||||
dir: "" # Uses PAPERLESS_DATA_DIR/log/ if empty
|
||||
|
||||
# Task processing
|
||||
taskWorkers: 1
|
||||
threadsPerWorker: 1
|
||||
workerTimeout: 1800
|
||||
|
||||
# Advanced settings
|
||||
filenameFormat: ""
|
||||
filenameFormatRemoveNone: false
|
||||
enableNltk: true
|
||||
convertMemoryLimit: 0
|
||||
convertTmpDir: ""
|
||||
maxImagePixels: 0
|
||||
|
||||
# Environment variables
|
||||
env: []
|
||||
# Example additional env vars:
|
||||
# - name: PAPERLESS_ENABLE_HTTP_REMOTE_USER
|
||||
# value: "false"
|
||||
|
||||
# Extra environment variables from secrets
|
||||
extraEnvFrom: []
|
||||
# - secretRef:
|
||||
# name: paperless-extra-secrets
|
||||
|
||||
# Extra environment variables (for advanced use cases)
|
||||
extraEnv: []
|
||||
18
charts/qbittorrent-vpn/Chart.yaml
Normal file
18
charts/qbittorrent-vpn/Chart.yaml
Normal file
@ -0,0 +1,18 @@
|
||||
apiVersion: v2
|
||||
name: qbittorrent-vpn
|
||||
description: qBittorrent with Gluetun VPN sidecar for Kubernetes
|
||||
type: application
|
||||
version: 0.0.2
|
||||
appVersion: 5.1.0
|
||||
maintainers:
|
||||
- name: Richard Tomik
|
||||
email: richard.tomik@proton.me
|
||||
keywords:
|
||||
- qbittorrent
|
||||
- vpn
|
||||
- gluetun
|
||||
- torrent
|
||||
home: https://github.com/rtomik/helm-charts
|
||||
sources:
|
||||
- https://github.com/linuxserver/docker-qbittorrent
|
||||
- https://github.com/qdm12/gluetun
|
||||
38
charts/qbittorrent-vpn/NOTES.txt
Normal file
38
charts/qbittorrent-vpn/NOTES.txt
Normal file
@ -0,0 +1,38 @@
|
||||
Thank you for installing {{ .Chart.Name }}.
|
||||
|
||||
Your qBittorrent with VPN has been deployed successfully!
|
||||
|
||||
1. Get the application URL:
|
||||
{{- if .Values.ingress.enabled }}
|
||||
{{- range $host := .Values.ingress.hosts }}
|
||||
{{- range .paths }}
|
||||
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- else if contains "NodePort" .Values.service.type }}
|
||||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "qbittorrent-vpn.fullname" . }})
|
||||
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
|
||||
echo http://$NODE_IP:$NODE_PORT
|
||||
{{- else if contains "LoadBalancer" .Values.service.type }}
|
||||
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
|
||||
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "qbittorrent-vpn.fullname" . }}'
|
||||
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "qbittorrent-vpn.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
|
||||
echo http://$SERVICE_IP:{{ .Values.service.port }}
|
||||
{{- else if contains "ClusterIP" .Values.service.type }}
|
||||
kubectl port-forward --namespace {{ .Release.Namespace }} svc/{{ include "qbittorrent-vpn.fullname" . }} {{ .Values.service.port }}:{{ .Values.service.port }}
|
||||
Visit http://127.0.0.1:{{ .Values.service.port }} to access qBittorrent
|
||||
{{- end }}
|
||||
|
||||
2. VPN Status:
|
||||
To check the VPN connection status:
|
||||
kubectl exec -it -n {{ .Release.Namespace }} deployment/{{ include "qbittorrent-vpn.fullname" . }} -c gluetun -- curl -s http://localhost:8000/v1/vpn/status
|
||||
|
||||
3. Public IP:
|
||||
To check your current public IP through the VPN:
|
||||
kubectl exec -it -n {{ .Release.Namespace }} deployment/{{ include "qbittorrent-vpn.fullname" . }} -c gluetun -- curl -s http://localhost:8000/v1/publicip/ip
|
||||
|
||||
4. Verify qBittorrent:
|
||||
Make sure qBittorrent is functioning by accessing the Web UI at the URL in step 1.
|
||||
|
||||
For more information about this chart:
|
||||
https://github.com/rtomik/helm-charts/tree/main/charts/qbittorrent-vpn
|
||||
312
charts/qbittorrent-vpn/readme.md
Normal file
312
charts/qbittorrent-vpn/readme.md
Normal file
@ -0,0 +1,312 @@
|
||||
# qBittorrent with Gluetun VPN
|
||||
|
||||
A Helm chart for deploying qBittorrent with a Gluetun VPN sidecar container on Kubernetes.
|
||||
|
||||
## Introduction
|
||||
|
||||
This chart deploys [qBittorrent](https://www.qbittorrent.org/) alongside [Gluetun](https://github.com/qdm12/gluetun), a VPN client/tunnel in a container, to ensure all BitTorrent traffic is routed through the VPN. The chart supports all major VPN providers and protocols through Gluetun's comprehensive compatibility.
|
||||
|
||||
Source code can be found here:
|
||||
- https://github.com/rtomik/helm-charts/tree/main/charts/qbittorrent-vpn
|
||||
|
||||
Note: Currently only tested with NordVPN an OpenVPN configuration.
|
||||
|
||||
## Features
|
||||
|
||||
- **Multiple VPN Providers**: Support for 30+ VPN providers including NordVPN, ProtonVPN, Private Internet Access, ExpressVPN, Surfshark, Mullvad, and more
|
||||
- **Protocol Support**: Use OpenVPN or WireGuard based on your provider's capabilities
|
||||
- **Server Selection**: Choose servers by country, city, or specific hostnames with optional randomization
|
||||
- **Security**: Proper container security settings to ensure traffic only flows through the VPN
|
||||
- **Health Monitoring**: Integrated health checks for both qBittorrent and the VPN connection
|
||||
- **Persistence**: Separate volume storage for configuration and downloads
|
||||
- **Web UI**: Access qBittorrent via web interface with optional ingress support
|
||||
- **Proxy Services**: HTTP and Shadowsocks proxies for additional devices to use the VPN tunnel
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
- Helm 3.2.0+
|
||||
- PV provisioner support in the cluster
|
||||
- A valid subscription to a VPN service
|
||||
|
||||
## Installation
|
||||
|
||||
### Add the Repository
|
||||
|
||||
```bash
|
||||
helm repo add rtomik-charts https://rtomik.github.io/helm-charts
|
||||
helm repo update
|
||||
```
|
||||
|
||||
### Create a Secret for VPN Credentials
|
||||
|
||||
For better security, store your VPN credentials in a Kubernetes secret:
|
||||
|
||||
```bash
|
||||
# For OpenVPN authentication
|
||||
kubectl create secret generic vpn-credentials \
|
||||
--namespace default \
|
||||
--from-literal=username='your-vpn-username' \
|
||||
--from-literal=password='your-vpn-password'
|
||||
|
||||
# For WireGuard authentication (if using WireGuard)
|
||||
kubectl create secret generic wireguard-keys \
|
||||
--namespace default \
|
||||
--from-literal=private_key='your-wireguard-private-key'
|
||||
```
|
||||
|
||||
Then reference this secret in your values:
|
||||
|
||||
```yaml
|
||||
gluetun:
|
||||
credentials:
|
||||
create: false
|
||||
existingSecret: "vpn-credentials"
|
||||
usernameKey: "username"
|
||||
passwordKey: "password"
|
||||
```
|
||||
|
||||
### Install the Chart
|
||||
|
||||
```bash
|
||||
# Option 1: Installation with custom values file (recommended)
|
||||
helm install qbittorrent-vpn rtomik-charts/qbittorrent-vpn -f values.yaml -n media
|
||||
|
||||
# Option 2: Installation with inline parameter overrides
|
||||
helm install qbittorrent-vpn rtomik-charts/qbittorrent-vpn -n media \
|
||||
--set gluetun.vpn.provider=nordvpn \
|
||||
--set gluetun.vpn.serverCountries=Germany \
|
||||
--set-string gluetun.credentials.existingSecret=vpn-credentials
|
||||
```
|
||||
|
||||
## Uninstallation
|
||||
|
||||
```bash
|
||||
helm uninstall qbittorrent-vpn -n media
|
||||
```
|
||||
|
||||
Note: This will not delete Persistent Volume Claims. To delete them:
|
||||
|
||||
```bash
|
||||
kubectl delete pvc -l app.kubernetes.io/instance=qbittorrent-vpn
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
### Key Parameters
|
||||
|
||||
| Parameter | Description | Default |
|
||||
|---------------------------------------|-------------------------------------------------------|----------------------------|
|
||||
| `qbittorrent.image.repository` | qBittorrent image repository | `linuxserver/qbittorrent` |
|
||||
| `qbittorrent.image.tag` | qBittorrent image tag | `latest` |
|
||||
| `gluetun.image.repository` | Gluetun image repository | `qmcgaw/gluetun` |
|
||||
| `gluetun.image.tag` | Gluetun image tag | `v3.40.0` |
|
||||
| `gluetun.vpn.provider` | VPN provider name | `nordvpn` |
|
||||
| `gluetun.vpn.type` | VPN protocol (`openvpn` or `wireguard`) | `openvpn` |
|
||||
| `gluetun.vpn.serverCountries` | Countries to connect to (comma-separated) | `Germany` |
|
||||
| `persistence.config.size` | Size of PVC for qBittorrent config | `2Gi` |
|
||||
| `persistence.downloads.size` | Size of PVC for downloads | `100Gi` |
|
||||
| `ingress.enabled` | Enable ingress controller resource | `true` |
|
||||
| `ingress.hosts[0].host` | Hostname for the ingress | `qbittorrent.domain.com` |
|
||||
|
||||
For a complete list of parameters, see the [values.yaml](values.yaml) file.
|
||||
|
||||
### Example: Using with NordVPN
|
||||
|
||||
```yaml
|
||||
gluetun:
|
||||
vpn:
|
||||
provider: "nordvpn"
|
||||
type: "openvpn"
|
||||
serverCountries: "United States"
|
||||
openvpn:
|
||||
NORDVPN_CATEGORY: "P2P" # For torrent-optimized servers
|
||||
credentials:
|
||||
create: true
|
||||
username: "your-nordvpn-username"
|
||||
password: "your-nordvpn-password"
|
||||
```
|
||||
|
||||
### Example: Using with ProtonVPN
|
||||
|
||||
```yaml
|
||||
gluetun:
|
||||
vpn:
|
||||
provider: "protonvpn"
|
||||
type: "openvpn"
|
||||
serverCountries: "Switzerland"
|
||||
openvpn:
|
||||
PROTONVPN_TIER: "2" # 0 is free, 2 is paid (Plus/Visionary)
|
||||
SERVER_FEATURES: "p2p" # For torrent support
|
||||
credentials:
|
||||
create: true
|
||||
username: "protonvpn-username"
|
||||
password: "protonvpn-password"
|
||||
```
|
||||
|
||||
### Example: Using with Private Internet Access
|
||||
|
||||
```yaml
|
||||
gluetun:
|
||||
vpn:
|
||||
provider: "private internet access"
|
||||
type: "openvpn"
|
||||
serverCountries: "US"
|
||||
credentials:
|
||||
create: true
|
||||
username: "pia-username"
|
||||
password: "pia-password"
|
||||
settings:
|
||||
VPN_PORT_FORWARDING: "on" # PIA supports port forwarding
|
||||
```
|
||||
|
||||
## VPN Provider Support
|
||||
|
||||
This chart supports all VPN providers compatible with Gluetun, including:
|
||||
|
||||
- AirVPN
|
||||
- Cyberghost
|
||||
- ExpressVPN
|
||||
- FastestVPN
|
||||
- HideMyAss
|
||||
- IPVanish
|
||||
- IVPN
|
||||
- Mullvad
|
||||
- NordVPN
|
||||
- Perfect Privacy
|
||||
- Private Internet Access (PIA)
|
||||
- PrivateVPN
|
||||
- ProtonVPN
|
||||
- PureVPN
|
||||
- Surfshark
|
||||
- TorGuard
|
||||
- VyprVPN
|
||||
- WeVPN
|
||||
- Windscribe
|
||||
|
||||
For the complete list and provider-specific options, see the [Gluetun Providers Documentation](https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers).
|
||||
|
||||
## Additional Features
|
||||
|
||||
### Accessing the HTTP Proxy
|
||||
|
||||
Gluetun provides an HTTP proxy on port 8888 that can be used by other applications to route traffic through the VPN. To expose this proxy:
|
||||
|
||||
```yaml
|
||||
service:
|
||||
proxies:
|
||||
enabled: true
|
||||
httpPort: 8888
|
||||
socksPort: 8388
|
||||
```
|
||||
|
||||
### Firewall Settings
|
||||
|
||||
By default, the chart enables the Gluetun firewall to prevent leaks if the VPN connection drops. You can customize this:
|
||||
|
||||
```yaml
|
||||
gluetun:
|
||||
settings:
|
||||
FIREWALL: "on"
|
||||
FIREWALL_OUTBOUND_SUBNETS: "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
|
||||
```
|
||||
|
||||
### Port Forwarding
|
||||
|
||||
For VPN providers that support port forwarding (like PIA):
|
||||
|
||||
```yaml
|
||||
gluetun:
|
||||
settings:
|
||||
VPN_PORT_FORWARDING: "on"
|
||||
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
|
||||
|
||||
### VPN Connection Issues
|
||||
|
||||
If the VPN isn't connecting properly:
|
||||
|
||||
1. Check the Gluetun logs:
|
||||
```bash
|
||||
kubectl logs deployment/qbittorrent-vpn -c gluetun
|
||||
```
|
||||
|
||||
2. Verify your credentials are correct:
|
||||
```bash
|
||||
kubectl describe secret vpn-credentials
|
||||
```
|
||||
|
||||
3. Try setting the log level to debug for more detailed information:
|
||||
```yaml
|
||||
gluetun:
|
||||
extraEnv:
|
||||
- name: LOG_LEVEL
|
||||
value: "debug"
|
||||
```
|
||||
|
||||
### qBittorrent Can't Create Directories
|
||||
|
||||
If you see errors like "Could not create required directory":
|
||||
|
||||
1. Make sure the init container is enabled and properly configured
|
||||
2. Ensure proper `fsGroup` is set in the `podSecurityContext`
|
||||
3. Check that the persistence volume allows the correct permissions
|
||||
|
||||
### Firewall/Security Issues
|
||||
|
||||
If you encounter iptables or network issues:
|
||||
|
||||
1. Ensure the Gluetun container has `privileged: true`
|
||||
2. Verify the `NET_ADMIN` capability is added
|
||||
3. Check that the `/dev/net/tun` device is correctly mounted
|
||||
|
||||
## License
|
||||
|
||||
This chart is licensed under the MIT License.
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
- [Gluetun](https://github.com/qdm12/gluetun) by [qdm12](https://github.com/qdm12)
|
||||
- [LinuxServer.io](https://linuxserver.io/) for the qBittorrent container
|
||||
- The qBittorrent team for the excellent torrent client
|
||||
45
charts/qbittorrent-vpn/templates/_helpers.tpl
Normal file
45
charts/qbittorrent-vpn/templates/_helpers.tpl
Normal file
@ -0,0 +1,45 @@
|
||||
{{/*
|
||||
Expand the name of the chart.
|
||||
*/}}
|
||||
{{- define "qbittorrent-vpn.name" -}}
|
||||
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create a default fully qualified app name.
|
||||
*/}}
|
||||
{{- define "qbittorrent-vpn.fullname" -}}
|
||||
{{- if .Values.fullnameOverride }}
|
||||
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- else }}
|
||||
{{- $name := default .Chart.Name .Values.nameOverride }}
|
||||
{{- printf "%s" $name | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create chart name and version as used by the chart label.
|
||||
*/}}
|
||||
{{- define "qbittorrent-vpn.chart" -}}
|
||||
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Common labels
|
||||
*/}}
|
||||
{{- define "qbittorrent-vpn.labels" -}}
|
||||
helm.sh/chart: {{ include "qbittorrent-vpn.chart" . }}
|
||||
{{ include "qbittorrent-vpn.selectorLabels" . }}
|
||||
{{- if .Chart.AppVersion }}
|
||||
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
|
||||
{{- end }}
|
||||
app.kubernetes.io/managed-by: {{ .Release.Service }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Selector labels
|
||||
*/}}
|
||||
{{- define "qbittorrent-vpn.selectorLabels" -}}
|
||||
app.kubernetes.io/name: {{ include "qbittorrent-vpn.name" . }}
|
||||
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||
{{- end }}
|
||||
310
charts/qbittorrent-vpn/templates/deployment.yaml
Normal file
310
charts/qbittorrent-vpn/templates/deployment.yaml
Normal file
@ -0,0 +1,310 @@
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: {{ include "qbittorrent-vpn.fullname" . }}
|
||||
labels:
|
||||
{{- include "qbittorrent-vpn.labels" . | nindent 4 }}
|
||||
spec:
|
||||
replicas: {{ .Values.replicaCount }}
|
||||
revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
|
||||
selector:
|
||||
matchLabels:
|
||||
{{- include "qbittorrent-vpn.selectorLabels" . | nindent 6 }}
|
||||
strategy:
|
||||
type: Recreate # Using Recreate instead of RollingUpdate for stateful pods
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
{{- include "qbittorrent-vpn.selectorLabels" . | nindent 8 }}
|
||||
annotations:
|
||||
checksum/config: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
|
||||
{{- with .Values.podAnnotations }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
# Add hostNetwork if specified
|
||||
{{- if .Values.hostNetwork }}
|
||||
hostNetwork: {{ .Values.hostNetwork }}
|
||||
{{- end }}
|
||||
|
||||
# Init containers if needed for directory setup
|
||||
{{- if .Values.initContainers }}
|
||||
initContainers:
|
||||
{{- toYaml .Values.initContainers | nindent 8 }}
|
||||
{{- end }}
|
||||
|
||||
securityContext:
|
||||
{{- toYaml .Values.podSecurityContext | nindent 8 }}
|
||||
|
||||
containers:
|
||||
{{- if .Values.gluetun.enabled }}
|
||||
# Gluetun VPN container
|
||||
- name: gluetun
|
||||
image: "{{ .Values.gluetun.image.repository }}:{{ .Values.gluetun.image.tag }}"
|
||||
imagePullPolicy: {{ .Values.gluetun.image.pullPolicy }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.gluetun.securityContext | nindent 12 }}
|
||||
env:
|
||||
# VPN Provider selection - Common settings for all VPN types
|
||||
- name: VPN_SERVICE_PROVIDER
|
||||
value: {{ .Values.gluetun.vpn.provider | quote }}
|
||||
- name: VPN_TYPE
|
||||
value: {{ .Values.gluetun.vpn.type | quote }}
|
||||
- name: SERVER_COUNTRIES
|
||||
value: {{ .Values.gluetun.vpn.serverCountries | quote }}
|
||||
{{- if .Values.gluetun.vpn.serverNames }}
|
||||
- name: SERVER_HOSTNAMES
|
||||
value: {{ .Values.gluetun.vpn.serverNames | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.gluetun.vpn.serverCities }}
|
||||
- name: SERVER_CITIES
|
||||
value: {{ .Values.gluetun.vpn.serverCities | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.gluetun.vpn.randomize }}
|
||||
- name: SERVER_HOSTNAMES_RANDOMIZED
|
||||
value: {{ .Values.gluetun.vpn.randomize | quote }}
|
||||
{{- end }}
|
||||
|
||||
# OpenVPN specific configuration
|
||||
{{- if eq .Values.gluetun.vpn.type "openvpn" }}
|
||||
{{- if .Values.gluetun.credentials.create }}
|
||||
- name: OPENVPN_USER
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ include "qbittorrent-vpn.fullname" . }}-vpn-credentials
|
||||
key: {{ .Values.gluetun.credentials.usernameKey }}
|
||||
- name: OPENVPN_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ include "qbittorrent-vpn.fullname" . }}-vpn-credentials
|
||||
key: {{ .Values.gluetun.credentials.passwordKey }}
|
||||
{{- else if .Values.gluetun.credentials.existingSecret }}
|
||||
- name: OPENVPN_USER
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.gluetun.credentials.existingSecret }}
|
||||
key: {{ .Values.gluetun.credentials.usernameKey }}
|
||||
- name: OPENVPN_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.gluetun.credentials.existingSecret }}
|
||||
key: {{ .Values.gluetun.credentials.passwordKey }}
|
||||
{{- end }}
|
||||
|
||||
# Additional OpenVPN settings
|
||||
{{- with .Values.gluetun.vpn.openvpn }}
|
||||
{{- range $key, $value := . }}
|
||||
- name: {{ $key | upper }}
|
||||
value: {{ $value | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
# WireGuard specific configuration
|
||||
{{- if eq .Values.gluetun.vpn.type "wireguard" }}
|
||||
{{- if and .Values.gluetun.vpn.wireguard.privateKey .Values.gluetun.credentials.create }}
|
||||
- name: WIREGUARD_PRIVATE_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ include "qbittorrent-vpn.fullname" . }}-vpn-credentials
|
||||
key: wireguard_private_key
|
||||
{{- else if and .Values.gluetun.vpn.wireguard.privateKeyExistingSecret .Values.gluetun.vpn.wireguard.privateKeyExistingSecretKey }}
|
||||
- name: WIREGUARD_PRIVATE_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.gluetun.vpn.wireguard.privateKeyExistingSecret }}
|
||||
key: {{ .Values.gluetun.vpn.wireguard.privateKeyExistingSecretKey }}
|
||||
{{- end }}
|
||||
|
||||
# Additional WireGuard settings
|
||||
{{- with .Values.gluetun.vpn.wireguard }}
|
||||
{{- if .addresses }}
|
||||
- name: WIREGUARD_ADDRESSES
|
||||
value: {{ .addresses | quote }}
|
||||
{{- end }}
|
||||
{{- if .endpointIP }}
|
||||
- name: WIREGUARD_ENDPOINT_IP
|
||||
value: {{ .endpointIP | quote }}
|
||||
{{- end }}
|
||||
{{- if .endpointPort }}
|
||||
- name: WIREGUARD_ENDPOINT_PORT
|
||||
value: {{ .endpointPort | quote }}
|
||||
{{- end }}
|
||||
{{- if .publicKey }}
|
||||
- name: WIREGUARD_PUBLIC_KEY
|
||||
value: {{ .publicKey | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
# Gluetun general settings
|
||||
{{- with .Values.gluetun.settings }}
|
||||
{{- range $key, $value := . }}
|
||||
- name: {{ $key | upper }}
|
||||
value: {{ $value | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
# Extra environment variables
|
||||
{{- with .Values.gluetun.extraEnv }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
|
||||
ports:
|
||||
- name: control
|
||||
containerPort: 8000
|
||||
protocol: TCP
|
||||
- name: http-proxy
|
||||
containerPort: 8888
|
||||
protocol: TCP
|
||||
- name: shadowsocks-tcp
|
||||
containerPort: 8388
|
||||
protocol: TCP
|
||||
- name: shadowsocks-udp
|
||||
containerPort: 8388
|
||||
protocol: UDP
|
||||
{{- with .Values.gluetun.extraPorts }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
|
||||
volumeMounts:
|
||||
# Mount tun device for VPN
|
||||
- name: tun
|
||||
mountPath: /dev/net/tun
|
||||
{{- if .Values.gluetun.persistence.enabled }}
|
||||
- name: gluetun-config
|
||||
mountPath: /gluetun
|
||||
{{- end }}
|
||||
{{- with .Values.gluetun.extraVolumeMounts }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
|
||||
resources:
|
||||
{{- toYaml .Values.gluetun.resources | nindent 12 }}
|
||||
|
||||
{{- end }}
|
||||
|
||||
# qBittorrent container
|
||||
- name: qbittorrent
|
||||
image: "{{ .Values.qbittorrent.image.repository }}:{{ .Values.qbittorrent.image.tag }}"
|
||||
imagePullPolicy: {{ .Values.qbittorrent.image.pullPolicy }}
|
||||
{{- if .Values.qbittorrent.securityContext }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.qbittorrent.securityContext | nindent 12 }}
|
||||
{{- end }}
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: {{ .Values.qbittorrent.service.port }}
|
||||
protocol: TCP
|
||||
{{- if .Values.qbittorrent.bittorrentPort }}
|
||||
- name: bittorrent-tcp
|
||||
containerPort: {{ .Values.qbittorrent.bittorrentPort }}
|
||||
protocol: TCP
|
||||
- name: bittorrent-udp
|
||||
containerPort: {{ .Values.qbittorrent.bittorrentPort }}
|
||||
protocol: UDP
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.probes.liveness.enabled }}
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.liveness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.liveness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.liveness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.liveness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.liveness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.liveness.successThreshold }}
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.probes.readiness.enabled }}
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.readiness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.readiness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.readiness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.readiness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.readiness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.readiness.successThreshold }}
|
||||
{{- end }}
|
||||
|
||||
env:
|
||||
{{- range .Values.qbittorrent.env }}
|
||||
- name: {{ .name }}
|
||||
value: {{ .value | quote }}
|
||||
{{- end }}
|
||||
{{- with .Values.qbittorrent.extraEnv }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
|
||||
volumeMounts:
|
||||
{{- if .Values.qbittorrent.persistence.config.enabled }}
|
||||
- name: config
|
||||
mountPath: {{ .Values.qbittorrent.persistence.config.mountPath }}
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.qbittorrent.persistence.downloads.enabled }}
|
||||
- name: downloads
|
||||
mountPath: {{ .Values.qbittorrent.persistence.downloads.mountPath }}
|
||||
{{- end }}
|
||||
|
||||
{{- with .Values.qbittorrent.extraVolumeMounts }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
|
||||
resources:
|
||||
{{- toYaml .Values.qbittorrent.resources | nindent 12 }}
|
||||
|
||||
{{- with .Values.sidecars }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
|
||||
volumes:
|
||||
# Create /dev/net/tun as a device
|
||||
- name: tun
|
||||
hostPath:
|
||||
path: /dev/net/tun
|
||||
type: CharDevice
|
||||
|
||||
{{- if .Values.qbittorrent.persistence.config.enabled }}
|
||||
- name: config
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ if .Values.qbittorrent.persistence.config.existingClaim }}{{ .Values.qbittorrent.persistence.config.existingClaim }}{{ else }}{{ include "qbittorrent-vpn.fullname" . }}-config{{ end }}
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.qbittorrent.persistence.downloads.enabled }}
|
||||
- name: downloads
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ if .Values.qbittorrent.persistence.downloads.existingClaim }}{{ .Values.qbittorrent.persistence.downloads.existingClaim }}{{ else }}{{ include "qbittorrent-vpn.fullname" . }}-downloads{{ end }}
|
||||
{{- end }}
|
||||
|
||||
{{- if and .Values.gluetun.enabled .Values.gluetun.persistence.enabled }}
|
||||
{{- if .Values.gluetun.persistence.useEmptyDir }}
|
||||
- name: gluetun-config
|
||||
emptyDir: {}
|
||||
{{- else }}
|
||||
- name: gluetun-config
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ if .Values.gluetun.persistence.existingClaim }}{{ .Values.gluetun.persistence.existingClaim }}{{ else }}{{ include "qbittorrent-vpn.fullname" . }}-gluetun{{ end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{- with .Values.extraVolumes }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
|
||||
{{- with .Values.nodeSelector }}
|
||||
nodeSelector:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
|
||||
{{- with .Values.affinity }}
|
||||
affinity:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
|
||||
{{- with .Values.tolerations }}
|
||||
tolerations:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
43
charts/qbittorrent-vpn/templates/ingress.yaml
Normal file
43
charts/qbittorrent-vpn/templates/ingress.yaml
Normal file
@ -0,0 +1,43 @@
|
||||
{{- if .Values.ingress.enabled -}}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: {{ include "qbittorrent-vpn.fullname" . }}
|
||||
labels:
|
||||
{{- include "qbittorrent-vpn.labels" . | nindent 4 }}
|
||||
{{- with .Values.ingress.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- if .Values.ingress.className }}
|
||||
ingressClassName: {{ .Values.ingress.className }}
|
||||
{{- end }}
|
||||
{{- if .Values.ingress.tls }}
|
||||
tls:
|
||||
{{- range .Values.ingress.tls }}
|
||||
- hosts:
|
||||
{{- range .hosts }}
|
||||
- {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- if .secretName }}
|
||||
secretName: {{ .secretName }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
rules:
|
||||
{{- range .Values.ingress.hosts }}
|
||||
- host: {{ .host | quote }}
|
||||
http:
|
||||
paths:
|
||||
{{- range .paths }}
|
||||
- path: {{ .path }}
|
||||
pathType: {{ .pathType }}
|
||||
backend:
|
||||
service:
|
||||
name: {{ include "qbittorrent-vpn.fullname" $ }}
|
||||
port:
|
||||
number: {{ $.Values.service.port }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
55
charts/qbittorrent-vpn/templates/pvc.yaml
Normal file
55
charts/qbittorrent-vpn/templates/pvc.yaml
Normal file
@ -0,0 +1,55 @@
|
||||
{{- if and .Values.qbittorrent.persistence.config.enabled (not .Values.qbittorrent.persistence.config.existingClaim) }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "qbittorrent-vpn.fullname" . }}-config
|
||||
labels:
|
||||
{{- include "qbittorrent-vpn.labels" . | nindent 4 }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.qbittorrent.persistence.config.accessMode | quote }}
|
||||
{{- if .Values.qbittorrent.persistence.config.storageClass }}
|
||||
storageClassName: {{ .Values.qbittorrent.persistence.config.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.qbittorrent.persistence.config.size | quote }}
|
||||
{{- end }}
|
||||
|
||||
{{- if and .Values.qbittorrent.persistence.downloads.enabled (not .Values.qbittorrent.persistence.downloads.existingClaim) }}
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "qbittorrent-vpn.fullname" . }}-downloads
|
||||
labels:
|
||||
{{- include "qbittorrent-vpn.labels" . | nindent 4 }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.qbittorrent.persistence.downloads.accessMode | quote }}
|
||||
{{- if .Values.qbittorrent.persistence.downloads.storageClass }}
|
||||
storageClassName: {{ .Values.qbittorrent.persistence.downloads.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.qbittorrent.persistence.downloads.size | quote }}
|
||||
{{- end }}
|
||||
|
||||
{{- if and .Values.gluetun.enabled .Values.gluetun.persistence.enabled (not .Values.gluetun.persistence.useEmptyDir) (not .Values.gluetun.persistence.existingClaim) }}
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "qbittorrent-vpn.fullname" . }}-gluetun
|
||||
labels:
|
||||
{{- include "qbittorrent-vpn.labels" . | nindent 4 }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.gluetun.persistence.accessMode | quote }}
|
||||
{{- if .Values.gluetun.persistence.storageClass }}
|
||||
storageClassName: {{ .Values.gluetun.persistence.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.gluetun.persistence.size | quote }}
|
||||
{{- end }}
|
||||
18
charts/qbittorrent-vpn/templates/secret.yaml
Normal file
18
charts/qbittorrent-vpn/templates/secret.yaml
Normal file
@ -0,0 +1,18 @@
|
||||
{{- if and .Values.gluetun.enabled .Values.gluetun.credentials.create }}
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: {{ include "qbittorrent-vpn.fullname" . }}-vpn-credentials
|
||||
labels:
|
||||
{{- include "qbittorrent-vpn.labels" . | nindent 4 }}
|
||||
type: Opaque
|
||||
data:
|
||||
{{- if eq .Values.gluetun.vpn.type "openvpn" }}
|
||||
{{ .Values.gluetun.credentials.usernameKey }}: {{ .Values.gluetun.credentials.username | b64enc | quote }}
|
||||
{{ .Values.gluetun.credentials.passwordKey }}: {{ .Values.gluetun.credentials.password | b64enc | quote }}
|
||||
{{- end }}
|
||||
|
||||
{{- if and (eq .Values.gluetun.vpn.type "wireguard") .Values.gluetun.vpn.wireguard.privateKey }}
|
||||
wireguard_private_key: {{ .Values.gluetun.vpn.wireguard.privateKey | b64enc | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
15
charts/qbittorrent-vpn/templates/service.yaml
Normal file
15
charts/qbittorrent-vpn/templates/service.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: {{ include "qbittorrent-vpn.fullname" . }}
|
||||
labels:
|
||||
{{- include "qbittorrent-vpn.labels" . | nindent 4 }}
|
||||
spec:
|
||||
type: {{ .Values.service.type }}
|
||||
ports:
|
||||
- port: {{ .Values.service.port }}
|
||||
targetPort: http
|
||||
protocol: TCP
|
||||
name: http
|
||||
selector:
|
||||
{{- include "qbittorrent-vpn.selectorLabels" . | nindent 4 }}
|
||||
245
charts/qbittorrent-vpn/values.yaml
Normal file
245
charts/qbittorrent-vpn/values.yaml
Normal file
@ -0,0 +1,245 @@
|
||||
## Global settings
|
||||
nameOverride: ""
|
||||
fullnameOverride: ""
|
||||
|
||||
## Deployment settings
|
||||
replicaCount: 1
|
||||
revisionHistoryLimit: 3
|
||||
|
||||
## Pod security settings
|
||||
podSecurityContext:
|
||||
runAsNonRoot: false
|
||||
runAsUser: 0 # Run all containers as root
|
||||
fsGroup: 0 # Use root group for volumes
|
||||
|
||||
## qBittorrent Image settings
|
||||
qbittorrent:
|
||||
image:
|
||||
repository: linuxserver/qbittorrent
|
||||
tag: 5.1.0
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
securityContext: {}
|
||||
|
||||
# Open port for BitTorrent traffic
|
||||
bittorrentPort: 6881
|
||||
|
||||
env:
|
||||
- name: PUID
|
||||
value: "0" # Run as root
|
||||
- name: PGID
|
||||
value: "0" # Root group
|
||||
- name: TZ
|
||||
value: "UTC"
|
||||
- name: WEBUI_PORT
|
||||
value: "8080"
|
||||
|
||||
|
||||
extraEnv: []
|
||||
|
||||
service:
|
||||
port: 8080
|
||||
|
||||
#resources:
|
||||
# limits:
|
||||
# cpu: 1000m
|
||||
# memory: 2Gi
|
||||
# requests:
|
||||
# cpu: 200m
|
||||
# memory: 512Mi
|
||||
|
||||
persistence:
|
||||
config:
|
||||
enabled: true
|
||||
existingClaim: ""
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 2Gi
|
||||
mountPath: /config
|
||||
|
||||
downloads:
|
||||
enabled: true
|
||||
existingClaim: ""
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 2Gi
|
||||
mountPath: /downloads
|
||||
|
||||
# Volume mounts specific to qBittorrent
|
||||
extraVolumeMounts: []
|
||||
|
||||
# Volumes specific to qBittorrent
|
||||
extraVolumes: []
|
||||
|
||||
# Probes for qBittorrent
|
||||
probes:
|
||||
liveness:
|
||||
enabled: true
|
||||
path: /
|
||||
initialDelaySeconds: 0 # Startup probe handles delayed start
|
||||
periodSeconds: 30
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
|
||||
readiness:
|
||||
enabled: true
|
||||
path: /
|
||||
initialDelaySeconds: 0 # Startup probe handles delayed start
|
||||
periodSeconds: 10
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
|
||||
## Gluetun VPN settings
|
||||
gluetun:
|
||||
enabled: true
|
||||
image:
|
||||
repository: qmcgaw/gluetun
|
||||
tag: v3.40.0 # Latest version as of this writing
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
securityContext:
|
||||
privileged: true
|
||||
capabilities:
|
||||
add:
|
||||
- NET_ADMIN
|
||||
|
||||
# VPN provider configuration
|
||||
vpn:
|
||||
# Choose from: nordvpn, protonvpn, expressvpn, surfshark, mullvad, ivpn, private internet access, etc.
|
||||
provider: "nordvpn"
|
||||
|
||||
# Choose from: openvpn or wireguard
|
||||
type: "openvpn"
|
||||
|
||||
# Server selection (comma-separated lists)
|
||||
serverCountries: "Netherlands" # e.g., "Netherlands,Germany,Sweden"
|
||||
serverCities: "" # e.g., "Amsterdam,Frankfurt" (optional)
|
||||
serverNames: "" # e.g., "nl1,nl2" (optional)
|
||||
randomize: "true" # Randomize server selection
|
||||
|
||||
# OpenVPN specific settings (when type is "openvpn")
|
||||
openvpn:
|
||||
# Add any OpenVPN specific settings here, they'll be converted to env vars
|
||||
OPENVPN_PROTOCOL: "udp"
|
||||
|
||||
# WireGuard specific settings (when type is "wireguard")
|
||||
wireguard:
|
||||
privateKey: "" # Will be stored in Secret if provided
|
||||
privateKeyExistingSecret: ""
|
||||
privateKeyExistingSecretKey: ""
|
||||
addresses: "" # e.g., "10.64.222.21/32"
|
||||
endpointIP: "" # Optional: specify endpoint IP
|
||||
endpointPort: "" # Optional: specify endpoint port
|
||||
publicKey: "" # Optional: server public key
|
||||
|
||||
# VPN credentials (choose one method)
|
||||
credentials:
|
||||
create: true # set to false if using existing secret
|
||||
# For OpenVPN (normal credentials)
|
||||
username: ""
|
||||
password: ""
|
||||
# For WireGuard, the privateKey is specified in vpn.wireguard.privateKey
|
||||
|
||||
# Alternatively, reference an existing secret
|
||||
existingSecret: ""
|
||||
usernameKey: "username"
|
||||
passwordKey: "password"
|
||||
|
||||
# General Gluetun settings as environment variables
|
||||
settings:
|
||||
FIREWALL: "on"
|
||||
FIREWALL_OUTBOUND_SUBNETS: "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
|
||||
DNS_ADDRESS: "1.1.1.1"
|
||||
HEALTH_SERVER_PORT: "8000"
|
||||
|
||||
# Important: Add these settings to make networking work correctly with ingress
|
||||
SERVER_ALLOWLIST: "qbittorrent:8080" # Allow accessing qBittorrent container
|
||||
FIREWALL_INPUT_PORTS: "8080" # Allow ingress traffic to port 8080
|
||||
FIREWALL_DEBUG: "on" # Enable firewall debugging (temporarily)
|
||||
JOURNALD: "off" # Disable journald (not needed for debugging)
|
||||
|
||||
# Optional port forwarding
|
||||
VPN_PORT_FORWARDING: "off"
|
||||
|
||||
# Extra environment variables
|
||||
extraEnv:
|
||||
- name: LOG_LEVEL
|
||||
value: "info"
|
||||
|
||||
# Extra ports to expose
|
||||
extraPorts: []
|
||||
# - name: custom-port
|
||||
# containerPort: 9999
|
||||
# protocol: TCP
|
||||
|
||||
# Resources for Gluetun
|
||||
resources:
|
||||
limits:
|
||||
cpu: 300m
|
||||
memory: 256Mi
|
||||
requests:
|
||||
cpu: 100m
|
||||
memory: 128Mi
|
||||
|
||||
# Persistence for Gluetun
|
||||
persistence:
|
||||
enabled: true
|
||||
existingClaim: false
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 100Mi
|
||||
|
||||
# Volume mounts specific to Gluetun
|
||||
extraVolumeMounts: []
|
||||
|
||||
# Volumes specific to Gluetun
|
||||
extraVolumes: []
|
||||
|
||||
## Service settings
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 8080
|
||||
|
||||
## Ingress settings
|
||||
ingress:
|
||||
enabled: false
|
||||
className: ""
|
||||
annotations: []
|
||||
hosts:
|
||||
- host: qbittorrent.example.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- qbittorrent.example.com
|
||||
|
||||
# Additional specifications
|
||||
nodeSelector: {}
|
||||
tolerations: []
|
||||
affinity: {}
|
||||
podAnnotations: {}
|
||||
extraVolumes: []
|
||||
|
||||
# Temporary options for development/debugging
|
||||
hostNetwork: false
|
||||
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: []
|
||||
@ -1,8 +1,8 @@
|
||||
apiVersion: v2
|
||||
name: recipya
|
||||
description: A Helm chart for Recipya recipe manager application
|
||||
description: Recipya helm chart for Kubernetes
|
||||
type: application
|
||||
version: 0.0.1
|
||||
version: 0.0.2
|
||||
appVersion: "v1.2.2"
|
||||
maintainers:
|
||||
- name: Richard Tomik
|
||||
|
||||
@ -2,10 +2,15 @@
|
||||
|
||||
A Helm chart for deploying [Recipya](https://github.com/reaper47/recipya) on Kubernetes.
|
||||
|
||||
[Source Code](https://github.com/rtomik/helm-charts/tree/main/charts%2Frecipya)
|
||||
|
||||
## Introduction
|
||||
|
||||
This chart deploys Recipya recipe manager on a Kubernetes cluster using the Helm package manager.
|
||||
|
||||
Source code can be found here:
|
||||
- https://github.com/rtomik/helm-charts/tree/main/charts/recipya
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
@ -25,12 +30,28 @@ The command deploys Recipya on the Kubernetes cluster in the default configurati
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall/delete the `my-recipya` deployment:
|
||||
To uninstall/delete the `recipya` deployment:
|
||||
|
||||
```bash
|
||||
helm uninstall recipya -n recipya
|
||||
```
|
||||
|
||||
## Important Configuration Notes
|
||||
|
||||
### Server URL
|
||||
|
||||
When deploying with an ingress, it's **critical** to set `config.server.url` to match your ingress URL (including https if you're using TLS). This ensures that redirects after login work correctly:
|
||||
|
||||
```yaml
|
||||
config:
|
||||
server:
|
||||
url: "https://your-recipya-domain.com"
|
||||
```
|
||||
|
||||
### Ingress Configuration
|
||||
|
||||
This chart includes optimized ingress configurations for Traefik, with support for WebSockets and proper security headers. If you're using a different ingress controller, you may need to adjust annotations accordingly.
|
||||
|
||||
## Parameters
|
||||
|
||||
### Global parameters
|
||||
@ -48,24 +69,22 @@ helm uninstall recipya -n recipya
|
||||
| Name | Description | Value |
|
||||
|-----------------------------------------|--------------------------------------------------|-----------|
|
||||
| `podSecurityContext.fsGroup` | Group ID for the Recipya container | `1000` |
|
||||
| `containerSecurityContext.runAsUser` | User ID for the Recipya container | `1000` |
|
||||
| `containerSecurityContext.runAsGroup` | Group ID for the Recipya container | `1000` |
|
||||
| `containerSecurityContext.runAsNonRoot` | Run containers as non-root | `true` |
|
||||
| `containerSecurityContext` | Security context for the container | `{}` |
|
||||
|
||||
### Recipya configuration parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-----------------------------------------|-------------------------------------------------------|----------------|
|
||||
| `config.server.port` | Server port | `8078` |
|
||||
| `config.server.autologin` | Whether to login automatically | `false` |
|
||||
| `config.server.is_demo` | Whether the app is a demo version | `false` |
|
||||
| `config.server.is_prod` | Whether the app is in production | `false` |
|
||||
| `config.server.no_signups` | Whether to disable user account registrations | `false` |
|
||||
| `config.server.url` | Base URL for the application | `http://0.0.0.0` |
|
||||
| `config.email.address` | The email address for SendGrid | `""` |
|
||||
| `config.email.sendgrid` | SendGrid API key | `""` |
|
||||
| `config.documentIntelligence.endpoint` | Azure Document Intelligence endpoint | `""` |
|
||||
| `config.documentIntelligence.key` | Azure Document Intelligence key | `""` |
|
||||
| Name | Description | Value |
|
||||
|-----------------------------------------|-------------------------------------------------------|---------------------|
|
||||
| `config.server.port` | Server port | `8078` |
|
||||
| `config.server.autologin` | Whether to login automatically | `false` |
|
||||
| `config.server.is_demo` | Whether the app is a demo version | `false` |
|
||||
| `config.server.is_prod` | Whether the app is in production | `false` |
|
||||
| `config.server.no_signups` | Whether to disable user account registrations | `false` |
|
||||
| `config.server.url` | Base URL for the application | `http://0.0.0.0` |
|
||||
| `config.email.address` | The email address for SendGrid | `""` |
|
||||
| `config.email.sendgrid` | SendGrid API key | `""` |
|
||||
| `config.documentIntelligence.endpoint` | Azure Document Intelligence endpoint | `""` |
|
||||
| `config.documentIntelligence.key` | Azure Document Intelligence key | `""` |
|
||||
|
||||
### Service parameters
|
||||
|
||||
@ -76,30 +95,88 @@ helm uninstall recipya -n recipya
|
||||
|
||||
### Ingress parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------|--------------------------------------------------|-------------|
|
||||
| `ingress.enabled` | Enable ingress controller resource | `false` |
|
||||
| `ingress.className` | IngressClass that will be used | `""` |
|
||||
| `ingress.hosts[0].host` | Default host for the ingress resource | `chart-example.local` |
|
||||
| `ingress.tls` | Create TLS Secret | `[]` |
|
||||
| Name | Description | Value |
|
||||
|-------------------------------|--------------------------------------------------|------------------------|
|
||||
| `ingress.enabled` | Enable ingress controller resource | `false` |
|
||||
| `ingress.className` | IngressClass that will be used | `"traefik"` |
|
||||
| `ingress.annotations` | Additional ingress annotations | See values.yaml |
|
||||
| `ingress.hosts[0].host` | Default host for the ingress resource | `chart-example.local` |
|
||||
| `ingress.tls` | TLS configuration | `[]` |
|
||||
|
||||
### Persistence parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------------------|------------------------------------------|-----------|
|
||||
| `persistence.enabled` | Enable persistence using PVC | `true` |
|
||||
| `persistence.accessMode` | PVC Access Mode | `ReadWriteOnce` |
|
||||
| `persistence.size` | PVC Storage Request | `1Gi` |
|
||||
| `persistence.storageClass` | Storage class of backing PVC | `""` |
|
||||
| Name | Description | Value |
|
||||
|--------------------------------------|------------------------------------------|------------------|
|
||||
| `persistence.enabled` | Enable persistence using PVC | `true` |
|
||||
| `persistence.accessMode` | PVC Access Mode | `ReadWriteOnce` |
|
||||
| `persistence.size` | PVC Storage Request | `1Gi` |
|
||||
| `persistence.storageClass` | Storage class of backing PVC | `""` |
|
||||
|
||||
### Resource parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------|------------------------------------------|-----------|
|
||||
| `resources.limits.cpu` | CPU limit | `500m` |
|
||||
| `resources.limits.memory`| Memory limit | `512Mi` |
|
||||
| `resources.requests.cpu` | CPU request | `100m` |
|
||||
| `resources.requests.memory` | Memory request | `128Mi` |
|
||||
| Name | Description | Value |
|
||||
|-------------------------------|------------------------------------------|-----------|
|
||||
| `resources.limits.cpu` | CPU limit | `500m` |
|
||||
| `resources.limits.memory` | Memory limit | `512Mi` |
|
||||
| `resources.requests.cpu` | CPU request | `100m` |
|
||||
| `resources.requests.memory` | Memory request | `128Mi` |
|
||||
|
||||
### Probe parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------------------|--------------------------------------------|-----------|
|
||||
| `probes.liveness.enabled` | Enable liveness probe | `true` |
|
||||
| `probes.liveness.path` | Path for liveness probe | `/` |
|
||||
| `probes.readiness.enabled` | Enable readiness probe | `true` |
|
||||
| `probes.readiness.path` | Path for readiness probe | `/` |
|
||||
|
||||
## Traefik Ingress Configuration
|
||||
|
||||
The chart includes specially configured middlewares for Traefik to ensure proper functioning of Recipya:
|
||||
|
||||
```yaml
|
||||
ingress:
|
||||
enabled: true
|
||||
className: "traefik"
|
||||
annotations:
|
||||
traefik.ingress.kubernetes.io/router.entrypoints: websecure
|
||||
traefik.ingress.kubernetes.io/router.middlewares: recipya-recipya-headers@kubernetescrd
|
||||
traefik.ingress.kubernetes.io/service.sticky: "true"
|
||||
traefik.ingress.kubernetes.io/session-cookie-name: "recipya_session"
|
||||
hosts:
|
||||
- host: recipya.example.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: ImplementationSpecific
|
||||
tls:
|
||||
- hosts:
|
||||
- recipya.example.com
|
||||
```
|
||||
|
||||
This configuration includes:
|
||||
|
||||
1. Custom Content Security Policy allowing essential scripts from unpkg.com
|
||||
2. Sticky sessions for maintaining authentication
|
||||
3. Proper headers for proxy operation
|
||||
|
||||
## Content Security Policy Configuration
|
||||
|
||||
The chart includes a custom middleware that configures the proper Content Security Policy for Recipya. This is particularly important as the application requires access to external scripts from unpkg.com:
|
||||
|
||||
```yaml
|
||||
contentSecurityPolicy: >-
|
||||
default-src 'self';
|
||||
script-src 'self' 'unsafe-inline' 'unsafe-eval' blob: data: https://unpkg.com;
|
||||
style-src 'self' 'unsafe-inline';
|
||||
img-src 'self' data: blob:;
|
||||
font-src 'self' data:;
|
||||
connect-src 'self' ws: wss: *;
|
||||
worker-src 'self' blob:;
|
||||
frame-src 'self';
|
||||
media-src 'self' blob:;
|
||||
object-src 'none';
|
||||
form-action 'self';
|
||||
```
|
||||
|
||||
## Using Existing Secrets
|
||||
|
||||
|
||||
73
charts/recipya/templates/configmap-init-script.yaml
Normal file
73
charts/recipya/templates/configmap-init-script.yaml
Normal file
@ -0,0 +1,73 @@
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
name: {{ include "recipya.fullname" . }}-init-script
|
||||
labels:
|
||||
{{- include "recipya.labels" . | nindent 4 }}
|
||||
data:
|
||||
init.sh: |
|
||||
#!/bin/sh
|
||||
set -e
|
||||
|
||||
CONFIG_DIR="/home/recipya/.config/Recipya"
|
||||
CONFIG_FILE="$CONFIG_DIR/config.json"
|
||||
TARGET_PORT={{ .Values.config.server.port }}
|
||||
|
||||
echo "Starting initialization with port $TARGET_PORT..."
|
||||
|
||||
# Create directories if they don't exist
|
||||
mkdir -p $CONFIG_DIR/Backup
|
||||
mkdir -p $CONFIG_DIR/Database
|
||||
mkdir -p $CONFIG_DIR/Images
|
||||
mkdir -p $CONFIG_DIR/Logs
|
||||
mkdir -p $CONFIG_DIR/Videos
|
||||
|
||||
echo "Directories created."
|
||||
|
||||
# Create config.json if it doesn't exist or update the existing one
|
||||
if [ -f "$CONFIG_FILE" ]; then
|
||||
echo "Found existing config.json, updating port to $TARGET_PORT"
|
||||
# Use jq to modify the port in the existing config file
|
||||
TMP_FILE=$(mktemp)
|
||||
cat $CONFIG_FILE | jq ".server.port = $TARGET_PORT" > $TMP_FILE
|
||||
mv $TMP_FILE $CONFIG_FILE
|
||||
else
|
||||
echo "Creating new config.json with port $TARGET_PORT"
|
||||
# Create a new config.json with default values and the specified port
|
||||
cat > $CONFIG_FILE << EOF
|
||||
{
|
||||
"email": {
|
||||
"from": "{{ .Values.config.email.address | default "" }}",
|
||||
"sendGridAPIKey": "{{ .Values.config.email.sendgrid | default "" }}"
|
||||
},
|
||||
"integrations": {
|
||||
"azureDocumentIntelligence": {
|
||||
"endpoint": "{{ .Values.config.documentIntelligence.endpoint | default "" }}",
|
||||
"key": "{{ .Values.config.documentIntelligence.key | default "" }}"
|
||||
}
|
||||
},
|
||||
"server": {
|
||||
"autologin": {{ .Values.config.server.autologin }},
|
||||
"bypassGuide": false,
|
||||
"isDemo": {{ .Values.config.server.is_demo }},
|
||||
"noSignups": {{ .Values.config.server.no_signups }},
|
||||
"isProduction": {{ .Values.config.server.is_prod }},
|
||||
"port": $TARGET_PORT,
|
||||
"url": "{{ .Values.config.server.url }}"
|
||||
}
|
||||
}
|
||||
EOF
|
||||
fi
|
||||
|
||||
# Set permissions using numeric IDs
|
||||
echo "Setting permissions..."
|
||||
chmod -R 755 $CONFIG_DIR
|
||||
find $CONFIG_DIR -type f -exec chmod 644 {} \;
|
||||
find $CONFIG_DIR -type d -exec chmod 755 {} \;
|
||||
|
||||
# Change ownership by numeric ID
|
||||
echo "Changing ownership to 1000:1000..."
|
||||
chown -R 1000:1000 $CONFIG_DIR
|
||||
|
||||
echo "Configuration completed successfully."
|
||||
ls -la $CONFIG_DIR
|
||||
@ -1,77 +0,0 @@
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
name: {{ include "donetick.fullname" . }}-configmap
|
||||
labels:
|
||||
{{- include "donetick.labels" . | nindent 4 }}
|
||||
data:
|
||||
selfhosted.yaml: |
|
||||
name: {{ .Values.config.name | quote }}
|
||||
is_done_tick_dot_com: {{ .Values.config.is_done_tick_dot_com }}
|
||||
is_user_creation_disabled: {{ .Values.config.is_user_creation_disabled }}
|
||||
telegram:
|
||||
token: {{ .Values.config.telegram.token | default "" | quote }}
|
||||
pushover:
|
||||
token: {{ .Values.config.pushover.token | default "" | quote }}
|
||||
database:
|
||||
type: {{ .Values.config.database.type | default "sqlite" | quote }}
|
||||
migration: {{ .Values.config.database.migration }}
|
||||
{{- if .Values.config.database.migration_skip }}
|
||||
migration_skip: {{ .Values.config.database.migration_skip }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.database.migration_retry }}
|
||||
migration_retry: {{ .Values.config.database.migration_retry }}
|
||||
{{- end }}
|
||||
{{- if eq .Values.config.database.type "postgres" }}
|
||||
{{- if not .Values.config.database.existingSecret }}
|
||||
host: {{ .Values.config.database.host | quote }}
|
||||
port: {{ .Values.config.database.port }}
|
||||
user: {{ .Values.config.database.user | quote }}
|
||||
password: {{ .Values.config.database.password | quote }}
|
||||
name: {{ .Values.config.database.name | quote }}
|
||||
{{- else }}
|
||||
# Database credentials will be injected via environment variables from Secret
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
jwt:
|
||||
{{- if .Values.config.jwt.existingSecret }}
|
||||
# Secret will be injected from Secret
|
||||
{{- else }}
|
||||
secret: {{ .Values.config.jwt.secret | quote }}
|
||||
{{- end }}
|
||||
session_time: {{ .Values.config.jwt.session_time | quote }}
|
||||
max_refresh: {{ .Values.config.jwt.max_refresh | quote }}
|
||||
server:
|
||||
port: {{ .Values.config.server.port }}
|
||||
read_timeout: {{ .Values.config.server.read_timeout | quote }}
|
||||
write_timeout: {{ .Values.config.server.write_timeout | quote }}
|
||||
rate_period: {{ .Values.config.server.rate_period | quote }}
|
||||
rate_limit: {{ .Values.config.server.rate_limit }}
|
||||
cors_allow_origins:
|
||||
{{- range .Values.config.server.cors_allow_origins }}
|
||||
- {{ . | quote }}
|
||||
{{- end }}
|
||||
serve_frontend: {{ .Values.config.server.serve_frontend }}
|
||||
scheduler_jobs:
|
||||
due_job: {{ .Values.config.scheduler_jobs.due_job | quote }}
|
||||
overdue_job: {{ .Values.config.scheduler_jobs.overdue_job | quote }}
|
||||
pre_due_job: {{ .Values.config.scheduler_jobs.pre_due_job | quote }}
|
||||
email:
|
||||
host: {{ .Values.config.email.host | default "" | quote }}
|
||||
port: {{ .Values.config.email.port | default "" | quote }}
|
||||
key: {{ .Values.config.email.key | default "" | quote }}
|
||||
email: {{ .Values.config.email.email | default "" | quote }}
|
||||
appHost: {{ .Values.config.email.appHost | default "" | quote }}
|
||||
oauth2:
|
||||
{{- if .Values.config.oauth2.existingSecret }}
|
||||
client_id: $DT_OAUTH2_CLIENT_ID
|
||||
client_secret: $DT_OAUTH2_CLIENT_SECRET
|
||||
{{- else }}
|
||||
client_id: {{ .Values.config.oauth2.client_id | default "" | quote }}
|
||||
client_secret: {{ .Values.config.oauth2.client_secret | default "" | quote }}
|
||||
{{- end }}
|
||||
auth_url: {{ .Values.config.oauth2.auth_url | default "" | quote }}
|
||||
token_url: {{ .Values.config.oauth2.token_url | default "" | quote }}
|
||||
user_info_url: {{ .Values.config.oauth2.user_info_url | default "" | quote }}
|
||||
redirect_url: {{ .Values.config.oauth2.redirect_url | default "" | quote }}
|
||||
name: {{ .Values.config.oauth2.name | default "" | quote }}
|
||||
@ -5,8 +5,8 @@ metadata:
|
||||
labels:
|
||||
{{- include "recipya.labels" . | nindent 4 }}
|
||||
annotations:
|
||||
checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }}
|
||||
checksum/secret: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
|
||||
checksum/init-script: {{ include (print $.Template.BasePath "/configmap-init-script.yaml") . | sha256sum }}
|
||||
spec:
|
||||
replicas: {{ .Values.replicaCount }}
|
||||
revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
|
||||
@ -31,12 +31,48 @@ spec:
|
||||
imagePullSecrets:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
# Set security context for the pod
|
||||
securityContext:
|
||||
{{- toYaml .Values.podSecurityContext | nindent 8 }}
|
||||
fsGroup: 1000
|
||||
|
||||
# Init container to configure the application
|
||||
initContainers:
|
||||
- name: init-config
|
||||
image: alpine:3.18
|
||||
command: ["/bin/sh", "-c"]
|
||||
args:
|
||||
- |
|
||||
echo "Installing jq..."
|
||||
apk add --no-cache jq
|
||||
echo "Running initialization script..."
|
||||
/scripts/init.sh
|
||||
securityContext:
|
||||
runAsUser: 0 # Run as root to modify config files
|
||||
runAsGroup: 0
|
||||
volumeMounts:
|
||||
- name: data
|
||||
mountPath: /home/recipya/.config/Recipya
|
||||
- name: init-script
|
||||
mountPath: /scripts
|
||||
resources:
|
||||
requests:
|
||||
cpu: 50m
|
||||
memory: 64Mi
|
||||
limits:
|
||||
cpu: 100m
|
||||
memory: 128Mi
|
||||
|
||||
# Main application container
|
||||
containers:
|
||||
- name: {{ .Chart.Name }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.containerSecurityContext | nindent 12 }}
|
||||
runAsUser: 1000
|
||||
runAsGroup: 1000
|
||||
runAsNonRoot: true
|
||||
readOnlyRootFilesystem: false
|
||||
capabilities:
|
||||
drop:
|
||||
- ALL
|
||||
image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
|
||||
imagePullPolicy: {{ .Values.image.pullPolicy }}
|
||||
{{- if .Values.startupArgs }}
|
||||
@ -47,7 +83,7 @@ spec:
|
||||
{{- end }}
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: {{ .Values.config.server.port }}
|
||||
containerPort: {{ .Values.service.port }}
|
||||
protocol: TCP
|
||||
{{- if .Values.probes.liveness.enabled }}
|
||||
livenessProbe:
|
||||
@ -72,8 +108,9 @@ spec:
|
||||
successThreshold: {{ .Values.probes.readiness.successThreshold }}
|
||||
{{- end }}
|
||||
env:
|
||||
- name: RECIPYA_SERVER_PORT
|
||||
value: {{ .Values.config.server.port | quote }}
|
||||
# Critical environment variables for proper directory structure
|
||||
- name: HOME
|
||||
value: "/home/recipya"
|
||||
- name: RECIPYA_SERVER_URL
|
||||
value: {{ .Values.config.server.url | quote }}
|
||||
- name: RECIPYA_SERVER_AUTOLOGIN
|
||||
@ -97,16 +134,22 @@ spec:
|
||||
name: {{ .Values.config.email.existingSecret }}
|
||||
key: {{ .Values.config.email.sendgridKey }}
|
||||
{{- else }}
|
||||
{{- if .Values.config.email.address }}
|
||||
- name: RECIPYA_EMAIL
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ include "recipya.fullname" . }}-secrets
|
||||
key: {{ .Values.config.email.addressKey }}
|
||||
optional: true
|
||||
{{- end }}
|
||||
{{- if .Values.config.email.sendgrid }}
|
||||
- name: RECIPYA_EMAIL_SENDGRID
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ include "recipya.fullname" . }}-secrets
|
||||
key: {{ .Values.config.email.sendgridKey }}
|
||||
optional: true
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.config.documentIntelligence.existingSecret }}
|
||||
@ -121,16 +164,22 @@ spec:
|
||||
name: {{ .Values.config.documentIntelligence.existingSecret }}
|
||||
key: {{ .Values.config.documentIntelligence.keyKey }}
|
||||
{{- else }}
|
||||
{{- if .Values.config.documentIntelligence.endpoint }}
|
||||
- name: RECIPYA_DI_ENDPOINT
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ include "recipya.fullname" . }}-secrets
|
||||
key: {{ .Values.config.documentIntelligence.endpointKey }}
|
||||
optional: true
|
||||
{{- end }}
|
||||
{{- if .Values.config.documentIntelligence.key }}
|
||||
- name: RECIPYA_DI_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ include "recipya.fullname" . }}-secrets
|
||||
key: {{ .Values.config.documentIntelligence.keyKey }}
|
||||
optional: true
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{- range .Values.env }}
|
||||
@ -145,26 +194,24 @@ spec:
|
||||
volumeMounts:
|
||||
- name: data
|
||||
mountPath: /home/recipya/.config/Recipya
|
||||
{{- if not .Values.containerSecurityContext.readOnlyRootFilesystem }}
|
||||
- name: tmp
|
||||
mountPath: /tmp
|
||||
{{- end }}
|
||||
{{- with .Values.extraVolumeMounts }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
resources:
|
||||
{{- toYaml .Values.resources | nindent 12 }}
|
||||
|
||||
volumes:
|
||||
- name: data
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ include "recipya.fullname" . }}-data
|
||||
{{- if not .Values.containerSecurityContext.readOnlyRootFilesystem }}
|
||||
- name: tmp
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
- name: init-script
|
||||
configMap:
|
||||
name: {{ include "recipya.fullname" . }}-init-script
|
||||
defaultMode: 0755
|
||||
{{- with .Values.extraVolumes }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
|
||||
{{- with .Values.nodeSelector }}
|
||||
nodeSelector:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: {{ include "donetick.fullname" . }}
|
||||
name: {{ include "recipya.fullname" . }}
|
||||
labels:
|
||||
{{- include "donetick.labels" . | nindent 4 }}
|
||||
{{- include "recipya.labels" . | nindent 4 }}
|
||||
{{- with .Values.ingress.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
@ -35,7 +35,7 @@ spec:
|
||||
pathType: {{ .pathType }}
|
||||
backend:
|
||||
service:
|
||||
name: {{ include "donetick.fullname" $ }}
|
||||
name: {{ include "recipya.fullname" $ }}
|
||||
port:
|
||||
number: {{ $.Values.service.port }}
|
||||
{{- end }}
|
||||
|
||||
@ -5,10 +5,13 @@ metadata:
|
||||
name: {{ include "recipya.fullname" . }}-data
|
||||
labels:
|
||||
{{- include "recipya.labels" . | nindent 4 }}
|
||||
{{- with .Values.persistence.annotations }}
|
||||
annotations:
|
||||
{{- if .Values.persistence.retain }}
|
||||
"helm.sh/resource-policy": keep
|
||||
{{- end }}
|
||||
{{- with .Values.persistence.annotations }}
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.accessMode | quote }}
|
||||
|
||||
@ -1,3 +1,5 @@
|
||||
{{- $createSecret := or (and (not .Values.config.email.existingSecret) (or .Values.config.email.address .Values.config.email.sendgrid)) (and (not .Values.config.documentIntelligence.existingSecret) (or .Values.config.documentIntelligence.endpoint .Values.config.documentIntelligence.key)) -}}
|
||||
{{- if $createSecret }}
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
@ -7,11 +9,20 @@ metadata:
|
||||
type: Opaque
|
||||
data:
|
||||
{{- if not .Values.config.email.existingSecret }}
|
||||
{{- if .Values.config.email.address }}
|
||||
{{ .Values.config.email.addressKey }}: {{ .Values.config.email.address | b64enc }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.email.sendgrid }}
|
||||
{{ .Values.config.email.sendgridKey }}: {{ .Values.config.email.sendgrid | b64enc }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{- if not .Values.config.documentIntelligence.existingSecret }}
|
||||
{{- if .Values.config.documentIntelligence.endpoint }}
|
||||
{{ .Values.config.documentIntelligence.endpointKey }}: {{ .Values.config.documentIntelligence.endpoint | b64enc }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.documentIntelligence.key }}
|
||||
{{ .Values.config.documentIntelligence.keyKey }}: {{ .Values.config.documentIntelligence.key | b64enc }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@ -19,54 +19,72 @@ fullnameOverride: ""
|
||||
podSecurityContext:
|
||||
fsGroup: 1000
|
||||
|
||||
# Security context for the container
|
||||
containerSecurityContext:
|
||||
capabilities:
|
||||
drop:
|
||||
- ALL
|
||||
readOnlyRootFilesystem: false
|
||||
runAsNonRoot: true
|
||||
runAsUser: 1000
|
||||
runAsGroup: 1000
|
||||
containerSecurityContext: {}
|
||||
|
||||
# Service configuration
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 8078
|
||||
|
||||
# Recipya configuration
|
||||
config:
|
||||
email:
|
||||
address: ""
|
||||
sendgrid: ""
|
||||
existingSecret: ""
|
||||
addressKey: "email"
|
||||
sendgridKey: "sendgrid"
|
||||
|
||||
documentIntelligence:
|
||||
endpoint: ""
|
||||
key: ""
|
||||
existingSecret: ""
|
||||
endpointKey: "di_endpoint"
|
||||
keyKey: "di_key"
|
||||
|
||||
server:
|
||||
port: 8078
|
||||
autologin: false
|
||||
is_demo: false
|
||||
is_prod: true
|
||||
no_signups: false
|
||||
url: "http://0.0.0.0"
|
||||
|
||||
# Ingress configuration
|
||||
ingress:
|
||||
enabled: false
|
||||
className: ""
|
||||
annotations: {}
|
||||
# kubernetes.io/ingress.class: nginx
|
||||
# kubernetes.io/tls-acme: "true"
|
||||
annotations: []
|
||||
# traefik.ingress.kubernetes.io/router.entrypoints: websecure
|
||||
# traefik.ingress.kubernetes.io/router.middlewares: default-recipya-headers@kubernetescrd
|
||||
hosts:
|
||||
- host: chart-example.local
|
||||
- host: recipya.<domain>
|
||||
paths:
|
||||
- path: /
|
||||
pathType: ImplementationSpecific
|
||||
pathType: Prefix
|
||||
tls: []
|
||||
# - secretName: chart-example-tls
|
||||
# hosts:
|
||||
# - chart-example.local
|
||||
|
||||
|
||||
# Persistent volume claim
|
||||
persistence:
|
||||
enabled: true
|
||||
enabled: false
|
||||
accessMode: ReadWriteOnce
|
||||
size: 1Gi
|
||||
# storageClass: ""
|
||||
size: 5Gi
|
||||
storageClass: ""
|
||||
annotations: {}
|
||||
retain: true
|
||||
|
||||
# Resource limits and requests
|
||||
resources:
|
||||
limits:
|
||||
cpu: 500m
|
||||
memory: 512Mi
|
||||
requests:
|
||||
cpu: 100m
|
||||
memory: 128Mi
|
||||
# resources:
|
||||
# limits:
|
||||
# cpu: 500m
|
||||
# memory: 512Mi
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 128Mi
|
||||
|
||||
# Node selector
|
||||
nodeSelector: {}
|
||||
@ -99,41 +117,17 @@ extraVolumes: []
|
||||
probes:
|
||||
liveness:
|
||||
enabled: true
|
||||
path: /health
|
||||
initialDelaySeconds: 10
|
||||
path: /
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 10
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
readiness:
|
||||
enabled: true
|
||||
path: /health
|
||||
initialDelaySeconds: 10
|
||||
path: /
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 10
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
|
||||
# Recipya configuration
|
||||
config:
|
||||
email:
|
||||
address: ""
|
||||
sendgrid: ""
|
||||
existingSecret: ""
|
||||
addressKey: "email"
|
||||
sendgridKey: "sendgrid"
|
||||
|
||||
documentIntelligence:
|
||||
endpoint: ""
|
||||
key: ""
|
||||
existingSecret: ""
|
||||
endpointKey: "di_endpoint"
|
||||
keyKey: "di_key"
|
||||
|
||||
server:
|
||||
port: 8078
|
||||
autologin: false
|
||||
is_demo: false
|
||||
is_prod: false
|
||||
no_signups: false
|
||||
url: "http://0.0.0.0"
|
||||
18
charts/tandoor/Chart.yaml
Normal file
18
charts/tandoor/Chart.yaml
Normal file
@ -0,0 +1,18 @@
|
||||
apiVersion: v2
|
||||
name: tandoor
|
||||
description: Tandoor Recipes - A recipe management application for Kubernetes
|
||||
type: application
|
||||
version: 0.0.1
|
||||
appVersion: "2.3.5"
|
||||
maintainers:
|
||||
- name: Richard Tomik
|
||||
email: no@m.com
|
||||
keywords:
|
||||
- recipes
|
||||
- cooking
|
||||
- meal-planning
|
||||
- tandoor
|
||||
- food
|
||||
home: https://github.com/rtomik/helm-charts
|
||||
sources:
|
||||
- https://github.com/TandoorRecipes/recipes
|
||||
427
charts/tandoor/readme.md
Normal file
427
charts/tandoor/readme.md
Normal file
@ -0,0 +1,427 @@
|
||||
# Tandoor Recipes Helm Chart
|
||||
|
||||
A Helm chart for deploying [Tandoor Recipes](https://github.com/TandoorRecipes/recipes) on Kubernetes.
|
||||
|
||||
Tandoor is a recipe management application that allows you to manage your recipes, plan meals, and create shopping lists.
|
||||
|
||||
Source code can be found here:
|
||||
- https://github.com/rtomik/helm-charts/tree/main/charts/tandoor
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
- Helm 3.0+
|
||||
- PV provisioner support in the underlying infrastructure
|
||||
- **External PostgreSQL database** (required - this chart does NOT include PostgreSQL)
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
```bash
|
||||
helm repo add rtomik https://rtomik.github.io/helm-charts
|
||||
helm repo update
|
||||
helm install tandoor rtomik/tandoor -f values.yaml
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Minimal Configuration
|
||||
|
||||
```yaml
|
||||
postgresql:
|
||||
host: "postgresql.database.svc.cluster.local"
|
||||
database: "tandoor"
|
||||
username: "tandoor"
|
||||
password: "your-secure-password"
|
||||
|
||||
config:
|
||||
secretKey:
|
||||
value: "your-secret-key-at-least-50-characters-long-for-security-purposes"
|
||||
```
|
||||
|
||||
### Production Configuration
|
||||
|
||||
```yaml
|
||||
postgresql:
|
||||
host: "postgresql.database.svc.cluster.local"
|
||||
database: "tandoor"
|
||||
username: "tandoor"
|
||||
existingSecret: "tandoor-db-secret"
|
||||
passwordKey: "password"
|
||||
|
||||
config:
|
||||
secretKey:
|
||||
existingSecret: "tandoor-app-secret"
|
||||
secretKey: "secret-key"
|
||||
|
||||
allowedHosts: "tandoor.example.com"
|
||||
csrfTrustedOrigins: "https://tandoor.example.com"
|
||||
timezone: "Europe/Berlin"
|
||||
|
||||
# Optional: OpenID Connect with Authentik
|
||||
# oidc:
|
||||
# enabled: true
|
||||
# providerId: "authentik"
|
||||
# providerName: "Authentik"
|
||||
# clientId: "your-client-id"
|
||||
# clientSecret: "your-client-secret"
|
||||
# serverUrl: "https://authentik.company/application/o/tandoor/.well-known/openid-configuration"
|
||||
|
||||
ingress:
|
||||
enabled: true
|
||||
className: "nginx"
|
||||
annotations:
|
||||
cert-manager.io/cluster-issuer: "letsencrypt-prod"
|
||||
hosts:
|
||||
- host: tandoor.example.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- tandoor.example.com
|
||||
secretName: tandoor-tls
|
||||
|
||||
persistence:
|
||||
staticfiles:
|
||||
enabled: true
|
||||
# existingClaim: "my-existing-pvc"
|
||||
storageClass: "longhorn"
|
||||
size: 2Gi
|
||||
mediafiles:
|
||||
enabled: true
|
||||
storageClass: "longhorn"
|
||||
size: 10Gi
|
||||
|
||||
resources:
|
||||
limits:
|
||||
cpu: 1000m
|
||||
memory: 512Mi
|
||||
requests:
|
||||
cpu: 100m
|
||||
memory: 256Mi
|
||||
```
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
All configuration options are based on the official Tandoor documentation:
|
||||
https://docs.tandoor.dev/system/configuration/
|
||||
|
||||
The following table lists the configurable parameters and their default values.
|
||||
|
||||
### Global Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `nameOverride` | String to partially override the release name | `""` |
|
||||
| `fullnameOverride` | String to fully override the release name | `""` |
|
||||
|
||||
### Image Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `image.repository` | Tandoor image repository | `vabene1111/recipes` |
|
||||
| `image.tag` | Tandoor image tag | `2.3.5` |
|
||||
| `image.pullPolicy` | Tandoor image pull policy | `IfNotPresent` |
|
||||
|
||||
### Deployment Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `replicaCount` | Number of Tandoor replicas | `1` |
|
||||
| `revisionHistoryLimit` | Number of old ReplicaSets to retain | `3` |
|
||||
|
||||
### PostgreSQL Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `postgresql.host` | PostgreSQL host | `postgresql.default.svc.cluster.local` |
|
||||
| `postgresql.port` | PostgreSQL port | `5432` |
|
||||
| `postgresql.database` | PostgreSQL database name | `tandoor` |
|
||||
| `postgresql.username` | PostgreSQL username | `tandoor` |
|
||||
| `postgresql.password` | PostgreSQL password (not recommended for production) | `""` |
|
||||
| `postgresql.existingSecret` | Existing secret with PostgreSQL credentials | `""` |
|
||||
| `postgresql.passwordKey` | Key in existing secret for PostgreSQL password | `postgresql-password` |
|
||||
|
||||
### Security Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.secretKey.value` | Django secret key (at least 50 characters) | `""` |
|
||||
| `config.secretKey.existingSecret` | Existing secret for Django secret key | `""` |
|
||||
| `config.secretKey.secretKey` | Key in existing secret for Django secret key | `secret-key` |
|
||||
| `config.allowedHosts` | Allowed hosts for HTTP Host Header validation | `*` |
|
||||
| `config.csrfTrustedOrigins` | CSRF trusted origins | `""` |
|
||||
| `config.corsAllowOrigins` | Enable CORS allow all origins | `false` |
|
||||
|
||||
### Server Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.tandoorPort` | Port where Tandoor exposes its web server | `8080` |
|
||||
| `config.gunicornWorkers` | Number of Gunicorn worker processes | `3` |
|
||||
| `config.gunicornThreads` | Number of Gunicorn threads per worker | `2` |
|
||||
| `config.gunicornTimeout` | Gunicorn request timeout in seconds | `30` |
|
||||
| `config.gunicornMedia` | Enable media serving via Gunicorn | `0` |
|
||||
| `config.timezone` | Application timezone | `UTC` |
|
||||
| `config.scriptName` | URL path base for subfolder deployments | `""` |
|
||||
| `config.sessionCookieDomain` | Session cookie domain | `""` |
|
||||
| `config.sessionCookieName` | Session cookie identifier | `sessionid` |
|
||||
|
||||
### Feature Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.enableSignup` | Allow user registration | `false` |
|
||||
| `config.enableMetrics` | Enable Prometheus metrics at /metrics | `false` |
|
||||
| `config.enablePdfExport` | Enable recipe PDF export | `false` |
|
||||
| `config.sortTreeByName` | Sort keywords/foods alphabetically | `false` |
|
||||
|
||||
### Social Authentication
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.socialDefaultAccess` | Space ID for auto-joining new social auth users | `0` |
|
||||
| `config.socialDefaultGroup` | Default group for new users (guest/user/admin) | `guest` |
|
||||
| `config.socialProviders` | Comma-separated OAuth provider list | `""` |
|
||||
| `config.socialAccountProviders` | SOCIALACCOUNT_PROVIDERS JSON (for complex setups) | `""` |
|
||||
|
||||
### OpenID Connect (OIDC) Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.oidc.enabled` | Enable OpenID Connect authentication | `false` |
|
||||
| `config.oidc.providerId` | Provider ID (e.g., authentik, keycloak) | `authentik` |
|
||||
| `config.oidc.providerName` | Display name on login page | `Authentik` |
|
||||
| `config.oidc.clientId` | Client ID from OIDC provider | `""` |
|
||||
| `config.oidc.clientSecret` | Client Secret from OIDC provider | `""` |
|
||||
| `config.oidc.serverUrl` | OpenID Connect well-known configuration URL | `""` |
|
||||
|
||||
### LDAP Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.ldap.enabled` | Enable LDAP authentication | `false` |
|
||||
| `config.ldap.serverUri` | LDAP server URI | `""` |
|
||||
| `config.ldap.bindDn` | LDAP bind distinguished name | `""` |
|
||||
| `config.ldap.bindPassword` | LDAP bind password | `""` |
|
||||
| `config.ldap.userSearchBaseDn` | LDAP user search base | `""` |
|
||||
| `config.ldap.tlsCacertFile` | LDAP TLS CA certificate file | `""` |
|
||||
| `config.ldap.startTls` | Enable LDAP StartTLS | `false` |
|
||||
| `config.ldap.existingSecret` | Existing secret for LDAP credentials | `""` |
|
||||
| `config.ldap.bindPasswordKey` | Key in existing secret for LDAP password | `ldap-bind-password` |
|
||||
|
||||
### Remote User Authentication
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.remoteUserAuth` | Enable REMOTE-USER header authentication | `false` |
|
||||
|
||||
### Email Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.email.host` | SMTP server hostname | `""` |
|
||||
| `config.email.port` | SMTP server port | `25` |
|
||||
| `config.email.user` | SMTP authentication username | `""` |
|
||||
| `config.email.password` | SMTP authentication password | `""` |
|
||||
| `config.email.useTls` | Enable TLS for email | `false` |
|
||||
| `config.email.useSsl` | Enable SSL for email | `false` |
|
||||
| `config.email.defaultFrom` | Default from email address | `webmaster@localhost` |
|
||||
| `config.email.accountEmailSubjectPrefix` | Email subject prefix | `[Tandoor Recipes]` |
|
||||
| `config.email.existingSecret` | Existing secret for email credentials | `""` |
|
||||
| `config.email.passwordKey` | Key in existing secret for email password | `email-password` |
|
||||
|
||||
### S3/Object Storage Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.s3.enabled` | Enable S3 storage for media files | `false` |
|
||||
| `config.s3.accessKey` | S3 access key | `""` |
|
||||
| `config.s3.secretAccessKey` | S3 secret access key | `""` |
|
||||
| `config.s3.bucketName` | S3 bucket name | `""` |
|
||||
| `config.s3.regionName` | S3 region name | `""` |
|
||||
| `config.s3.endpointUrl` | Custom S3 endpoint URL (for MinIO) | `""` |
|
||||
| `config.s3.customDomain` | CDN/proxy domain for S3 | `""` |
|
||||
| `config.s3.querystringAuth` | Use signed URLs for S3 objects | `true` |
|
||||
| `config.s3.querystringExpire` | Signed URL expiration (seconds) | `3600` |
|
||||
| `config.s3.existingSecret` | Existing secret for S3 credentials | `""` |
|
||||
|
||||
### AI Features
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.ai.enabled` | Enable AI features | `false` |
|
||||
| `config.ai.creditsMonthly` | Monthly AI credits per space | `100` |
|
||||
| `config.ai.rateLimit` | AI API rate limit | `60/hour` |
|
||||
|
||||
### External Services
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.fdcApiKey` | Food Data Central API key | `DEMO_KEY` |
|
||||
| `config.disableExternalConnectors` | Disable all external connectors | `false` |
|
||||
| `config.externalConnectorsQueueSize` | External connectors queue size | `100` |
|
||||
|
||||
### Rate Limiting
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.ratelimitUrlImportRequests` | Rate limit for URL imports | `""` |
|
||||
| `config.drfThrottleRecipeUrlImport` | DRF throttle for recipe URL import | `60/hour` |
|
||||
|
||||
### Space Defaults
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.spaceDefaultMaxRecipes` | Max recipes per space (0=unlimited) | `0` |
|
||||
| `config.spaceDefaultMaxUsers` | Max users per space (0=unlimited) | `0` |
|
||||
| `config.spaceDefaultMaxFiles` | Max file storage in MB (0=unlimited) | `0` |
|
||||
| `config.spaceDefaultAllowSharing` | Allow public recipe sharing | `true` |
|
||||
|
||||
### User Preference Defaults
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.fractionPrefDefault` | Default fraction display | `false` |
|
||||
| `config.commentPrefDefault` | Enable comments by default | `true` |
|
||||
| `config.stickyNavPrefDefault` | Sticky navbar by default | `true` |
|
||||
| `config.maxOwnedSpacesPrefDefault` | Max spaces per user | `100` |
|
||||
|
||||
### Cosmetic Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.unauthenticatedThemeFromSpace` | Space ID for unauthenticated theme | `0` |
|
||||
| `config.forceThemeFromSpace` | Space ID to enforce theme globally | `0` |
|
||||
|
||||
### Performance Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.shoppingMinAutosyncInterval` | Min auto-sync interval (minutes) | `5` |
|
||||
| `config.exportFileCacheDuration` | Export cache duration (seconds) | `600` |
|
||||
|
||||
### Legal URLs
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.termsUrl` | Terms of service URL | `""` |
|
||||
| `config.privacyUrl` | Privacy policy URL | `""` |
|
||||
| `config.imprintUrl` | Legal imprint URL | `""` |
|
||||
|
||||
### hCaptcha Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.hcaptcha.siteKey` | hCaptcha site key | `""` |
|
||||
| `config.hcaptcha.secret` | hCaptcha secret key | `""` |
|
||||
| `config.hcaptcha.existingSecret` | Existing secret for hCaptcha | `""` |
|
||||
|
||||
### Debugging
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `config.debug` | Enable Django debug mode | `false` |
|
||||
| `config.debugToolbar` | Enable Django Debug Toolbar | `false` |
|
||||
| `config.sqlDebug` | Enable SQL debug output | `false` |
|
||||
| `config.logLevel` | Application log level | `WARNING` |
|
||||
| `config.gunicornLogLevel` | Gunicorn log level | `info` |
|
||||
|
||||
### Service Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `service.type` | Kubernetes Service type | `ClusterIP` |
|
||||
| `service.port` | Service HTTP port | `8080` |
|
||||
|
||||
### Ingress Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `ingress.enabled` | Enable ingress | `false` |
|
||||
| `ingress.className` | Ingress class name | `""` |
|
||||
| `ingress.annotations` | Ingress annotations | See values.yaml |
|
||||
| `ingress.hosts` | Ingress hosts configuration | See values.yaml |
|
||||
| `ingress.tls` | Ingress TLS configuration | See values.yaml |
|
||||
|
||||
### Persistence Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `persistence.staticfiles.enabled` | Enable static files persistence | `true` |
|
||||
| `persistence.staticfiles.existingClaim` | Use existing PVC for static files | `""` |
|
||||
| `persistence.staticfiles.storageClass` | Storage class for static files | `""` |
|
||||
| `persistence.staticfiles.accessMode` | Access mode for static files PVC | `ReadWriteOnce` |
|
||||
| `persistence.staticfiles.size` | Size of static files PVC | `1Gi` |
|
||||
| `persistence.mediafiles.enabled` | Enable media files persistence | `true` |
|
||||
| `persistence.mediafiles.existingClaim` | Use existing PVC for media files | `""` |
|
||||
| `persistence.mediafiles.storageClass` | Storage class for media files | `""` |
|
||||
| `persistence.mediafiles.accessMode` | Access mode for media files PVC | `ReadWriteOnce` |
|
||||
| `persistence.mediafiles.size` | Size of media files PVC | `5Gi` |
|
||||
|
||||
### Pod Security Context
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `podSecurityContext.runAsNonRoot` | Run as non-root user | `true` |
|
||||
| `podSecurityContext.runAsUser` | User ID to run as | `1000` |
|
||||
| `podSecurityContext.fsGroup` | Group ID for filesystem | `1000` |
|
||||
|
||||
### Container Security Context
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `containerSecurityContext.allowPrivilegeEscalation` | Allow privilege escalation | `false` |
|
||||
| `containerSecurityContext.readOnlyRootFilesystem` | Read-only root filesystem | `false` |
|
||||
|
||||
### Autoscaling Parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `autoscaling.enabled` | Enable autoscaling | `false` |
|
||||
| `autoscaling.minReplicas` | Minimum replicas | `1` |
|
||||
| `autoscaling.maxReplicas` | Maximum replicas | `3` |
|
||||
| `autoscaling.targetCPUUtilizationPercentage` | Target CPU utilization | `80` |
|
||||
| `autoscaling.targetMemoryUtilizationPercentage` | Target memory utilization | `80` |
|
||||
|
||||
### Probes Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `probes.liveness.enabled` | Enable liveness probe | `true` |
|
||||
| `probes.liveness.initialDelaySeconds` | Initial delay for liveness probe | `30` |
|
||||
| `probes.liveness.periodSeconds` | Period for liveness probe | `10` |
|
||||
| `probes.readiness.enabled` | Enable readiness probe | `true` |
|
||||
| `probes.readiness.initialDelaySeconds` | Initial delay for readiness probe | `15` |
|
||||
| `probes.readiness.periodSeconds` | Period for readiness probe | `5` |
|
||||
|
||||
### Additional Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------|-------------|-------|
|
||||
| `env` | Additional environment variables | `[]` |
|
||||
| `extraEnvFrom` | Additional environment variables from secrets | `[]` |
|
||||
| `extraVolumes` | Additional volumes | `[]` |
|
||||
| `extraVolumeMounts` | Additional volume mounts | `[]` |
|
||||
| `nodeSelector` | Node selector | `{}` |
|
||||
| `tolerations` | Tolerations | `[]` |
|
||||
| `affinity` | Affinity rules | `{}` |
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
```bash
|
||||
helm uninstall tandoor
|
||||
```
|
||||
|
||||
**Note:** PVCs are not automatically deleted. To remove them:
|
||||
|
||||
```bash
|
||||
kubectl delete pvc -l app.kubernetes.io/name=tandoor
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
- [Tandoor Recipes GitHub](https://github.com/TandoorRecipes/recipes)
|
||||
- [Tandoor Documentation](https://docs.tandoor.dev/)
|
||||
- [Configuration Reference](https://docs.tandoor.dev/system/configuration/)
|
||||
43
charts/tandoor/templates/NOTES.txt
Normal file
43
charts/tandoor/templates/NOTES.txt
Normal file
@ -0,0 +1,43 @@
|
||||
Tandoor Recipes has been deployed successfully!
|
||||
|
||||
{{- if .Values.ingress.enabled }}
|
||||
|
||||
Access Tandoor at:
|
||||
{{- range $host := .Values.ingress.hosts }}
|
||||
{{- range .paths }}
|
||||
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{- else if contains "NodePort" .Values.service.type }}
|
||||
|
||||
Get the application URL by running:
|
||||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "tandoor.fullname" . }})
|
||||
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
|
||||
echo http://$NODE_IP:$NODE_PORT
|
||||
|
||||
{{- else if contains "LoadBalancer" .Values.service.type }}
|
||||
|
||||
Get the application URL by running:
|
||||
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
|
||||
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "tandoor.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
|
||||
echo http://$SERVICE_IP:{{ .Values.service.port }}
|
||||
|
||||
{{- else if contains "ClusterIP" .Values.service.type }}
|
||||
|
||||
Access Tandoor by port-forwarding:
|
||||
kubectl --namespace {{ .Release.Namespace }} port-forward service/{{ include "tandoor.fullname" . }} 8080:{{ .Values.service.port }}
|
||||
|
||||
Then visit: http://localhost:8080
|
||||
|
||||
{{- end }}
|
||||
|
||||
IMPORTANT: This chart requires an external PostgreSQL database.
|
||||
Make sure your PostgreSQL database is configured and accessible at:
|
||||
Host: {{ .Values.postgresql.host }}
|
||||
Port: {{ .Values.postgresql.port }}
|
||||
Database: {{ .Values.postgresql.database }}
|
||||
|
||||
For more information, visit:
|
||||
- Tandoor Documentation: https://docs.tandoor.dev/
|
||||
- Configuration Reference: https://docs.tandoor.dev/system/configuration/
|
||||
59
charts/tandoor/templates/_helpers.tpl
Normal file
59
charts/tandoor/templates/_helpers.tpl
Normal file
@ -0,0 +1,59 @@
|
||||
{{/*
|
||||
Expand the name of the chart.
|
||||
*/}}
|
||||
{{- define "tandoor.name" -}}
|
||||
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create a default fully qualified app name.
|
||||
*/}}
|
||||
{{- define "tandoor.fullname" -}}
|
||||
{{- if .Values.fullnameOverride }}
|
||||
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- else }}
|
||||
{{- $name := default .Chart.Name .Values.nameOverride }}
|
||||
{{- printf "%s" $name | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Create chart name and version as used by the chart label.
|
||||
*/}}
|
||||
{{- define "tandoor.chart" -}}
|
||||
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Common labels
|
||||
*/}}
|
||||
{{- define "tandoor.labels" -}}
|
||||
helm.sh/chart: {{ include "tandoor.chart" . }}
|
||||
{{ include "tandoor.selectorLabels" . }}
|
||||
{{- if .Chart.AppVersion }}
|
||||
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
|
||||
{{- end }}
|
||||
app.kubernetes.io/managed-by: {{ .Release.Service }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
Selector labels
|
||||
*/}}
|
||||
{{- define "tandoor.selectorLabels" -}}
|
||||
app.kubernetes.io/name: {{ include "tandoor.name" . }}
|
||||
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
PostgreSQL host
|
||||
*/}}
|
||||
{{- define "tandoor.postgresql.host" -}}
|
||||
{{- .Values.postgresql.host }}
|
||||
{{- end }}
|
||||
|
||||
{{/*
|
||||
PostgreSQL port
|
||||
*/}}
|
||||
{{- define "tandoor.postgresql.port" -}}
|
||||
{{- .Values.postgresql.port | toString }}
|
||||
{{- end }}
|
||||
402
charts/tandoor/templates/deployment.yaml
Normal file
402
charts/tandoor/templates/deployment.yaml
Normal file
@ -0,0 +1,402 @@
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: {{ include "tandoor.fullname" . }}
|
||||
labels:
|
||||
{{- include "tandoor.labels" . | nindent 4 }}
|
||||
annotations:
|
||||
checksum/secret: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
|
||||
spec:
|
||||
replicas: {{ .Values.replicaCount }}
|
||||
revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
|
||||
selector:
|
||||
matchLabels:
|
||||
{{- include "tandoor.selectorLabels" . | nindent 6 }}
|
||||
strategy:
|
||||
type: RollingUpdate
|
||||
rollingUpdate:
|
||||
maxUnavailable: 1
|
||||
maxSurge: 1
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
{{- include "tandoor.selectorLabels" . | nindent 8 }}
|
||||
annotations:
|
||||
{{- with .Values.podAnnotations }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- with .Values.imagePullSecrets }}
|
||||
imagePullSecrets:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.podSecurityContext | nindent 8 }}
|
||||
containers:
|
||||
- name: {{ .Chart.Name }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.containerSecurityContext | nindent 12 }}
|
||||
image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
|
||||
imagePullPolicy: {{ .Values.image.pullPolicy }}
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: {{ .Values.config.tandoorPort }}
|
||||
protocol: TCP
|
||||
{{- if .Values.probes.liveness.enabled }}
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.liveness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.liveness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.liveness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.liveness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.liveness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.liveness.successThreshold }}
|
||||
{{- end }}
|
||||
{{- if .Values.probes.readiness.enabled }}
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: {{ .Values.probes.readiness.path }}
|
||||
port: http
|
||||
initialDelaySeconds: {{ .Values.probes.readiness.initialDelaySeconds }}
|
||||
periodSeconds: {{ .Values.probes.readiness.periodSeconds }}
|
||||
timeoutSeconds: {{ .Values.probes.readiness.timeoutSeconds }}
|
||||
failureThreshold: {{ .Values.probes.readiness.failureThreshold }}
|
||||
successThreshold: {{ .Values.probes.readiness.successThreshold }}
|
||||
{{- end }}
|
||||
env:
|
||||
# Database configuration
|
||||
- name: DB_ENGINE
|
||||
value: "django.db.backends.postgresql"
|
||||
- name: POSTGRES_HOST
|
||||
value: {{ include "tandoor.postgresql.host" . | quote }}
|
||||
- name: POSTGRES_PORT
|
||||
value: {{ include "tandoor.postgresql.port" . | quote }}
|
||||
- name: POSTGRES_DB
|
||||
value: {{ .Values.postgresql.database | quote }}
|
||||
- name: POSTGRES_USER
|
||||
value: {{ .Values.postgresql.username | quote }}
|
||||
- name: POSTGRES_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.postgresql.existingSecret | default (printf "%s-secrets" (include "tandoor.fullname" .)) }}
|
||||
key: {{ .Values.postgresql.passwordKey | default "postgresql-password" }}
|
||||
|
||||
# Security
|
||||
- name: SECRET_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.secretKey.existingSecret | default (printf "%s-secrets" (include "tandoor.fullname" .)) }}
|
||||
key: {{ .Values.config.secretKey.secretKey | default "secret-key" }}
|
||||
- name: ALLOWED_HOSTS
|
||||
value: {{ .Values.config.allowedHosts | quote }}
|
||||
{{- if .Values.config.csrfTrustedOrigins }}
|
||||
- name: CSRF_TRUSTED_ORIGINS
|
||||
value: {{ .Values.config.csrfTrustedOrigins | quote }}
|
||||
{{- end }}
|
||||
- name: CORS_ALLOW_ALL_ORIGINS
|
||||
value: {{ ternary "1" "0" .Values.config.corsAllowOrigins | quote }}
|
||||
|
||||
# Server configuration
|
||||
- name: TANDOOR_PORT
|
||||
value: {{ .Values.config.tandoorPort | quote }}
|
||||
- name: GUNICORN_WORKERS
|
||||
value: {{ .Values.config.gunicornWorkers | quote }}
|
||||
- name: GUNICORN_THREADS
|
||||
value: {{ .Values.config.gunicornThreads | quote }}
|
||||
- name: GUNICORN_TIMEOUT
|
||||
value: {{ .Values.config.gunicornTimeout | quote }}
|
||||
- name: GUNICORN_MEDIA
|
||||
value: {{ .Values.config.gunicornMedia | quote }}
|
||||
|
||||
# URL configuration
|
||||
{{- if .Values.config.scriptName }}
|
||||
- name: SCRIPT_NAME
|
||||
value: {{ .Values.config.scriptName | quote }}
|
||||
{{- end }}
|
||||
|
||||
# Session cookie configuration
|
||||
{{- if .Values.config.sessionCookieDomain }}
|
||||
- name: SESSION_COOKIE_DOMAIN
|
||||
value: {{ .Values.config.sessionCookieDomain | quote }}
|
||||
{{- end }}
|
||||
- name: SESSION_COOKIE_NAME
|
||||
value: {{ .Values.config.sessionCookieName | quote }}
|
||||
|
||||
# Time and locale
|
||||
- name: TZ
|
||||
value: {{ .Values.config.timezone | quote }}
|
||||
|
||||
# Feature toggles
|
||||
- name: ENABLE_SIGNUP
|
||||
value: {{ ternary "1" "0" .Values.config.enableSignup | quote }}
|
||||
- name: ENABLE_METRICS
|
||||
value: {{ ternary "1" "0" .Values.config.enableMetrics | quote }}
|
||||
- name: ENABLE_PDF_EXPORT
|
||||
value: {{ ternary "1" "0" .Values.config.enablePdfExport | quote }}
|
||||
- name: SORT_TREE_BY_NAME
|
||||
value: {{ ternary "1" "0" .Values.config.sortTreeByName | quote }}
|
||||
|
||||
# Social authentication
|
||||
- name: SOCIAL_DEFAULT_ACCESS
|
||||
value: {{ .Values.config.socialDefaultAccess | quote }}
|
||||
- name: SOCIAL_DEFAULT_GROUP
|
||||
value: {{ .Values.config.socialDefaultGroup | quote }}
|
||||
{{- if or .Values.config.socialProviders .Values.config.oidc.enabled }}
|
||||
- name: SOCIAL_PROVIDERS
|
||||
value: {{ .Values.config.socialProviders | default "allauth.socialaccount.providers.openid_connect" | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.socialAccountProviders }}
|
||||
- name: SOCIALACCOUNT_PROVIDERS
|
||||
value: {{ .Values.config.socialAccountProviders | quote }}
|
||||
{{- end }}
|
||||
|
||||
# OpenID Connect / OAuth configuration (e.g., Authentik, Keycloak)
|
||||
# Note: For production, consider using extraEnvFrom with a secret containing SOCIALACCOUNT_PROVIDERS
|
||||
{{- if .Values.config.oidc.enabled }}
|
||||
{{- $clientId := .Values.config.oidc.clientId }}
|
||||
{{- $clientSecret := .Values.config.oidc.clientSecret }}
|
||||
- name: SOCIALACCOUNT_PROVIDERS
|
||||
value: '{"openid_connect":{"APPS":[{"provider_id":"{{ .Values.config.oidc.providerId }}","name":"{{ .Values.config.oidc.providerName }}","client_id":"{{ $clientId }}","secret":"{{ $clientSecret }}","settings":{"server_url":"{{ .Values.config.oidc.serverUrl }}"}}]}}'
|
||||
{{- end }}
|
||||
|
||||
# Remote user authentication
|
||||
- name: REMOTE_USER_AUTH
|
||||
value: {{ ternary "1" "0" .Values.config.remoteUserAuth | quote }}
|
||||
|
||||
# LDAP configuration
|
||||
{{- if .Values.config.ldap.enabled }}
|
||||
- name: LDAP_AUTH
|
||||
value: "1"
|
||||
- name: AUTH_LDAP_SERVER_URI
|
||||
value: {{ .Values.config.ldap.serverUri | quote }}
|
||||
{{- if .Values.config.ldap.bindDn }}
|
||||
- name: AUTH_LDAP_BIND_DN
|
||||
value: {{ .Values.config.ldap.bindDn | quote }}
|
||||
{{- end }}
|
||||
{{- if or .Values.config.ldap.bindPassword .Values.config.ldap.existingSecret }}
|
||||
- name: AUTH_LDAP_BIND_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.ldap.existingSecret | default (printf "%s-secrets" (include "tandoor.fullname" .)) }}
|
||||
key: {{ .Values.config.ldap.bindPasswordKey | default "ldap-bind-password" }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.ldap.userSearchBaseDn }}
|
||||
- name: AUTH_LDAP_USER_SEARCH_BASE_DN
|
||||
value: {{ .Values.config.ldap.userSearchBaseDn | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.ldap.tlsCacertFile }}
|
||||
- name: AUTH_LDAP_TLS_CACERTFILE
|
||||
value: {{ .Values.config.ldap.tlsCacertFile | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.ldap.startTls }}
|
||||
- name: AUTH_LDAP_START_TLS
|
||||
value: "True"
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
# Email configuration
|
||||
{{- if .Values.config.email.host }}
|
||||
- name: EMAIL_HOST
|
||||
value: {{ .Values.config.email.host | quote }}
|
||||
- name: EMAIL_PORT
|
||||
value: {{ .Values.config.email.port | quote }}
|
||||
{{- if .Values.config.email.user }}
|
||||
- name: EMAIL_HOST_USER
|
||||
value: {{ .Values.config.email.user | quote }}
|
||||
- name: EMAIL_HOST_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.email.existingSecret | default (printf "%s-secrets" (include "tandoor.fullname" .)) }}
|
||||
key: {{ .Values.config.email.passwordKey | default "email-password" }}
|
||||
{{- end }}
|
||||
- name: EMAIL_USE_TLS
|
||||
value: {{ ternary "1" "0" .Values.config.email.useTls | quote }}
|
||||
- name: EMAIL_USE_SSL
|
||||
value: {{ ternary "1" "0" .Values.config.email.useSsl | quote }}
|
||||
- name: DEFAULT_FROM_EMAIL
|
||||
value: {{ .Values.config.email.defaultFrom | quote }}
|
||||
- name: ACCOUNT_EMAIL_SUBJECT_PREFIX
|
||||
value: {{ .Values.config.email.accountEmailSubjectPrefix | quote }}
|
||||
{{- end }}
|
||||
|
||||
# S3/Object storage configuration
|
||||
{{- if .Values.config.s3.enabled }}
|
||||
- name: S3_ACCESS_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.s3.existingSecret | default (printf "%s-secrets" (include "tandoor.fullname" .)) }}
|
||||
key: {{ .Values.config.s3.accessKeyKey | default "s3-access-key" }}
|
||||
- name: S3_SECRET_ACCESS_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.s3.existingSecret | default (printf "%s-secrets" (include "tandoor.fullname" .)) }}
|
||||
key: {{ .Values.config.s3.secretAccessKeyKey | default "s3-secret-access-key" }}
|
||||
- name: S3_BUCKET_NAME
|
||||
value: {{ .Values.config.s3.bucketName | quote }}
|
||||
{{- if .Values.config.s3.regionName }}
|
||||
- name: S3_REGION_NAME
|
||||
value: {{ .Values.config.s3.regionName | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.s3.endpointUrl }}
|
||||
- name: S3_ENDPOINT_URL
|
||||
value: {{ .Values.config.s3.endpointUrl | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.s3.customDomain }}
|
||||
- name: S3_CUSTOM_DOMAIN
|
||||
value: {{ .Values.config.s3.customDomain | quote }}
|
||||
{{- end }}
|
||||
- name: S3_QUERYSTRING_AUTH
|
||||
value: {{ ternary "1" "0" .Values.config.s3.querystringAuth | quote }}
|
||||
- name: S3_QUERYSTRING_EXPIRE
|
||||
value: {{ .Values.config.s3.querystringExpire | quote }}
|
||||
{{- end }}
|
||||
|
||||
# AI features
|
||||
{{- if .Values.config.ai.enabled }}
|
||||
- name: SPACE_AI_ENABLED
|
||||
value: "1"
|
||||
- name: SPACE_AI_CREDITS_MONTHLY
|
||||
value: {{ .Values.config.ai.creditsMonthly | quote }}
|
||||
- name: AI_RATELIMIT
|
||||
value: {{ .Values.config.ai.rateLimit | quote }}
|
||||
{{- end }}
|
||||
|
||||
# Food Data Central API
|
||||
- name: FDC_API_KEY
|
||||
value: {{ .Values.config.fdcApiKey | quote }}
|
||||
|
||||
# External connectors
|
||||
- name: DISABLE_EXTERNAL_CONNECTORS
|
||||
value: {{ ternary "1" "0" .Values.config.disableExternalConnectors | quote }}
|
||||
- name: EXTERNAL_CONNECTORS_QUEUE_SIZE
|
||||
value: {{ .Values.config.externalConnectorsQueueSize | quote }}
|
||||
|
||||
# Rate limiting
|
||||
{{- if .Values.config.ratelimitUrlImportRequests }}
|
||||
- name: RATELIMIT_URL_IMPORT_REQUESTS
|
||||
value: {{ .Values.config.ratelimitUrlImportRequests | quote }}
|
||||
{{- end }}
|
||||
- name: DRF_THROTTLE_RECIPE_URL_IMPORT
|
||||
value: {{ .Values.config.drfThrottleRecipeUrlImport | quote }}
|
||||
|
||||
# Space defaults
|
||||
- name: SPACE_DEFAULT_MAX_RECIPES
|
||||
value: {{ .Values.config.spaceDefaultMaxRecipes | quote }}
|
||||
- name: SPACE_DEFAULT_MAX_USERS
|
||||
value: {{ .Values.config.spaceDefaultMaxUsers | quote }}
|
||||
- name: SPACE_DEFAULT_MAX_FILES
|
||||
value: {{ .Values.config.spaceDefaultMaxFiles | quote }}
|
||||
- name: SPACE_DEFAULT_ALLOW_SHARING
|
||||
value: {{ ternary "1" "0" .Values.config.spaceDefaultAllowSharing | quote }}
|
||||
|
||||
# User preference defaults
|
||||
- name: FRACTION_PREF_DEFAULT
|
||||
value: {{ ternary "1" "0" .Values.config.fractionPrefDefault | quote }}
|
||||
- name: COMMENT_PREF_DEFAULT
|
||||
value: {{ ternary "1" "0" .Values.config.commentPrefDefault | quote }}
|
||||
- name: STICKY_NAV_PREF_DEFAULT
|
||||
value: {{ ternary "1" "0" .Values.config.stickyNavPrefDefault | quote }}
|
||||
- name: MAX_OWNED_SPACES_PREF_DEFAULT
|
||||
value: {{ .Values.config.maxOwnedSpacesPrefDefault | quote }}
|
||||
|
||||
# Cosmetic
|
||||
- name: UNAUTHENTICATED_THEME_FROM_SPACE
|
||||
value: {{ .Values.config.unauthenticatedThemeFromSpace | quote }}
|
||||
- name: FORCE_THEME_FROM_SPACE
|
||||
value: {{ .Values.config.forceThemeFromSpace | quote }}
|
||||
|
||||
# Performance
|
||||
- name: SHOPPING_MIN_AUTOSYNC_INTERVAL
|
||||
value: {{ .Values.config.shoppingMinAutosyncInterval | quote }}
|
||||
- name: EXPORT_FILE_CACHE_DURATION
|
||||
value: {{ .Values.config.exportFileCacheDuration | quote }}
|
||||
|
||||
# Legal URLs
|
||||
{{- if .Values.config.termsUrl }}
|
||||
- name: TERMS_URL
|
||||
value: {{ .Values.config.termsUrl | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.privacyUrl }}
|
||||
- name: PRIVACY_URL
|
||||
value: {{ .Values.config.privacyUrl | quote }}
|
||||
{{- end }}
|
||||
{{- if .Values.config.imprintUrl }}
|
||||
- name: IMPRINT_URL
|
||||
value: {{ .Values.config.imprintUrl | quote }}
|
||||
{{- end }}
|
||||
|
||||
# hCaptcha
|
||||
{{- if .Values.config.hcaptcha.siteKey }}
|
||||
- name: HCAPTCHA_SITEKEY
|
||||
value: {{ .Values.config.hcaptcha.siteKey | quote }}
|
||||
- name: HCAPTCHA_SECRET
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: {{ .Values.config.hcaptcha.existingSecret | default (printf "%s-secrets" (include "tandoor.fullname" .)) }}
|
||||
key: {{ .Values.config.hcaptcha.secretKeyKey | default "hcaptcha-secret" }}
|
||||
{{- end }}
|
||||
|
||||
# Debugging
|
||||
- name: DEBUG
|
||||
value: {{ ternary "1" "0" .Values.config.debug | quote }}
|
||||
- name: DEBUG_TOOLBAR
|
||||
value: {{ ternary "1" "0" .Values.config.debugToolbar | quote }}
|
||||
- name: SQL_DEBUG
|
||||
value: {{ ternary "1" "0" .Values.config.sqlDebug | quote }}
|
||||
- name: LOG_LEVEL
|
||||
value: {{ .Values.config.logLevel | quote }}
|
||||
- name: GUNICORN_LOG_LEVEL
|
||||
value: {{ .Values.config.gunicornLogLevel | quote }}
|
||||
|
||||
# Custom environment variables
|
||||
{{- range .Values.env }}
|
||||
- name: {{ .name }}
|
||||
value: {{ .value | quote }}
|
||||
{{- end }}
|
||||
{{- with .Values.extraEnvFrom }}
|
||||
envFrom:
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
volumeMounts:
|
||||
- name: staticfiles
|
||||
mountPath: /opt/recipes/staticfiles
|
||||
- name: mediafiles
|
||||
mountPath: /opt/recipes/mediafiles
|
||||
{{- with .Values.extraVolumeMounts }}
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
resources:
|
||||
{{- toYaml .Values.resources | nindent 12 }}
|
||||
volumes:
|
||||
{{- if .Values.persistence.staticfiles.enabled }}
|
||||
- name: staticfiles
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ .Values.persistence.staticfiles.existingClaim | default (printf "%s-staticfiles" (include "tandoor.fullname" .)) }}
|
||||
{{- else }}
|
||||
- name: staticfiles
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
{{- if .Values.persistence.mediafiles.enabled }}
|
||||
- name: mediafiles
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ .Values.persistence.mediafiles.existingClaim | default (printf "%s-mediafiles" (include "tandoor.fullname" .)) }}
|
||||
{{- else }}
|
||||
- name: mediafiles
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
{{- with .Values.extraVolumes }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.nodeSelector }}
|
||||
nodeSelector:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.affinity }}
|
||||
affinity:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.tolerations }}
|
||||
tolerations:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
43
charts/tandoor/templates/ingress.yaml
Normal file
43
charts/tandoor/templates/ingress.yaml
Normal file
@ -0,0 +1,43 @@
|
||||
{{- if .Values.ingress.enabled -}}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: {{ include "tandoor.fullname" . }}
|
||||
labels:
|
||||
{{- include "tandoor.labels" . | nindent 4 }}
|
||||
{{- with .Values.ingress.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- if .Values.ingress.className }}
|
||||
ingressClassName: {{ .Values.ingress.className }}
|
||||
{{- end }}
|
||||
{{- if .Values.ingress.tls }}
|
||||
tls:
|
||||
{{- range .Values.ingress.tls }}
|
||||
- hosts:
|
||||
{{- range .hosts }}
|
||||
- {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- if .secretName }}
|
||||
secretName: {{ .secretName }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
rules:
|
||||
{{- range .Values.ingress.hosts }}
|
||||
- host: {{ .host | quote }}
|
||||
http:
|
||||
paths:
|
||||
{{- range .paths }}
|
||||
- path: {{ .path }}
|
||||
pathType: {{ .pathType }}
|
||||
backend:
|
||||
service:
|
||||
name: {{ include "tandoor.fullname" $ }}
|
||||
port:
|
||||
number: {{ $.Values.service.port }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
44
charts/tandoor/templates/pvc.yaml
Normal file
44
charts/tandoor/templates/pvc.yaml
Normal file
@ -0,0 +1,44 @@
|
||||
{{- if and .Values.persistence.staticfiles.enabled (not .Values.persistence.staticfiles.existingClaim) }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "tandoor.fullname" . }}-staticfiles
|
||||
labels:
|
||||
{{- include "tandoor.labels" . | nindent 4 }}
|
||||
{{- with .Values.persistence.staticfiles.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.staticfiles.accessMode | quote }}
|
||||
{{- if .Values.persistence.staticfiles.storageClass }}
|
||||
storageClassName: {{ .Values.persistence.staticfiles.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.staticfiles.size | quote }}
|
||||
---
|
||||
{{- end }}
|
||||
|
||||
{{- if and .Values.persistence.mediafiles.enabled (not .Values.persistence.mediafiles.existingClaim) }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "tandoor.fullname" . }}-mediafiles
|
||||
labels:
|
||||
{{- include "tandoor.labels" . | nindent 4 }}
|
||||
{{- with .Values.persistence.mediafiles.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
- {{ .Values.persistence.mediafiles.accessMode | quote }}
|
||||
{{- if .Values.persistence.mediafiles.storageClass }}
|
||||
storageClassName: {{ .Values.persistence.mediafiles.storageClass | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.mediafiles.size | quote }}
|
||||
{{- end }}
|
||||
49
charts/tandoor/templates/secret.yaml
Normal file
49
charts/tandoor/templates/secret.yaml
Normal file
@ -0,0 +1,49 @@
|
||||
{{- $needsSecret := false -}}
|
||||
{{- if not .Values.config.secretKey.existingSecret -}}
|
||||
{{- $needsSecret = true -}}
|
||||
{{- end -}}
|
||||
{{- if not .Values.postgresql.existingSecret -}}
|
||||
{{- $needsSecret = true -}}
|
||||
{{- end -}}
|
||||
{{- if and .Values.config.ldap.enabled .Values.config.ldap.bindPassword (not .Values.config.ldap.existingSecret) -}}
|
||||
{{- $needsSecret = true -}}
|
||||
{{- end -}}
|
||||
{{- if and .Values.config.email.host .Values.config.email.user (not .Values.config.email.existingSecret) -}}
|
||||
{{- $needsSecret = true -}}
|
||||
{{- end -}}
|
||||
{{- if and .Values.config.s3.enabled (not .Values.config.s3.existingSecret) -}}
|
||||
{{- $needsSecret = true -}}
|
||||
{{- end -}}
|
||||
{{- if and .Values.config.hcaptcha.siteKey .Values.config.hcaptcha.secret (not .Values.config.hcaptcha.existingSecret) -}}
|
||||
{{- $needsSecret = true -}}
|
||||
{{- end -}}
|
||||
|
||||
{{- if $needsSecret }}
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: {{ include "tandoor.fullname" . }}-secrets
|
||||
labels:
|
||||
{{- include "tandoor.labels" . | nindent 4 }}
|
||||
type: Opaque
|
||||
data:
|
||||
{{- if not .Values.config.secretKey.existingSecret }}
|
||||
{{ .Values.config.secretKey.secretKey | default "secret-key" }}: {{ .Values.config.secretKey.value | default "change-me-tandoor-secret-key-at-least-50-characters-long-for-security" | b64enc }}
|
||||
{{- end }}
|
||||
{{- if not .Values.postgresql.existingSecret }}
|
||||
{{ .Values.postgresql.passwordKey | default "postgresql-password" }}: {{ .Values.postgresql.password | default "tandoor" | b64enc }}
|
||||
{{- end }}
|
||||
{{- if and .Values.config.ldap.enabled .Values.config.ldap.bindPassword (not .Values.config.ldap.existingSecret) }}
|
||||
{{ .Values.config.ldap.bindPasswordKey | default "ldap-bind-password" }}: {{ .Values.config.ldap.bindPassword | b64enc }}
|
||||
{{- end }}
|
||||
{{- if and .Values.config.email.host .Values.config.email.user (not .Values.config.email.existingSecret) }}
|
||||
{{ .Values.config.email.passwordKey | default "email-password" }}: {{ .Values.config.email.password | default "" | b64enc }}
|
||||
{{- end }}
|
||||
{{- if and .Values.config.s3.enabled (not .Values.config.s3.existingSecret) }}
|
||||
{{ .Values.config.s3.accessKeyKey | default "s3-access-key" }}: {{ .Values.config.s3.accessKey | default "" | b64enc }}
|
||||
{{ .Values.config.s3.secretAccessKeyKey | default "s3-secret-access-key" }}: {{ .Values.config.s3.secretAccessKey | default "" | b64enc }}
|
||||
{{- end }}
|
||||
{{- if and .Values.config.hcaptcha.siteKey .Values.config.hcaptcha.secret (not .Values.config.hcaptcha.existingSecret) }}
|
||||
{{ .Values.config.hcaptcha.secretKeyKey | default "hcaptcha-secret" }}: {{ .Values.config.hcaptcha.secret | b64enc }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
15
charts/tandoor/templates/service.yaml
Normal file
15
charts/tandoor/templates/service.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: {{ include "tandoor.fullname" . }}
|
||||
labels:
|
||||
{{- include "tandoor.labels" . | nindent 4 }}
|
||||
spec:
|
||||
type: {{ .Values.service.type }}
|
||||
ports:
|
||||
- port: {{ .Values.service.port }}
|
||||
targetPort: http
|
||||
protocol: TCP
|
||||
name: http
|
||||
selector:
|
||||
{{- include "tandoor.selectorLabels" . | nindent 4 }}
|
||||
317
charts/tandoor/values.yaml
Normal file
317
charts/tandoor/values.yaml
Normal file
@ -0,0 +1,317 @@
|
||||
## Global settings
|
||||
nameOverride: ""
|
||||
fullnameOverride: ""
|
||||
|
||||
## Image settings
|
||||
image:
|
||||
repository: vabene1111/recipes
|
||||
tag: "2.3.5"
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
## Deployment settings
|
||||
replicaCount: 1
|
||||
revisionHistoryLimit: 3
|
||||
|
||||
# Pod security settings
|
||||
# Note: Tandoor runs nginx internally which requires root privileges
|
||||
# to write to /var/lib/nginx, /run/nginx, and /opt/recipes/http.d
|
||||
podSecurityContext:
|
||||
fsGroup: 0
|
||||
|
||||
containerSecurityContext:
|
||||
runAsUser: 0
|
||||
runAsGroup: 0
|
||||
allowPrivilegeEscalation: false
|
||||
readOnlyRootFilesystem: false
|
||||
|
||||
## Pod scheduling
|
||||
nodeSelector: {}
|
||||
tolerations: []
|
||||
affinity: {}
|
||||
|
||||
## Service settings
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 8080
|
||||
|
||||
## Ingress settings
|
||||
ingress:
|
||||
enabled: false
|
||||
className: ""
|
||||
annotations:
|
||||
traefik.ingress.kubernetes.io/router.entrypoints: websecure
|
||||
# Enable these for proper HTTP to HTTPS redirect (prevents Origin: null issues)
|
||||
# traefik.ingress.kubernetes.io/router.middlewares: default-redirect-https@kubernetescrd
|
||||
hosts:
|
||||
- host: tandoor.domain.com
|
||||
paths:
|
||||
- path: /
|
||||
pathType: Prefix
|
||||
tls:
|
||||
- hosts:
|
||||
- tandoor.domain.com
|
||||
# Optional: specify the name of an existing TLS secret
|
||||
# secretName: "existing-tls-secret"
|
||||
|
||||
## Persistence settings
|
||||
persistence:
|
||||
# Tandoor static files directory
|
||||
staticfiles:
|
||||
enabled: true
|
||||
# Use an existing PVC instead of creating a new one
|
||||
existingClaim: ""
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 1Gi
|
||||
annotations: {}
|
||||
# Tandoor media files directory (recipe images, etc.)
|
||||
mediafiles:
|
||||
enabled: true
|
||||
# Use an existing PVC instead of creating a new one
|
||||
existingClaim: ""
|
||||
storageClass: ""
|
||||
accessMode: ReadWriteOnce
|
||||
size: 5Gi
|
||||
annotations: {}
|
||||
|
||||
# Extra volume mounts
|
||||
extraVolumeMounts: []
|
||||
|
||||
# Extra volumes
|
||||
extraVolumes: []
|
||||
|
||||
## Resource limits and requests
|
||||
# resources:
|
||||
# limits:
|
||||
# cpu: 1000m
|
||||
# memory: 512Mi
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 256Mi
|
||||
|
||||
## Application health checks
|
||||
probes:
|
||||
liveness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 30
|
||||
periodSeconds: 10
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 6
|
||||
successThreshold: 1
|
||||
path: /
|
||||
readiness:
|
||||
enabled: true
|
||||
initialDelaySeconds: 15
|
||||
periodSeconds: 5
|
||||
timeoutSeconds: 3
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
path: /
|
||||
|
||||
## Autoscaling configuration
|
||||
autoscaling:
|
||||
enabled: false
|
||||
minReplicas: 1
|
||||
maxReplicas: 3
|
||||
targetCPUUtilizationPercentage: 80
|
||||
targetMemoryUtilizationPercentage: 80
|
||||
|
||||
## External PostgreSQL database configuration
|
||||
## This chart does NOT include PostgreSQL - you must provide an external database
|
||||
postgresql:
|
||||
host: "postgresql.default.svc.cluster.local"
|
||||
port: 5432
|
||||
database: "tandoor"
|
||||
username: "tandoor"
|
||||
# Use existingSecret for credentials (recommended for production)
|
||||
existingSecret: ""
|
||||
passwordKey: "postgresql-password"
|
||||
# Or set password directly (not recommended for production)
|
||||
password: ""
|
||||
|
||||
## Tandoor Configuration
|
||||
## All settings based on official documentation: https://docs.tandoor.dev/system/configuration/
|
||||
config:
|
||||
# Required: Secret key for Django cryptographic operations (at least 50 characters)
|
||||
secretKey:
|
||||
# Use existingSecret for production
|
||||
existingSecret: ""
|
||||
secretKey: "secret-key"
|
||||
# Or set directly (not recommended for production)
|
||||
value: ""
|
||||
|
||||
# Security setting to prevent HTTP Host Header Attacks
|
||||
allowedHosts: "*"
|
||||
|
||||
# Allows setting origins to allow for unsafe requests (CSRF)
|
||||
csrfTrustedOrigins: ""
|
||||
|
||||
# Enable cross-origin resource sharing
|
||||
corsAllowOrigins: false
|
||||
|
||||
# Time and locale settings
|
||||
timezone: "UTC"
|
||||
|
||||
# Server configuration
|
||||
tandoorPort: 8080
|
||||
gunicornWorkers: 3
|
||||
gunicornThreads: 2
|
||||
gunicornTimeout: 30
|
||||
gunicornMedia: 0
|
||||
|
||||
# URL configuration (for reverse proxy setups)
|
||||
# URL path base for subfolder deployments
|
||||
scriptName: ""
|
||||
|
||||
# Session cookie configuration
|
||||
sessionCookieDomain: ""
|
||||
sessionCookieName: "sessionid"
|
||||
|
||||
# Feature toggles
|
||||
enableSignup: false
|
||||
enableMetrics: false
|
||||
enablePdfExport: false
|
||||
sortTreeByName: false
|
||||
|
||||
# Social authentication
|
||||
socialDefaultAccess: 0
|
||||
socialDefaultGroup: "guest"
|
||||
socialProviders: ""
|
||||
# For OpenID Connect providers (like Authentik), use the socialAccountProviders field
|
||||
# or set via env for complex JSON configurations
|
||||
socialAccountProviders: ""
|
||||
|
||||
# OpenID Connect / OAuth configuration (e.g., Authentik, Keycloak, etc.)
|
||||
# For simple single-provider OIDC setup, configure here.
|
||||
# For complex multi-provider setups or production with secrets, use env + extraEnvFrom.
|
||||
oidc:
|
||||
enabled: false
|
||||
# Provider ID (e.g., "authentik", "keycloak")
|
||||
providerId: "authentik"
|
||||
# Display name shown on login page
|
||||
providerName: "Authentik"
|
||||
# Client ID from your OIDC provider
|
||||
clientId: ""
|
||||
# Client Secret from your OIDC provider (for production, use extraEnvFrom with a secret)
|
||||
clientSecret: ""
|
||||
# OpenID Connect well-known configuration URL
|
||||
# e.g., https://authentik.company/application/o/<application_slug>/.well-known/openid-configuration
|
||||
serverUrl: ""
|
||||
|
||||
# Remote user authentication
|
||||
remoteUserAuth: false
|
||||
|
||||
# LDAP authentication (optional)
|
||||
ldap:
|
||||
enabled: false
|
||||
serverUri: ""
|
||||
bindDn: ""
|
||||
bindPassword: ""
|
||||
bindPasswordFile: ""
|
||||
userSearchBaseDn: ""
|
||||
tlsCacertFile: ""
|
||||
startTls: false
|
||||
existingSecret: ""
|
||||
bindPasswordKey: "ldap-bind-password"
|
||||
|
||||
# Email configuration (optional)
|
||||
email:
|
||||
host: ""
|
||||
port: 25
|
||||
user: ""
|
||||
password: ""
|
||||
useTls: false
|
||||
useSsl: false
|
||||
defaultFrom: "webmaster@localhost"
|
||||
accountEmailSubjectPrefix: "[Tandoor Recipes]"
|
||||
existingSecret: ""
|
||||
passwordKey: "email-password"
|
||||
|
||||
# S3/Object storage configuration (optional)
|
||||
s3:
|
||||
enabled: false
|
||||
accessKey: ""
|
||||
secretAccessKey: ""
|
||||
bucketName: ""
|
||||
regionName: ""
|
||||
endpointUrl: ""
|
||||
customDomain: ""
|
||||
querystringAuth: true
|
||||
querystringExpire: 3600
|
||||
existingSecret: ""
|
||||
accessKeyKey: "s3-access-key"
|
||||
secretAccessKeyKey: "s3-secret-access-key"
|
||||
|
||||
# AI features (optional)
|
||||
ai:
|
||||
enabled: false
|
||||
creditsMonthly: 100
|
||||
rateLimit: "60/hour"
|
||||
|
||||
# Food Data Central API key for nutrition data
|
||||
fdcApiKey: "DEMO_KEY"
|
||||
|
||||
# External connectors
|
||||
disableExternalConnectors: false
|
||||
externalConnectorsQueueSize: 100
|
||||
|
||||
# Rate limiting
|
||||
ratelimitUrlImportRequests: ""
|
||||
drfThrottleRecipeUrlImport: "60/hour"
|
||||
|
||||
# Space defaults
|
||||
spaceDefaultMaxRecipes: 0
|
||||
spaceDefaultMaxUsers: 0
|
||||
spaceDefaultMaxFiles: 0
|
||||
spaceDefaultAllowSharing: true
|
||||
|
||||
# User preference defaults
|
||||
fractionPrefDefault: false
|
||||
commentPrefDefault: true
|
||||
stickyNavPrefDefault: true
|
||||
maxOwnedSpacesPrefDefault: 100
|
||||
|
||||
# Cosmetic
|
||||
unauthenticatedThemeFromSpace: 0
|
||||
forceThemeFromSpace: 0
|
||||
|
||||
# Performance
|
||||
shoppingMinAutosyncInterval: 5
|
||||
exportFileCacheDuration: 600
|
||||
|
||||
# Legal URLs (optional)
|
||||
termsUrl: ""
|
||||
privacyUrl: ""
|
||||
imprintUrl: ""
|
||||
|
||||
# hCaptcha (optional)
|
||||
hcaptcha:
|
||||
siteKey: ""
|
||||
secret: ""
|
||||
existingSecret: ""
|
||||
secretKeyKey: "hcaptcha-secret"
|
||||
|
||||
# Debugging (not recommended for production)
|
||||
debug: false
|
||||
debugToolbar: false
|
||||
sqlDebug: false
|
||||
logLevel: "WARNING"
|
||||
gunicornLogLevel: "info"
|
||||
|
||||
# Environment variables (for additional configuration not covered above)
|
||||
# Use this for advanced configurations or settings not exposed in config section
|
||||
env: []
|
||||
# Example: Custom environment variable
|
||||
# - name: CUSTOM_VAR
|
||||
# value: "custom-value"
|
||||
#
|
||||
# Example: Complex SOCIALACCOUNT_PROVIDERS for multiple OIDC providers
|
||||
# - name: SOCIAL_PROVIDERS
|
||||
# value: "allauth.socialaccount.providers.openid_connect"
|
||||
# - name: SOCIALACCOUNT_PROVIDERS
|
||||
# value: '{"openid_connect":{"APPS":[{"provider_id":"authentik","name":"Authentik","client_id":"your-client-id","secret":"your-client-secret","settings":{"server_url":"https://authentik.company/application/o/tandoor/.well-known/openid-configuration"}}]}}'
|
||||
|
||||
# Extra environment variables from secrets (recommended for sensitive data)
|
||||
extraEnvFrom: []
|
||||
# - secretRef:
|
||||
# name: tandoor-extra-secrets
|
||||
Reference in New Issue
Block a user