mirror of
https://github.com/rtomik/helm-charts.git
synced 2026-04-05 09:40:38 +00:00
Helm chart for norish upgraded to work with new version 0.14.1
added redis config when upgrading refer to readme file
This commit is contained in:
@ -2,8 +2,8 @@ apiVersion: v2
|
|||||||
name: norish
|
name: norish
|
||||||
description: Norish helm chart for Kubernetes - A recipe management and meal planning application
|
description: Norish helm chart for Kubernetes - A recipe management and meal planning application
|
||||||
type: application
|
type: application
|
||||||
version: 0.0.3
|
version: 0.0.4
|
||||||
appVersion: "v0.13.6-beta"
|
appVersion: "v0.14.1-beta"
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: Richard Tomik
|
- name: Richard Tomik
|
||||||
email: no@m.com
|
email: no@m.com
|
||||||
|
|||||||
@ -6,7 +6,7 @@ A Helm chart for deploying [Norish](https://github.com/norishapp/norish), a reci
|
|||||||
|
|
||||||
This chart bootstraps a Norish deployment on a Kubernetes cluster using the Helm package manager.
|
This chart bootstraps a Norish deployment on a Kubernetes cluster using the Helm package manager.
|
||||||
|
|
||||||
**IMPORTANT: This chart requires a central PostgreSQL database.** You must have a PostgreSQL server available before deploying this chart. The chart does not include a PostgreSQL deployment.
|
**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).
|
**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).
|
||||||
|
|
||||||
@ -15,6 +15,7 @@ This chart bootstraps a Norish deployment on a Kubernetes cluster using the Helm
|
|||||||
- Kubernetes 1.19+
|
- Kubernetes 1.19+
|
||||||
- Helm 3.0+
|
- Helm 3.0+
|
||||||
- **PostgreSQL database server** (required)
|
- **PostgreSQL database server** (required)
|
||||||
|
- **Redis server** (required for v0.14.0+)
|
||||||
- PV provisioner support in the underlying infrastructure (if persistence is enabled)
|
- PV provisioner support in the underlying infrastructure (if persistence is enabled)
|
||||||
|
|
||||||
## Installing the Chart
|
## Installing the Chart
|
||||||
@ -49,13 +50,18 @@ Before deploying, you must configure:
|
|||||||
- Ensure the database exists before deployment
|
- Ensure the database exists before deployment
|
||||||
- Set appropriate credentials
|
- Set appropriate credentials
|
||||||
|
|
||||||
2. **Master Key**: A 32-byte base64-encoded encryption key
|
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
|
```bash
|
||||||
# Generate a master key
|
# Generate a master key
|
||||||
openssl rand -base64 32
|
openssl rand -base64 32
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Application URL**: Set `config.authUrl` to match your ingress hostname
|
4. **Application URL**: Set `config.authUrl` to match your ingress hostname
|
||||||
|
|
||||||
### Authentication Configuration
|
### Authentication Configuration
|
||||||
|
|
||||||
@ -88,6 +94,12 @@ database:
|
|||||||
username: norish
|
username: norish
|
||||||
password: "secure-password"
|
password: "secure-password"
|
||||||
|
|
||||||
|
redis:
|
||||||
|
host: "redis.default.svc.cluster.local"
|
||||||
|
port: 6379
|
||||||
|
database: 0
|
||||||
|
# Leave password empty if Redis has no authentication
|
||||||
|
|
||||||
config:
|
config:
|
||||||
authUrl: "https://norish.example.com"
|
authUrl: "https://norish.example.com"
|
||||||
masterKey:
|
masterKey:
|
||||||
@ -288,7 +300,7 @@ Or if using a centralized PostgreSQL Helm chart or service, ensure the database
|
|||||||
| Name | Description | Default |
|
| Name | Description | Default |
|
||||||
|------|-------------|---------|
|
|------|-------------|---------|
|
||||||
| `image.repository` | Norish image repository | `norishapp/norish` |
|
| `image.repository` | Norish image repository | `norishapp/norish` |
|
||||||
| `image.tag` | Norish image tag | `v0.13.6-beta` |
|
| `image.tag` | Norish image tag | `v0.14.1-beta` |
|
||||||
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
||||||
| `imagePullSecrets` | Image pull secrets | `[]` |
|
| `imagePullSecrets` | Image pull secrets | `[]` |
|
||||||
|
|
||||||
@ -366,6 +378,19 @@ Or if using a centralized PostgreSQL Helm chart or service, ensure the database
|
|||||||
| `database.databaseKey` | Key in secret for database name | `"database"` |
|
| `database.databaseKey` | Key in secret for database name | `"database"` |
|
||||||
| `database.hostKey` | Key in secret for host | `"host"` |
|
| `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)
|
### Chrome Headless Parameters (REQUIRED)
|
||||||
|
|
||||||
| Name | Description | Default |
|
| Name | Description | Default |
|
||||||
@ -533,6 +558,100 @@ To upgrade the chart:
|
|||||||
$ helm upgrade norish helm-charts/norish -f values.yaml
|
$ 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
|
## Support
|
||||||
|
|
||||||
- Norish Repository: https://github.com/norishapp/norish
|
- Norish Repository: https://github.com/norishapp/norish
|
||||||
|
|||||||
@ -55,3 +55,43 @@ Database connection URL
|
|||||||
{{- $database := .Values.database.name }}
|
{{- $database := .Values.database.name }}
|
||||||
{{- printf "postgres://%s:%s@%s:%d/%s" $username $password $host (int $port) $database }}
|
{{- printf "postgres://%s:%s@%s:%d/%s" $username $password $host (int $port) $database }}
|
||||||
{{- end }}
|
{{- 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 }}
|
||||||
|
|||||||
@ -145,6 +145,16 @@ spec:
|
|||||||
name: {{ include "norish.fullname" . }}-secret
|
name: {{ include "norish.fullname" . }}-secret
|
||||||
key: master-key
|
key: master-key
|
||||||
{{- end }}
|
{{- 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 }}
|
{{- if .Values.config.auth.oidc.enabled }}
|
||||||
- name: OIDC_NAME
|
- name: OIDC_NAME
|
||||||
value: {{ .Values.config.auth.oidc.name | quote }}
|
value: {{ .Values.config.auth.oidc.name | quote }}
|
||||||
|
|||||||
@ -12,6 +12,13 @@ stringData:
|
|||||||
{{- if not .Values.database.existingSecret }}
|
{{- if not .Values.database.existingSecret }}
|
||||||
database-url: {{ include "norish.databaseUrl" . | quote }}
|
database-url: {{ include "norish.databaseUrl" . | quote }}
|
||||||
{{- end }}
|
{{- 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 .Values.config.auth.oidc.enabled }}
|
||||||
{{- if not .Values.config.auth.oidc.existingSecret }}
|
{{- if not .Values.config.auth.oidc.existingSecret }}
|
||||||
oidc-client-id: {{ .Values.config.auth.oidc.clientId | quote }}
|
oidc-client-id: {{ .Values.config.auth.oidc.clientId | quote }}
|
||||||
|
|||||||
@ -5,7 +5,7 @@ fullnameOverride: ""
|
|||||||
## Image settings
|
## Image settings
|
||||||
image:
|
image:
|
||||||
repository: norishapp/norish
|
repository: norishapp/norish
|
||||||
tag: "v0.13.6-beta"
|
tag: "v0.14.1-beta"
|
||||||
pullPolicy: IfNotPresent
|
pullPolicy: IfNotPresent
|
||||||
|
|
||||||
imagePullSecrets: []
|
imagePullSecrets: []
|
||||||
@ -211,6 +211,24 @@ database:
|
|||||||
databaseKey: "database" # Key in the secret for database name (optional)
|
databaseKey: "database" # Key in the secret for database name (optional)
|
||||||
hostKey: "" # Key in the secret for database host (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)
|
## Chrome Headless configuration (REQUIRED)
|
||||||
## Required for improved recipe parsing and scraping
|
## Required for improved recipe parsing and scraping
|
||||||
chrome:
|
chrome:
|
||||||
|
|||||||
Reference in New Issue
Block a user