diff --git a/charts/helm/checkmate/Chart.yaml b/charts/helm/checkmate/Chart.yaml index 286f1c908..e6b221204 100644 --- a/charts/helm/checkmate/Chart.yaml +++ b/charts/helm/checkmate/Chart.yaml @@ -2,9 +2,5 @@ apiVersion: v2 name: checkmate-chart description: A Helm chart for Checkmate App type: application -version: 0.2.0 -# DO NOT bump appVersion past v3.8.1 until this chart is migrated to the all-in-one -# image (ghcr.io/bluewave-labs/checkmate). The checkmate-client / checkmate-backend / -# checkmate-mongo images this chart references are frozen at v3.8.1 — later versions -# are never published, so a bumped chart will fail to pull. -appVersion: "v3.8.1" # "v" prefix: published image tags are v-prefixed (ghcr.io/.../checkmate-*:v3.8.1) +version: 0.3.0 +appVersion: "latest" # the all-in-one image publishes :latest on release tags; pin a version here to freeze diff --git a/charts/helm/checkmate/INSTALLATION.md b/charts/helm/checkmate/INSTALLATION.md index 6bc1f3ecd..ab993d17c 100644 --- a/charts/helm/checkmate/INSTALLATION.md +++ b/charts/helm/checkmate/INSTALLATION.md @@ -19,8 +19,8 @@ cd checkmate/charts/helm/checkmate ### 2. Customize values.yaml Edit `values.yaml` to update: -- `client.ingress.host` and `api.ingress.host` with your domain names -- `api.protocol` (usually http or https) +- `app.ingress.host` with your domain name +- `app.protocol` (usually http or https) - **If upgrading**: Migrate persistence settings from flat structure to nested: - Old: `persistence.mongodbSize` → New: `persistence.mongo.size` - Add: `persistence.mongo.storageClass` (leave empty for default) @@ -95,7 +95,7 @@ chart. You can still pin per tier: ```yaml api: - image: ghcr.io/bluewave-labs/checkmate-backend # repo only + image: ghcr.io/bluewave-labs/checkmate # repo only tag: "" # empty → Chart.appVersion; set e.g. "v3.1.0" to pin, or "latest" for a dev tag ``` @@ -244,3 +244,41 @@ kubectl get secrets | grep checkmate-tls ``` The ingress will automatically use these secrets to enable HTTPS access to your Checkmate instance. + +## Upgrading to chart 0.3.0 (all-in-one image) + +Checkmate now ships as a single image that serves both the client and the API, so +the chart deploys one workload and one ingress instead of two. + +**What changed** + +| 0.2.x | 0.3.0 | +|---|---| +| `client.*` + `api.*` value blocks | one `app.*` block | +| `checkmate-client` + `checkmate-backend` images | `ghcr.io/bluewave-labs/checkmate` | +| `ghcr.io/bluewave-labs/checkmate-mongo` | upstream `mongo:8.0` | +| Deployment `checkmate-api` + `checkmate-client` | Deployment `checkmate` | +| Ingress `checkmate-api-ingress` (`/api/v1`) + client ingress (`/`) | Ingress `checkmate-ingress` (`/`) | +| `UPTIME_APP_API_BASE_URL`, `UPTIME_APP_CLIENT_HOST` | not set — the client is same-origin | + +`appVersion` is no longer frozen at v3.8.1; the chart tracks the published image again. + +**Upgrading an existing install** + +Existing `client.*`, `api.*` and `server.*` overrides are still read and merged over +the `app.*` defaults, so most values files upgrade without edits. Two cases fail +deliberately rather than deploying something wrong: + +- `client.image` set — that image is no longer published, so the chart stops instead + of leaving you with an ImagePullBackOff. Remove the `client:` block. +- `client.ingress.host` and `api.ingress.host` set to *different* hosts — one origin + now serves both, so the chart cannot honour a split. Set a single `app.ingress.host`. + +Migrate overrides to `app.*` when convenient; the legacy blocks are transitional. + +**One ingress, one host** + +If you previously served the client and API on separate hostnames, external clients +now use the single `app.ingress.host`. Update any bookmarks, uptime checks, or DNS +records that pointed at the old API hostname. + diff --git a/charts/helm/checkmate/templates/_helpers.tpl b/charts/helm/checkmate/templates/_helpers.tpl index 69a1b259b..31b01491b 100644 --- a/charts/helm/checkmate/templates/_helpers.tpl +++ b/charts/helm/checkmate/templates/_helpers.tpl @@ -1,18 +1,41 @@ {{- /* -Back-compat shim: the `server.*` value block was renamed to `api.*`. Existing installs that -still pass a legacy `server:` block keep working — this returns the effective API values with any -legacy `server.*` overrides merged on top of the `api.*` defaults (legacy wins where set). +Back-compat shim for the all-in-one image migration. -New installs have no `server:` key, so this is a no-op deepCopy of `.Values.api`. Consume it as: - {{- $api := include "checkmate.api" . | fromYaml -}} -then reference `$api.*` instead of `.Values.api.*`. +Chart 0.2.x deployed a separate client and API, configured through `client.*` and +`api.*` (and, before that, `server.*`). Checkmate now ships one image that serves +both, so those collapse into a single `app.*` block. + +Existing installs keep working: any legacy block is merged over the `app.*` +defaults, in the order client -> api -> server, so a value set in an older block +still wins. Only `image`/`tag` are deliberately NOT inherited from `client.*` — +that repo (checkmate-client) is no longer published, so honouring it would pin an +install to an image that cannot be pulled. + +New installs have no legacy keys and this is a no-op deepCopy of `.Values.app`. +Consume it as: + {{- $app := include "checkmate.app" . | fromYaml -}} +*/}} +{{- define "checkmate.app" -}} +{{- $app := deepCopy .Values.app -}} +{{- with .Values.client -}} +{{- $legacy := omit (deepCopy .) "image" "tag" "port" -}} +{{- $app = mergeOverwrite $app $legacy -}} +{{- end -}} +{{- with .Values.api -}} +{{- $app = mergeOverwrite $app (deepCopy .) -}} +{{- end -}} +{{- with .Values.server -}} +{{- $app = mergeOverwrite $app (deepCopy .) -}} +{{- end -}} +{{- $app | toYaml -}} +{{- end -}} + +{{- /* +Deprecated alias kept so any out-of-tree template referencing `checkmate.api` +still resolves. Prefer `checkmate.app`. */}} {{- define "checkmate.api" -}} -{{- $api := deepCopy .Values.api -}} -{{- with .Values.server -}} -{{- $api = mergeOverwrite $api (deepCopy .) -}} -{{- end -}} -{{- $api | toYaml -}} +{{- include "checkmate.app" . -}} {{- end -}} {{- /* diff --git a/charts/helm/checkmate/templates/api/deployment.yaml b/charts/helm/checkmate/templates/api/deployment.yaml deleted file mode 100644 index 6469d3bdd..000000000 --- a/charts/helm/checkmate/templates/api/deployment.yaml +++ /dev/null @@ -1,65 +0,0 @@ -{{- $api := include "checkmate.api" . | fromYaml -}} -apiVersion: apps/v1 -kind: Deployment -metadata: - name: checkmate-api -spec: - replicas: 1 # single scheduler — seeds/reconciles the jobs collection - selector: - matchLabels: - app: checkmate-api - template: - metadata: - labels: - app: checkmate-api - spec: - {{- with $api.affinity }} - affinity: - {{- tpl ( . | toYaml) $ | nindent 8 }} - {{- end }} - {{- with $api.tolerations }} - tolerations: - {{- tpl ( . | toYaml) $ | nindent 8 }} - {{- end }} - containers: - - name: api - image: {{ include "checkmate.image" (dict "image" $api.image "tag" $api.tag "root" $) }} - imagePullPolicy: {{ $api.imagePullPolicy }} - ports: - - name: http - containerPort: {{ $api.port }} - envFrom: - - secretRef: - name: checkmate-secrets - # Probes hit the Express /api/v1/health endpoint — proves the HTTP server is responsive. - # NOTE: this does NOT detect a wedged job loop when queuePrimaryProcesses=true (the API is - # also a worker). Worker-aware health for that mode is a follow-up — see worker-health-checks.md §7.5. - livenessProbe: - httpGet: - path: /api/v1/health - port: http - initialDelaySeconds: {{ $api.probes.liveness.initialDelaySeconds }} - periodSeconds: {{ $api.probes.liveness.periodSeconds }} - timeoutSeconds: {{ $api.probes.liveness.timeoutSeconds }} - failureThreshold: {{ $api.probes.liveness.failureThreshold }} - readinessProbe: - httpGet: - path: /api/v1/health - port: http - initialDelaySeconds: {{ $api.probes.readiness.initialDelaySeconds }} - periodSeconds: {{ $api.probes.readiness.periodSeconds }} - timeoutSeconds: {{ $api.probes.readiness.timeoutSeconds }} - failureThreshold: {{ $api.probes.readiness.failureThreshold }} - {{- with $api.resources }} - resources: - {{- tpl ( . | toYaml) $ | nindent 12 }} - {{- end }} - env: - - name: CLIENT_HOST - value: "{{ .Values.client.protocol }}://{{ .Values.client.ingress.host }}" - - name: QUEUE_MODE - value: "primary" - # Derived: when a worker tier is deployed the API only schedules (false); otherwise it is - # all-in-one and processes jobs itself (true). Keeps the two from ever competing for jobs. - - name: QUEUE_PRIMARY_PROCESSES - value: {{ not .Values.worker.enabled | quote }} diff --git a/charts/helm/checkmate/templates/api/ingress.yaml b/charts/helm/checkmate/templates/api/ingress.yaml deleted file mode 100644 index ae60889f2..000000000 --- a/charts/helm/checkmate/templates/api/ingress.yaml +++ /dev/null @@ -1,39 +0,0 @@ -{{- $api := include "checkmate.api" . | fromYaml -}} -{{- if $api.ingress.enabled }} -apiVersion: networking.k8s.io/v1 -kind: Ingress -metadata: - name: checkmate-api-ingress - {{- if $api.ingress.annotations }} - annotations: - {{- range $key, $value := $api.ingress.annotations }} - {{ $key }}: {{ $value | quote }} - {{- end }} - {{- end }} - {{/*#annotations: - #nginx.ingress.kubernetes.io/rewrite-target: / - #nginx.ingress.kubernetes.io/enable-cors: "true" - #nginx.ingress.kubernetes.io/cors-allow-origin: "http://{{ .Values.client.ingress.host }},https://{{ .Values.client.ingress.host }}" - #nginx.ingress.kubernetes.io/cors-allow-methods: "GET, PUT, POST, DELETE, PATCH, OPTIONS" - #nginx.ingress.kubernetes.io/cors-allow-headers: "DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization" - #nginx.ingress.kubernetes.io/cors-allow-credentials: "true"*/}} -spec: - ingressClassName: {{ $api.ingress.className }} - {{- if $api.ingress.tls.enabled }} - tls: - - hosts: - - {{ $api.ingress.host }} - secretName: {{ default (printf "%s-api-tls" .Release.Name) $api.ingress.tls.secretName }} - {{- end }} - rules: - - host: {{ $api.ingress.host }} - http: - paths: - - path: /api/v1 - pathType: Prefix - backend: - service: - name: checkmate-api - port: - number: {{ $api.port }} -{{- end }} diff --git a/charts/helm/checkmate/templates/api/service.yaml b/charts/helm/checkmate/templates/api/service.yaml deleted file mode 100644 index dfea901c4..000000000 --- a/charts/helm/checkmate/templates/api/service.yaml +++ /dev/null @@ -1,10 +0,0 @@ -{{- $api := include "checkmate.api" . | fromYaml -}} -apiVersion: v1 -kind: Service -metadata: - name: checkmate-api -spec: - selector: - app: checkmate-api - ports: - - port: {{ $api.port }} diff --git a/charts/helm/checkmate/templates/app/deployment.yaml b/charts/helm/checkmate/templates/app/deployment.yaml new file mode 100644 index 000000000..3a10ca295 --- /dev/null +++ b/charts/helm/checkmate/templates/app/deployment.yaml @@ -0,0 +1,71 @@ +{{- $app := include "checkmate.app" . | fromYaml -}} +apiVersion: apps/v1 +kind: Deployment +metadata: + name: checkmate +spec: + replicas: 1 # single scheduler — seeds/reconciles the jobs collection + selector: + matchLabels: + app: checkmate + template: + metadata: + labels: + app: checkmate + spec: + {{- with $app.affinity }} + affinity: + {{- tpl ( . | toYaml) $ | nindent 8 }} + {{- end }} + {{- with $app.tolerations }} + tolerations: + {{- tpl ( . | toYaml) $ | nindent 8 }} + {{- end }} + containers: + - name: checkmate + image: {{ include "checkmate.image" (dict "image" $app.image "tag" $app.tag "root" $) }} + imagePullPolicy: {{ $app.imagePullPolicy }} + ports: + - name: http + containerPort: {{ $app.port }} + envFrom: + - secretRef: + name: checkmate-secrets + # Probes hit the Express /api/v1/health endpoint — proves the HTTP server is responsive. + # NOTE: this does NOT detect a wedged job loop when queuePrimaryProcesses=true (the app is + # also a worker). Worker-aware health for that mode is a follow-up — see worker-health-checks.md §7.5. + livenessProbe: + httpGet: + path: /api/v1/health + port: http + initialDelaySeconds: {{ $app.probes.liveness.initialDelaySeconds }} + periodSeconds: {{ $app.probes.liveness.periodSeconds }} + timeoutSeconds: {{ $app.probes.liveness.timeoutSeconds }} + failureThreshold: {{ $app.probes.liveness.failureThreshold }} + readinessProbe: + httpGet: + path: /api/v1/health + port: http + initialDelaySeconds: {{ $app.probes.readiness.initialDelaySeconds }} + periodSeconds: {{ $app.probes.readiness.periodSeconds }} + timeoutSeconds: {{ $app.probes.readiness.timeoutSeconds }} + failureThreshold: {{ $app.probes.readiness.failureThreshold }} + {{- with $app.resources }} + resources: + {{- tpl ( . | toYaml) $ | nindent 12 }} + {{- end }} + env: + # The client is served from this same origin, so CLIENT_HOST defaults to + # the app's own ingress URL. `env` takes precedence over `envFrom`, so an + # explicit secrets.CLIENT_HOST is honoured by omitting this entry rather + # than emitting a value that would silently win over it. + {{- if not (hasKey .Values.secrets "CLIENT_HOST") }} + - name: CLIENT_HOST + value: "{{ $app.protocol }}://{{ $app.ingress.host }}" + {{- end }} + - name: QUEUE_MODE + value: "primary" + # Derived: when a worker tier is deployed the app only schedules (false); otherwise it is + # all-in-one and processes jobs itself (true). Keeps the two from ever competing for jobs. + - name: QUEUE_PRIMARY_PROCESSES + value: {{ not .Values.worker.enabled | quote }} diff --git a/charts/helm/checkmate/templates/app/ingress.yaml b/charts/helm/checkmate/templates/app/ingress.yaml new file mode 100644 index 000000000..8416fec2d --- /dev/null +++ b/charts/helm/checkmate/templates/app/ingress.yaml @@ -0,0 +1,35 @@ +{{- $app := include "checkmate.app" . | fromYaml -}} +{{- if $app.ingress.enabled }} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: checkmate-ingress + {{- if $app.ingress.annotations }} + annotations: + {{- range $key, $value := $app.ingress.annotations }} + {{ $key }}: {{ $value | quote }} + {{- end }} + {{- end }} +spec: + ingressClassName: {{ $app.ingress.className }} + {{- if $app.ingress.tls.enabled }} + tls: + - hosts: + - {{ $app.ingress.host }} + secretName: {{ default (printf "%s-tls" .Release.Name) $app.ingress.tls.secretName }} + {{- end }} + rules: + - host: {{ $app.ingress.host }} + http: + paths: + # The application serves both the client and /api/v1 from one origin, so + # a single root rule replaces the separate client and API ingresses. No + # CORS annotations are needed now that the browser is same-origin. + - path: / + pathType: Prefix + backend: + service: + name: checkmate + port: + number: {{ $app.port }} +{{- end }} diff --git a/charts/helm/checkmate/templates/app/service.yaml b/charts/helm/checkmate/templates/app/service.yaml new file mode 100644 index 000000000..12e100e20 --- /dev/null +++ b/charts/helm/checkmate/templates/app/service.yaml @@ -0,0 +1,10 @@ +{{- $app := include "checkmate.app" . | fromYaml -}} +apiVersion: v1 +kind: Service +metadata: + name: checkmate +spec: + selector: + app: checkmate + ports: + - port: {{ $app.port }} diff --git a/charts/helm/checkmate/templates/client/deployment.yaml b/charts/helm/checkmate/templates/client/deployment.yaml deleted file mode 100644 index a98e6a648..000000000 --- a/charts/helm/checkmate/templates/client/deployment.yaml +++ /dev/null @@ -1,46 +0,0 @@ -{{- $api := include "checkmate.api" . | fromYaml -}} -apiVersion: apps/v1 -kind: Deployment -metadata: - name: checkmate-client -spec: - replicas: 1 - selector: - matchLabels: - app: checkmate-client - template: - metadata: - labels: - app: checkmate-client - spec: - {{- with .Values.client.affinity }} - affinity: - {{- tpl ( . | toYaml) $ | nindent 8 }} - {{- end }} - {{- with .Values.client.tolerations }} - tolerations: - {{- tpl ( . | toYaml) $ | nindent 8 }} - {{- end }} - containers: - - name: client - image: {{ include "checkmate.image" (dict "image" .Values.client.image "tag" .Values.client.tag "root" $) }} - imagePullPolicy: {{ .Values.client.imagePullPolicy }} - ports: - - containerPort: {{ .Values.client.port }} - env: - - name: UPTIME_APP_API_BASE_URL - value: "{{ $api.protocol }}://{{ $api.ingress.host }}/api/v1" - - name: UPTIME_APP_CLIENT_HOST - value: "{{ .Values.client.protocol }}://{{ .Values.client.ingress.host }}" - volumeMounts: - - name: config-volume - mountPath: /etc/nginx/conf.d/default.conf - subPath: default.conf - {{- with .Values.client.resources }} - resources: - {{- tpl ( . | toYaml) $ | nindent 12 }} - {{- end }} - volumes: - - name: config-volume - configMap: - name: checkmate-client-nginx-cm diff --git a/charts/helm/checkmate/templates/client/ingress.yaml b/charts/helm/checkmate/templates/client/ingress.yaml deleted file mode 100644 index 4fe126ea6..000000000 --- a/charts/helm/checkmate/templates/client/ingress.yaml +++ /dev/null @@ -1,31 +0,0 @@ -{{- if .Values.client.ingress.enabled }} -apiVersion: networking.k8s.io/v1 -kind: Ingress -metadata: - name: checkmate-client-ingress - {{- if .Values.client.ingress.annotations }} - annotations: - {{- range $key, $value := .Values.client.ingress.annotations }} - {{ $key }}: {{ $value | quote }} - {{- end }} - {{- end }} -spec: - ingressClassName: {{ .Values.client.ingress.className }} - {{- if .Values.client.ingress.tls.enabled }} - tls: - - hosts: - - {{ .Values.client.ingress.host }} - secretName: {{ default (printf "%s-client-tls" .Release.Name) .Values.client.ingress.tls.secretName }} - {{- end }} - rules: - - host: {{ .Values.client.ingress.host }} - http: - paths: - - path: / - pathType: Prefix - backend: - service: - name: checkmate-client - port: - number: {{ .Values.client.port }} -{{- end }} diff --git a/charts/helm/checkmate/templates/client/nginx-cm.yaml b/charts/helm/checkmate/templates/client/nginx-cm.yaml deleted file mode 100644 index 0d23aac0a..000000000 --- a/charts/helm/checkmate/templates/client/nginx-cm.yaml +++ /dev/null @@ -1,42 +0,0 @@ -{{- $api := include "checkmate.api" . | fromYaml -}} -apiVersion: v1 -kind: ConfigMap -metadata: - name: checkmate-client-nginx-cm -data: - default.conf: | - server { - listen 80; - listen [::]:80; - - server_name checkmate-demo.bluewavelabs.ca; - server_tokens off; - - location /.well-known/acme-challenge/ { - root /var/www/certbot; - } - - location / { - root /usr/share/nginx/html; - index index.html index.htm; - try_files $uri $uri/ /index.html; - } - - # location /api/ { - # proxy_pass http://{{ $api.ingress.host }}:5000/api/; - # proxy_http_version 1.1; - # proxy_set_header Host $host; - # proxy_set_header X-Real-IP $remote_addr; - # proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - # proxy_set_header X-Forwarded-Proto $scheme; - # } - - location /api-docs/ { - proxy_pass http://{{ $api.ingress.host }}:5000/api-docs/; - proxy_http_version 1.1; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - } - } \ No newline at end of file diff --git a/charts/helm/checkmate/templates/client/service.yaml b/charts/helm/checkmate/templates/client/service.yaml deleted file mode 100644 index b56eaeedf..000000000 --- a/charts/helm/checkmate/templates/client/service.yaml +++ /dev/null @@ -1,9 +0,0 @@ -apiVersion: v1 -kind: Service -metadata: - name: checkmate-client -spec: - selector: - app: checkmate-client - ports: - - port: {{ .Values.client.port }} diff --git a/charts/helm/checkmate/templates/prechecks.yaml b/charts/helm/checkmate/templates/prechecks.yaml index cc9f6b9a1..0e7e870bf 100644 --- a/charts/helm/checkmate/templates/prechecks.yaml +++ b/charts/helm/checkmate/templates/prechecks.yaml @@ -1,49 +1,45 @@ -{{- $api := include "checkmate.api" . | fromYaml -}} -{{- if eq .Values.client.ingress.host "change_me" }} - {{- fail "client.ingress.host must be overridden and not set to 'change_me'" }} +{{- $app := include "checkmate.app" . | fromYaml -}} +{{- if eq $app.ingress.host "change_me" }} + {{- fail "app.ingress.host must be overridden and not set to 'change_me'" }} {{- end }} -{{- if eq $api.ingress.host "change_me" }} - {{- fail "api.ingress.host (or legacy server.ingress.host) must be overridden and not set to 'change_me'" }} -{{- end }} - -{{- $apiProtocol := $api.protocol }} -{{- if not (or (eq $apiProtocol "http") (eq $apiProtocol "https")) }} - {{- fail "api.protocol must be either 'http' or 'https'" }} -{{- end }} - -{{- $clientProtocol := .Values.client.protocol }} -{{- if not (or (eq $clientProtocol "http") (eq $clientProtocol "https")) }} - {{- fail "client.protocol must be either 'http' or 'https'" }} +{{- $protocol := $app.protocol }} +{{- if not (or (eq $protocol "http") (eq $protocol "https")) }} + {{- fail "app.protocol must be either 'http' or 'https'" }} {{- end }} {{/* Enforce protocol when TLS is enabled to avoid mixed-content */}} -{{- if and .Values.client.ingress.tls.enabled (ne $clientProtocol "https") }} - {{- fail "client.ingress.tls.enabled is true but client.protocol is not 'https'. Set client.protocol: https to avoid mixed content." }} -{{- end }} - -{{- if and $api.ingress.tls.enabled (ne $apiProtocol "https") }} - {{- fail "api.ingress.tls.enabled is true but api.protocol is not 'https'. Set api.protocol: https to ensure correct API base URL." }} -{{- end }} - -{{/* If client runs on https, API must also be https to avoid mixed content */}} -{{- if and (eq $clientProtocol "https") (ne $apiProtocol "https") }} - {{- fail "client.protocol is 'https' but api.protocol is not. Set api.protocol: https to prevent browser mixed-content issues." }} +{{- if and $app.ingress.tls.enabled (ne $protocol "https") }} + {{- fail "app.ingress.tls.enabled is true but app.protocol is not 'https'. Set app.protocol: https to avoid mixed content." }} {{- end }} {{/* Fail early if TLS enabled without cert-manager annotations (cluster-issuer or issuer) */}} -{{- $cAnn := .Values.client.ingress.annotations | default dict }} -{{- $aAnn := $api.ingress.annotations | default dict }} +{{- $ann := $app.ingress.annotations | default dict }} +{{- $hasIssuer := or (hasKey $ann "cert-manager.io/cluster-issuer") (hasKey $ann "cert-manager.io/issuer") }} -{{- $clientHasIssuer := or (hasKey $cAnn "cert-manager.io/cluster-issuer") (hasKey $cAnn "cert-manager.io/issuer") }} -{{- $apiHasIssuer := or (hasKey $aAnn "cert-manager.io/cluster-issuer") (hasKey $aAnn "cert-manager.io/issuer") }} - -{{- if and .Values.client.ingress.tls.enabled (not $clientHasIssuer) }} - {{- fail "client.ingress.tls.enabled is true but no cert-manager issuer annotation found. Add 'cert-manager.io/cluster-issuer' or 'cert-manager.io/issuer'." }} +{{- if and $app.ingress.tls.enabled (not $hasIssuer) }} + {{- fail "app.ingress.tls.enabled is true but no cert-manager issuer annotation found. Add 'cert-manager.io/cluster-issuer' or 'cert-manager.io/issuer'." }} {{- end }} -{{- if and $api.ingress.tls.enabled (not $apiHasIssuer) }} - {{- fail "api.ingress.tls.enabled is true but no cert-manager issuer annotation found. Add 'cert-manager.io/cluster-issuer' or 'cert-manager.io/issuer'." }} +{{/* + Upgrade guard. The client and API are one service now, so a values file that still + points the two at different hosts cannot be honoured — fail loudly rather than + silently dropping one of them. +*/}} +{{- if and .Values.client .Values.api }} +{{- $clientHost := (.Values.client.ingress | default dict).host }} +{{- $apiHost := (.Values.api.ingress | default dict).host }} +{{- if and $clientHost $apiHost (ne $clientHost $apiHost) }} + {{- fail (printf "client.ingress.host (%s) and api.ingress.host (%s) differ, but Checkmate now serves the client and the API from one origin. Set a single app.ingress.host instead." $clientHost $apiHost) }} +{{- end }} +{{- end }} + +{{/* + The client image is no longer published. Point this out rather than letting the + install fail later on an ImagePullBackOff nobody can action. +*/}} +{{- if and .Values.client .Values.client.image }} + {{- fail "client.image is set, but the separate client image is no longer published. Remove the client block; the application image in app.image now serves the client." }} {{- end }} {{/* Worker grace period must exceed the server drain timeout (25s) or workers are SIGKILLed mid-drain */}} @@ -51,4 +47,4 @@ {{- fail "worker.terminationGracePeriodSeconds must be greater than 25 (the server drain timeout) or workers are killed mid-drain" }} {{- end }} -{{/* Secret name can be omitted; we default to -client|api-tls in templates */}} +{{/* Secret name can be omitted; we default to -tls in templates */}} diff --git a/charts/helm/checkmate/templates/worker/deployment.yaml b/charts/helm/checkmate/templates/worker/deployment.yaml index 0b0849455..6baa3fb65 100644 --- a/charts/helm/checkmate/templates/worker/deployment.yaml +++ b/charts/helm/checkmate/templates/worker/deployment.yaml @@ -1,4 +1,4 @@ -{{- $api := include "checkmate.api" . | fromYaml -}} +{{- $app := include "checkmate.app" . | fromYaml -}} {{- if .Values.worker.enabled }} apiVersion: apps/v1 kind: Deployment @@ -27,8 +27,8 @@ spec: {{- end }} containers: - name: worker - image: {{ include "checkmate.image" (dict "image" (.Values.worker.image | default $api.image) "tag" (.Values.worker.tag | default $api.tag) "root" $) }} - imagePullPolicy: {{ .Values.worker.imagePullPolicy | default $api.imagePullPolicy }} + image: {{ include "checkmate.image" (dict "image" (.Values.worker.image | default $app.image) "tag" (.Values.worker.tag | default $app.tag) "root" $) }} + imagePullPolicy: {{ .Values.worker.imagePullPolicy | default $app.imagePullPolicy }} ports: - name: health containerPort: {{ .Values.worker.healthPort }} @@ -36,9 +36,13 @@ spec: - secretRef: name: checkmate-secrets # DB_CONNECTION_STRING (+ JWT_SECRET/CLIENT_HOST for validateEnv) env: - # Secret default CLIENT_HOST is the non-URL "change_me"; override like the API so validateEnv passes. + # validateEnv requires a URL-shaped CLIENT_HOST, so mirror the app's default + # here. Omitted when secrets.CLIENT_HOST is set, since `env` would otherwise + # take precedence over the envFrom value and silently discard the override. + {{- if not (hasKey .Values.secrets "CLIENT_HOST") }} - name: CLIENT_HOST - value: "{{ .Values.client.protocol }}://{{ .Values.client.ingress.host }}" + value: "{{ $app.protocol }}://{{ $app.ingress.host }}" + {{- end }} - name: QUEUE_MODE value: "worker" - name: HEALTH_PORT diff --git a/charts/helm/checkmate/values.yaml b/charts/helm/checkmate/values.yaml index b2126fe20..f67ce09f2 100644 --- a/charts/helm/checkmate/values.yaml +++ b/charts/helm/checkmate/values.yaml @@ -1,31 +1,17 @@ -client: - image: ghcr.io/bluewave-labs/checkmate-client - tag: "" # defaults to Chart.appVersion; set a full repo:tag in `image` to pin (e.g. a :latest dev tag) - imagePullPolicy: IfNotPresent # IfNotPresent so kind-loaded :latest images are used (not pulled) - port: 80 - protocol: http - ingress: - enabled: true - host: change_me - className: nginx - annotations: {} - # Example annotations for cert-manager: - # annotations: - # cert-manager.io/cluster-issuer: "letsencrypt-prod" - tls: - enabled: false - # secretName: {{ .Release.Name }}-client-tls # Optional; defaults to -client-tls if omitted - # Note: when enabling TLS, also set client.protocol: https and add - # a cert-manager issuer annotation (e.g. cert-manager.io/cluster-issuer: "letsencrypt-prod"). - # The secret will be automatically created by cert-manager when using the cert-manager.io/cluster-issuer annotation - -api: - image: ghcr.io/bluewave-labs/checkmate-backend +# Checkmate is published as a single all-in-one application image: the API server +# also serves the React client, so one deployment and one ingress cover both. +# The `client:` and `api:` blocks from chart 0.2.x are still read for back-compat +# (see templates/_helpers.tpl) — `app.*` is the block to set on new installs. +app: + image: ghcr.io/bluewave-labs/checkmate tag: "" # defaults to Chart.appVersion; set a full repo:tag in `image` to pin (e.g. a :latest dev tag) imagePullPolicy: IfNotPresent # IfNotPresent so kind-loaded :latest images are used (not pulled) port: 52345 protocol: http - # Liveness/readiness probes hit GET /api/v1/health on the api port (proves the HTTP server is up). + resources: {} + affinity: {} + tolerations: {} + # Liveness/readiness probes hit GET /api/v1/health on the app port (proves the HTTP server is up). probes: liveness: initialDelaySeconds: 10 @@ -47,25 +33,27 @@ api: # cert-manager.io/cluster-issuer: "letsencrypt-prod" tls: enabled: false - # secretName: {{ .Release.Name }}-api-tls # Optional; defaults to -api-tls if omitted - # Note: when enabling TLS, also set api.protocol: https and add + # secretName: {{ .Release.Name }}-tls # Optional; defaults to -tls if omitted + # Note: when enabling TLS, also set app.protocol: https and add # a cert-manager issuer annotation (e.g. cert-manager.io/cluster-issuer: "letsencrypt-prod"). # The secret will be automatically created by cert-manager when using the cert-manager.io/cluster-issuer annotation +# Upstream MongoDB. The former ghcr.io/bluewave-labs/checkmate-mongo image is no +# longer published; this matches the mongo version in docker/docker-compose.yaml. mongodb: - image: ghcr.io/bluewave-labs/checkmate-mongo - tag: "" # defaults to Chart.appVersion; set a full repo:tag in `image` to pin - imagePullPolicy: IfNotPresent # IfNotPresent so kind-loaded :latest images are used (not pulled) + image: mongo + tag: "8.0" + imagePullPolicy: IfNotPresent port: 27017 worker: # Off by default; existing installs are unchanged. When true, a dedicated worker processes all - # jobs and the API stops processing (QUEUE_PRIMARY_PROCESSES is derived as false). When false, the - # API is all-in-one and processes jobs itself. + # jobs and the app stops processing (QUEUE_PRIMARY_PROCESSES is derived as false). When false, the + # app is all-in-one and processes jobs itself. enabled: false - image: "" # defaults to api.image when empty, same as API image - tag: "" # defaults to api.tag (-> Chart.appVersion) when empty - imagePullPolicy: "" # defaults to api.imagePullPolicy when empty + image: "" # defaults to app.image when empty, same as the application image + tag: "" # defaults to app.tag (-> Chart.appVersion) when empty + imagePullPolicy: "" # defaults to app.imagePullPolicy when empty replicas: 1 # used only when autoscaling.enabled = false healthPort: 52346 # HEALTH_PORT; serves /livez /readyz /metrics terminationGracePeriodSeconds: 30 # MUST stay > the server drain timeout (25s) or workers are killed mid-drain @@ -97,7 +85,8 @@ worker: secrets: JWT_SECRET: change_me DB_CONNECTION_STRING: mongodb://checkmate-mongodb:27017/uptime_db - CLIENT_HOST: change_me + # CLIENT_HOST is derived from app.protocol + app.ingress.host by the deployment; + # set it here only to override that (e.g. when fronting the app with another proxy). NODE_ENV: production LOG_LEVEL: info TOKEN_TTL: 99d