Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

feat(deploy): refactor Helm chart and drim docs to single kaneo image

randoneeringbfa651e78a37
diff --git a/apps/docs/core/installation/drim.mdx b/apps/docs/core/installation/drim.mdx
index 17617db34..fff82b76b 100644
--- a/apps/docs/core/installation/drim.mdx
+++ b/apps/docs/core/installation/drim.mdx
@@ -70,8 +70,7 @@ drim uninstall # Remove Kaneo
When you run `drim setup`, the following services are deployed:
- **PostgreSQL 16** - Database
-- **Kaneo API** - Backend service
-- **Kaneo Web** - Frontend interface
+- **Kaneo** - Combined API and web frontend in a single container
- **Caddy** - Reverse proxy with automatic HTTPS
All services run in Docker containers with proper networking and health checks.
diff --git a/charts/kaneo/Chart.yaml b/charts/kaneo/Chart.yaml
index 2dff245a8..01f1fc7ee 100644
--- a/charts/kaneo/Chart.yaml
+++ b/charts/kaneo/Chart.yaml
@@ -2,10 +2,9 @@ apiVersion: v2
name: kaneo
description: Kaneo - All you need. Nothing you don't. Open source project management that works for you.
type: application
-# Bumped to 0.2.0 due to breaking auth and probe changes
-version: 0.2.0
-# Bumped to the latest v2 release
-appVersion: "2.3.5"
+# Bumped to 0.3.0 — breaking: api/web values collapsed into kaneo, single container
+version: 0.3.0
+appVersion: "2.6.0"
keywords:
- project-management
- kanban
diff --git a/charts/kaneo/templates/NOTES.txt b/charts/kaneo/templates/NOTES.txt
index 354d668a8..8f08aa940 100644
--- a/charts/kaneo/templates/NOTES.txt
+++ b/charts/kaneo/templates/NOTES.txt
@@ -12,12 +12,6 @@ You can access the application using these URLs:
{{- range .Values.ingress.hosts }}
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .host }}
{{- end }}
-
-Note: This chart uses path patterns with regex capture groups for nginx:
- - /?(.*) -> for web frontend
- - /api/?(.*) -> for API requests
-Make sure your ingress controller supports the configured annotations:
- nginx.ingress.kubernetes.io/rewrite-target: /$1
{{- else if .Values.gateway.enabled }}
An HTTPRoute has been created for Gateway API.
@@ -33,15 +27,13 @@ No hostnames were set on the HTTPRoute. Configure .Values.gateway.hostnames if y
Attach the route by setting .Values.gateway.parentRefs to your Gateway listener references.
{{- else }}
-To access the application, you need to set up port forwarding to both services:
+To access the application, set up port forwarding:
-$ kubectl port-forward svc/{{ include "kaneo.fullname" . }}-web 5173:{{ .Values.web.service.port }} -n {{ .Release.Namespace }} &
-$ kubectl port-forward svc/{{ include "kaneo.fullname" . }}-api 1337:{{ .Values.api.service.port }} -n {{ .Release.Namespace }} &
+$ kubectl port-forward svc/{{ include "kaneo.fullname" . }}-kaneo 5173:{{ .Values.kaneo.service.port }} -n {{ .Release.Namespace }}
Then access the application at http://localhost:5173
-The web frontend will communicate with the API at http://localhost:1337
-Alternatively, you can expose the services using an Ingress by setting .Values.ingress.enabled=true
+Alternatively, expose the service using an Ingress by setting .Values.ingress.enabled=true
or Gateway API by setting .Values.gateway.enabled=true
{{- end }}
@@ -59,23 +51,11 @@ NOTES:
{{- end }}
2. Important environment variables:
- - API:
- - AUTH_SECRET: Secret key for Better Auth (currently set to: {{ .Values.api.env.authSecret }})
- - DATABASE_URL: Connection string for the database
-
- - Web:
- - KANEO_API_URL: URL of the API service (set to: "{{- if .Values.web.env.apiUrl -}}
- {{- if hasSuffix "/" .Values.web.env.apiUrl -}}
- {{- .Values.web.env.apiUrl -}}api
- {{- else -}}
- {{- .Values.web.env.apiUrl -}}/api
- {{- end -}}
- {{- else -}}
- http://localhost:{{ .Values.api.service.targetPort }}
- {{- end -}}")
+ - AUTH_SECRET: Secret key for Better Auth (currently set to: {{ .Values.kaneo.env.authSecret }})
+ - KANEO_CLIENT_URL: Public URL of this instance (currently set to: "{{ .Values.kaneo.env.clientUrl }}")
+ - DATABASE_URL: Derived from postgresql.auth values unless kaneo.env.database.external.enabled=true
You can customize these values in your values.yaml file.
-3. IMPORTANT: This chart uses a combined pod approach where both the API and Web containers
- run in the same pod. This allows the web frontend to connect directly to the API via
- localhost, simplifying the deployment and eliminating cross-origin issues.
+3. The kaneo image combines the API and web frontend in a single container.
+ nginx runs on port 5173 and proxies /api/ requests to the internal Node API.
diff --git a/charts/kaneo/templates/deployment.yaml b/charts/kaneo/templates/deployment.yaml
index 59de5edba..c483de72f 100644
--- a/charts/kaneo/templates/deployment.yaml
+++ b/charts/kaneo/templates/deployment.yaml
@@ -24,101 +24,50 @@ spec:
securityContext:
{{- toYaml .Values.podSecurityContext | nindent 8 }}
containers:
- - name: api
+ - name: kaneo
securityContext:
- {{- toYaml .Values.api.securityContext | nindent 12 }}
- image: "{{ .Values.api.image.repository }}:{{ .Values.api.image.tag | default .Chart.AppVersion }}"
- imagePullPolicy: {{ .Values.api.image.pullPolicy }}
+ {{- toYaml .Values.kaneo.securityContext | nindent 12 }}
+ image: "{{ .Values.kaneo.image.repository }}:{{ .Values.kaneo.image.tag | default .Chart.AppVersion }}"
+ imagePullPolicy: {{ .Values.kaneo.image.pullPolicy }}
ports:
- - name: api
- containerPort: {{ .Values.api.service.targetPort }}
+ - name: kaneo
+ containerPort: {{ .Values.kaneo.service.targetPort }}
protocol: TCP
env:
- # Updated to support Better Auth
- - name: BETTER_AUTH_SECRET
- {{- if .Values.api.env.existingSecret.enabled }}
- valueFrom:
- secretKeyRef:
- name: {{ .Values.api.env.existingSecret.name }}
- key: {{ .Values.api.env.existingSecret.key }}
- {{- else }}
- value: "{{ .Values.api.env.authSecret }}"
- {{- end }}
+ - name: KANEO_CLIENT_URL
+ value: "{{ .Values.kaneo.env.clientUrl }}"
- name: AUTH_SECRET
- {{- if .Values.api.env.existingSecret.enabled }}
+ {{- if .Values.kaneo.env.existingSecret.enabled }}
valueFrom:
secretKeyRef:
- name: {{ .Values.api.env.existingSecret.name }}
- key: {{ .Values.api.env.existingSecret.key }}
+ name: {{ .Values.kaneo.env.existingSecret.name }}
+ key: {{ .Values.kaneo.env.existingSecret.key }}
{{- else }}
- value: "{{ .Values.api.env.authSecret }}"
+ value: "{{ .Values.kaneo.env.authSecret }}"
{{- end }}
- - name: BETTER_AUTH_URL
- value: "{{- if .Values.web.env.apiUrl -}}
- {{ .Values.web.env.apiUrl }}
- {{- else -}}
- http://localhost:{{ .Values.api.service.targetPort }}
- {{- end -}}"
- - name: KANEO_API_URL
- value: "{{- if .Values.web.env.apiUrl -}}
- {{- .Values.web.env.apiUrl -}}
- {{- else -}}
- http://localhost:{{ .Values.api.service.targetPort }}
- {{- end -}}"
- - name: KANEO_CLIENT_URL
- value: "{{- if .Values.web.env.apiUrl -}}
- {{- .Values.web.env.apiUrl -}}
- {{- else -}}
- http://localhost:{{ .Values.web.service.targetPort }}
- {{- end -}}"
- - name: CORS_ORIGINS
- value: "{{ .Values.web.env.apiUrl | default "*" }}"
- name: DATABASE_URL
- {{- if .Values.api.env.database.external.enabled }}
- {{- if .Values.api.env.database.external.existingSecret.enabled }}
+ {{- if .Values.kaneo.env.database.external.enabled }}
+ {{- if .Values.kaneo.env.database.external.existingSecret.enabled }}
valueFrom:
secretKeyRef:
- name: {{ .Values.api.env.database.external.existingSecret.name }}
- key: {{ .Values.api.env.database.external.existingSecret.passwordKey }}
+ name: {{ .Values.kaneo.env.database.external.existingSecret.name }}
+ key: {{ .Values.kaneo.env.database.external.existingSecret.passwordKey }}
{{- else }}
- value: "postgresql://{{ .Values.api.env.database.external.username }}:{{ .Values.api.env.database.external.password }}@{{ .Values.api.env.database.external.host }}:{{ .Values.api.env.database.external.port }}/{{ .Values.api.env.database.external.database }}"
+ value: "postgresql://{{ .Values.kaneo.env.database.external.username }}:{{ .Values.kaneo.env.database.external.password }}@{{ .Values.kaneo.env.database.external.host }}:{{ .Values.kaneo.env.database.external.port }}/{{ .Values.kaneo.env.database.external.database }}"
{{- end }}
{{- else }}
value: "postgresql://{{ .Values.postgresql.auth.username }}:{{ .Values.postgresql.auth.password }}@{{ include "kaneo.fullname" . }}-postgresql:{{ .Values.postgresql.service.port }}/{{ .Values.postgresql.auth.database }}"
{{- end }}
- name: DISABLE_REGISTRATION
- value: {{ .Values.api.env.disableRegistration | quote }}
+ value: {{ .Values.kaneo.env.disableRegistration | quote }}
- name: DISABLE_PASSWORD_REGISTRATION
- value: {{ .Values.api.env.disablePasswordRegistration | quote }}
- livenessProbe:
- {{- toYaml .Values.api.livenessProbe | nindent 12 }}
- readinessProbe:
- {{- toYaml .Values.api.readinessProbe | nindent 12 }}
- resources:
- {{- toYaml .Values.api.resources | nindent 12 }}
-
- - name: web
- securityContext:
- {{- toYaml .Values.web.securityContext | nindent 12 }}
- image: "{{ .Values.web.image.repository }}:{{ .Values.web.image.tag | default .Chart.AppVersion }}"
- imagePullPolicy: {{ .Values.web.image.pullPolicy }}
- ports:
- - name: web
- containerPort: 5173
- protocol: TCP
- env:
- - name: KANEO_API_URL
- value: "{{- if .Values.web.env.apiUrl -}}
- {{- .Values.web.env.apiUrl -}}
- {{- else -}}
- http://localhost:{{ .Values.api.service.targetPort }}
- {{- end -}}"
+ value: {{ .Values.kaneo.env.disablePasswordRegistration | quote }}
livenessProbe:
- {{- toYaml .Values.web.livenessProbe | nindent 12 }}
+ {{- toYaml .Values.kaneo.livenessProbe | nindent 12 }}
readinessProbe:
- {{- toYaml .Values.web.readinessProbe | nindent 12 }}
+ {{- toYaml .Values.kaneo.readinessProbe | nindent 12 }}
resources:
- {{- toYaml .Values.web.resources | nindent 12 }}
+ {{- toYaml .Values.kaneo.resources | nindent 12 }}
{{- with .Values.nodeSelector }}
nodeSelector:
diff --git a/charts/kaneo/templates/services.yaml b/charts/kaneo/templates/services.yaml
index 1c0cf287e..1621365ba 100644
--- a/charts/kaneo/templates/services.yaml
+++ b/charts/kaneo/templates/services.yaml
@@ -1,35 +1,16 @@
-# API Service
+# Kaneo Service
apiVersion: v1
kind: Service
metadata:
- name: {{ include "kaneo.fullname" . }}-api
+ name: {{ include "kaneo.fullname" . }}-kaneo
labels:
{{- include "kaneo.labels" . | nindent 4 }}
- app.kubernetes.io/component: api
+ app.kubernetes.io/component: kaneo
spec:
- type: {{ .Values.api.service.type }}
+ type: {{ .Values.kaneo.service.type }}
ports:
- - port: {{ .Values.api.service.port }}
- targetPort: api
- protocol: TCP
- name: http
- selector:
- {{- include "kaneo.selectorLabels" . | nindent 4 }}
-
----
-# Web Service
-apiVersion: v1
-kind: Service
-metadata:
- name: {{ include "kaneo.fullname" . }}-web
- labels:
- {{- include "kaneo.labels" . | nindent 4 }}
- app.kubernetes.io/component: web
-spec:
- type: {{ .Values.web.service.type }}
- ports:
- - port: {{ .Values.web.service.port }}
- targetPort: web
+ - port: {{ .Values.kaneo.service.port }}
+ targetPort: kaneo
protocol: TCP
name: http
selector:
diff --git a/charts/kaneo/values.yaml b/charts/kaneo/values.yaml
index a1f99b3a7..d47ba991b 100644
--- a/charts/kaneo/values.yaml
+++ b/charts/kaneo/values.yaml
@@ -57,17 +57,17 @@ postgresql:
# requests:
# cpu: 100m
# memory: 128Mi
-# API backend configuration
-api:
+# Kaneo application configuration (combined API + web frontend)
+kaneo:
image:
- repository: ghcr.io/usekaneo/api
+ repository: ghcr.io/usekaneo/kaneo
tag: latest
pullPolicy: IfNotPresent
securityContext: {}
service:
type: ClusterIP
- port: 1337
- targetPort: 1337
+ port: 5173
+ targetPort: 5173
# Resources are optional and disabled by default
resources: {}
# resources:
@@ -78,9 +78,12 @@ api:
# cpu: 100m
# memory: 128Mi
- # Environment variables for the API
env:
+ # Public URL of this Kaneo instance (e.g. https://kaneo.example.com)
+ # KANEO_API_URL is derived automatically as clientUrl/api if not set
+ clientUrl: ""
# Must be at least 32 characters long for Better Auth
+ # Generate with: openssl rand -hex 32
authSecret: change_me_to_at_least_32_characters_long_string
existingSecret:
enabled: false
@@ -114,80 +117,27 @@ api:
livenessProbe:
httpGet:
path: /api/health
- port: api
- initialDelaySeconds: 30
+ port: kaneo
+ initialDelaySeconds: 60
periodSeconds: 10
readinessProbe:
httpGet:
path: /api/health
- port: api
- initialDelaySeconds: 5
+ port: kaneo
+ initialDelaySeconds: 30
periodSeconds: 10
-# Web frontend configuration
-web:
- image:
- repository: ghcr.io/usekaneo/web
- tag: latest
- pullPolicy: IfNotPresent
- # Environment variables for the Web
- env:
- # Optional: Override the default API URL (http://localhost:1337)
- # The /api path will be automatically appended to the URL
- # Make sure this url matches the ingress host
- # apiUrl: "https://kaneo.example.com"
- apiUrl: ""
- securityContext: {}
- service:
- type: ClusterIP
- port: 80
- targetPort: 5173 # FIX: Correctly maps the service to the unprivileged Nginx port
- # Resources are optional and disabled by default
- resources: {}
- # resources:
- # limits:
- # cpu: 300m
- # memory: 256Mi
- # requests:
- # cpu: 100m
- # memory: 128Mi
-
-# livenessProbe:
-# httpGet:
-# path: /
-# port: web
-# initialDelaySeconds: 90
-# periodSeconds: 10
-# readinessProbe:
-# httpGet:
-# path: /
-# port: web
-# initialDelaySeconds: 60
-# periodSeconds: 10
# Ingress configuration
ingress:
enabled: false
className: nginx
- annotations:
- nginx.ingress.kubernetes.io/rewrite-target: /$1
- nginx.ingress.kubernetes.io/use-regex: "true"
- ## optional: use cert-manager to automatically provision a TLS certificate
- # cert-manager.io/cluster-issuer: letsencrypt
- # When using nginx ingress controller, these annotations provide URL rewriting
- # similar to the URLRewrite filter in the Gateway API
- # Other ingress controllers may require different annotations, handle carefully
- # because it can break the API calls from the frontend to the backend
+ annotations: {}
hosts:
- # Use the same host in the web env variable apiUrl (with http:// or https://)
- host: kaneo.local
paths:
- - path: /?(.*)
- pathType: ImplementationSpecific
- service: web
- port: 80
- - path: /api/?(.*)
- pathType: ImplementationSpecific
- service: api
- port: 1337
+ - path: /
+ pathType: Prefix
+ service: kaneo
+ port: 5173
tls: []
# Gateway API configuration
@@ -198,23 +148,10 @@ gateway:
parentRefs: []
hostnames: []
rules:
- - matches:
- - path:
- type: PathPrefix
- value: /api
- filters:
- - type: URLRewrite
- urlRewrite:
- path:
- type: ReplacePrefixMatch
- replacePrefixMatch: /
- backendRefs:
- - service: api
- port: 1337
- matches:
- path:
type: PathPrefix
value: /
backendRefs:
- - service: web
- port: 80
+ - service: kaneo
+ port: 5173