init #21

jsbroks · 2025-09-30T15:29:48Z

Summary by CodeRabbit

New Features
- Adds optional PgBouncer sidecar to the event-queue pod, with auto-generated pgbouncer.ini and configurable values (image, resources, port, core settings).
- Introduces a new workspace-engine chart with defaults, service account and StatefulSet templates for deploying the workspace engine.
- Bumps ctrlplane chart version and adds workspace-engine as an optional chart dependency.

coderabbitai · 2025-09-30T15:29:56Z

Walkthrough

Adds a PgBouncer sidecar to the event-queue chart (helper template, ConfigMap, deployment changes, and values) and introduces a new workspace-engine subchart with helpers, ServiceAccount, StatefulSet template, values, Chart.yaml, and .helmignore. Also bumps ctrlplane chart version and adds workspace-engine dependency.

Changes

Cohort / File(s)	Summary
PgBouncer Helm helper `charts/ctrlplane/charts/event-queue/templates/_helpers.tpl`	Adds `define "pgbouncer.ini"` template that renders [databases], [pgbouncer], and [users] sections (uses values.databases, values.pgbouncer, values.users and optional include).
Event-queue Deployment `charts/ctrlplane/charts/event-queue/templates/deployment.yaml`	Adds four env vars to main container and inserts a new `pgbouncer` sidecar container (image, pullPolicy, internal port, config volumeMount, resources).
PgBouncer ConfigMap `charts/ctrlplane/charts/event-queue/templates/pgbouncer.yaml`	New ConfigMap manifest that sets `data.pgbouncer.ini` using the `pgbouncer.ini` helper and includes labels/name templates.
Event-queue values `charts/ctrlplane/charts/event-queue/values.yaml`	Adds top-level `pgbouncer` values: `image` (repository/tag/pullPolicy), `resources` (requests/limits), `internalPort`, and `config` (listen_addr/listen_port/unix_socket_dir).
Chart metadata / dependency `charts/ctrlplane/Chart.yaml`	Bumps chart version to 0.4.5 and adds `workspace-engine` dependency with condition `workspace-engine.install` and repository `file://charts/workspace-engine`.
Workspace-engine chart metadata `charts/ctrlplane/charts/workspace-engine/Chart.yaml`	Adds new Chart.yaml for `workspace-engine` (apiVersion: v2, version 0.1.0, appVersion "1.0.0").
Workspace-engine helpers `charts/ctrlplane/charts/workspace-engine/templates/_helpers.tpl`	New helper templates: `workspace-engine.name`, `workspace-engine.fullname`, `workspace-engine.chart`, `workspace-engine.labels`, `workspace-engine.selectorLabels`, `workspace-engine.serviceAccountName`.
Workspace-engine ServiceAccount `charts/ctrlplane/charts/workspace-engine/templates/serviceaccount.yaml`	Adds conditional ServiceAccount template using helper names/labels and optional annotations/labels from values.
Workspace-engine StatefulSet `charts/ctrlplane/charts/workspace-engine/templates/statefulset.yaml`	Adds StatefulSet template for `workspace-engine` with replicas, container (image, port 8081), many env vars (from values/secrets), resources, tolerations, and optional extras.
Workspace-engine values `charts/ctrlplane/charts/workspace-engine/values.yaml`	New values file with defaults for metadata, replicas, image, env, tolerations, serviceAccount, resources, extraEnv, extraEnvFrom.
Workspace-engine .helmignore `charts/ctrlplane/charts/workspace-engine/.helmignore`	Adds packaging ignore patterns (.DS_Store, VCS dirs, backups, IDE dirs, etc.).

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor App as Event-Queue App
  participant PB as PgBouncer Sidecar
  participant DB as PostgreSQL

  App->>PB: Connect to localhost:{{ .Values.pgbouncer.config.listen_port | default "6432" }}
  PB->>DB: Open/Reuse pooled connection(s)
  DB-->>PB: Query responses
  PB-->>App: Forward results

  note right of PB: PB config loaded from ConfigMap `pgbouncer.ini`

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

chore: init event queue #20 — Prior changes modifying the same event-queue templates (helpers, deployment, values); likely extended here to add PgBouncer artifacts.

Suggested reviewers

zacharyblasczyk

Poem

Hop hop, configs stitched just right,
A bouncer springs to guard the night.
Pods sip pools and queries sing,
This rabbit cheers the changes bring. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The title “init” is a generic placeholder that does not describe any of the substantive changes introduced by this pull request, such as adding a pgbouncer sidecar to the event-queue chart and scaffolding the new workspace-engine chart. Because it fails to convey the primary purpose of these enhancements, it does not meet the clarity and specificity guidelines for pull request titles.	Consider revising the title to summarize the main changes, for example “Add pgbouncer sidecar to event-queue and scaffold workspace-engine Helm chart,” so that the title clearly reflects the primary goals of the pull request.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch pgbouncer

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 4

🧹 Nitpick comments (1)

charts/ctrlplane/charts/event-queue/templates/deployment.yaml (1)
117-117: Remove extra blank line.

Static analysis detected an extra blank line here.

Apply this diff:
-

+

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 8e1bc98 and 7518662.

📒 Files selected for processing (4)

charts/ctrlplane/charts/event-queue/templates/_helpers.tpl (1 hunks)
charts/ctrlplane/charts/event-queue/templates/deployment.yaml (1 hunks)
charts/ctrlplane/charts/event-queue/templates/pgbouncer.yaml (1 hunks)
charts/ctrlplane/charts/event-queue/values.yaml (1 hunks)

🧰 Additional context used

🪛 YAMLlint (1.37.1)

charts/ctrlplane/charts/event-queue/templates/pgbouncer.yaml

[error] 7-7: syntax error: expected the node content, but found '-'

(syntax)

charts/ctrlplane/charts/event-queue/templates/deployment.yaml

[warning] 117-117: too many blank lines (1 > 0)

(empty-lines)

🔇 Additional comments (1)

charts/ctrlplane/charts/event-queue/values.yaml (1)
11-27: Verify database connection configuration.

The pgbouncer configuration is missing the [databases] section that defines which PostgreSQL databases PgBouncer should connect to. Without this, the event-queue application won't be able to connect through PgBouncer.

You'll need to add a databases configuration. For example, if your application connects to a database via the POSTGRES_URL environment variable, you should add something like:
databases:
  "*": "host=your-postgres-host port=5432 dbname=your-db"
Additionally, ensure the event-queue container's POSTGRES_URL environment variable (line 69-73 in deployment.yaml) is updated to point to localhost:6432 instead of the direct PostgreSQL connection, so it routes through PgBouncer.

coderabbitai · 2025-09-30T15:34:38Z

charts/ctrlplane/charts/event-queue/templates/_helpers.tpl

+{{ define "pgbouncer.ini" }}
+
+{{/* [databases] section */}}
+{{- if $.Values.databases }}
+  {{ printf "[databases]" }}
+  {{- range $key, $value := .Values.databases }}
+    {{ $key }} ={{ range $k, $v := $value }} {{ $k }}={{ $v }}{{ end }}
+  {{- end }}
+{{- end }}
+
+{{/* [pgbouncer] section */}}
+{{- if $.Values.pgbouncer }}
+  {{ printf "[pgbouncer]" }}
+  {{- range $k, $v := $.Values.pgbouncer }}
+    {{ $k }} = {{ $v }}
+  {{- end }}
+{{- end }}
+
+{{/* [users] section */}}
+{{- if $.Values.users }}
+  {{ printf "[users]" }}
+  {{- range $k, $v := $.Values.users }}
+    {{ $k }} = {{ $v }}
+  {{- end }}
+{{- end }}
+
+{{/* include is a special configuration within [pgbouncer] section */}}
+{{- if $.Values.include }}
+  {{ printf "%s %s" "%include" $.Values.include }}
+{{- end }}
+
+{{ end }}


⚠️ Potential issue | 🟠 Major

Major: Incorrect value paths in pgbouncer.ini template.

The template has several issues:

Line 77-78: The template iterates over $.Values.pgbouncer, but according to values.yaml, this contains nested structures (image, resources, internalPort, config). It should iterate over $.Values.pgbouncer.config instead.

Line 70: The nested range loop for database parameters lacks proper spacing, producing malformed connection strings like host=localhostport=5432 instead of host=localhost port=5432.

Line 91-93: The %include directive is placed outside the [pgbouncer] section, but it should be inside that section per PgBouncer configuration syntax.

Apply this diff to fix the template:

{{ define "pgbouncer.ini" }} {{/* [databases] section */}} {{- if $.Values.databases }} {{ printf "[databases]" }} {{- range $key, $value := .Values.databases }} - {{ $key }} ={{ range $k, $v := $value }} {{ $k }}={{ $v }}{{ end }} + {{ $key }} = {{ range $k, $v := $value }}{{ $k }}={{ $v }} {{ end }} {{- end }} {{- end }} {{/* [pgbouncer] section */}} -{{- if $.Values.pgbouncer }} +{{- if $.Values.pgbouncer.config }} {{ printf "[pgbouncer]" }} - {{- range $k, $v := $.Values.pgbouncer }} + {{- range $k, $v := $.Values.pgbouncer.config }} {{ $k }} = {{ $v }} {{- end }} -{{- end }} - -{{/* [users] section */}} -{{- if $.Values.users }} - {{ printf "[users]" }} - {{- range $k, $v := $.Values.users }} - {{ $k }} = {{ $v }} - {{- end }} -{{- end }} - -{{/* include is a special configuration within [pgbouncer] section */}} -{{- if $.Values.include }} + {{/* include is a special configuration within [pgbouncer] section */}} + {{- if $.Values.include }} {{ printf "%s %s" "%include" $.Values.include }} + {{- end }} {{- end }} +{{/* [users] section */}} +{{- if $.Values.users }} + {{ printf "[users]" }} + {{- range $k, $v := $.Values.users }} + {{ $k }} = {{ $v }} + {{- end }} +{{- end }} + {{ end }}

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

{{ define "pgbouncer.ini" }}

{{/* [databases] section */}}

{{- if $.Values.databases }}

{{ printf "[databases]" }}

{{- range $key, $value := .Values.databases }}

{{ $key }} ={{ range $k, $v := $value }} {{ $k }}={{ $v }}{{ end }}

{{- end }}

{{- end }}

{{/* [pgbouncer] section */}}

{{- if $.Values.pgbouncer }}

{{ printf "[pgbouncer]" }}

{{- range $k, $v := $.Values.pgbouncer }}

{{ $k }} = {{ $v }}

{{- end }}

{{- end }}

{{/* [users] section */}}

{{- if $.Values.users }}

{{ printf "[users]" }}

{{- range $k, $v := $.Values.users }}

{{ $k }} = {{ $v }}

{{- end }}

{{- end }}

{{/* include is a special configuration within [pgbouncer] section */}}

{{- if $.Values.include }}

{{ printf "%s %s" "%include" $.Values.include }}

{{- end }}

{{ end }}

{{ define "pgbouncer.ini" }}

{{/* [databases] section */}}

{{- if $.Values.databases }}

{{ printf "[databases]" }}

{{- range $key, $value := .Values.databases }}

{{ $key }} = {{ range $k, $v := $value }}{{ $k }}={{ $v }} {{ end }}

{{- end }}

{{- end }}

{{/* [pgbouncer] section */}}

{{- if $.Values.pgbouncer.config }}

{{ printf "[pgbouncer]" }}

{{- range $k, $v := .Values.pgbouncer.config }}

{{ $k }} = {{ $v }}

{{- end }}

{{/* include is a special configuration within [pgbouncer] section */}}

{{- if $.Values.include }}

{{ printf "%s %s" "%include" $.Values.include }}

{{- end }}

{{- end }}

{{/* [users] section */}}

{{- if $.Values.users }}

{{ printf "[users]" }}

{{- range $k, $v := .Values.users }}

{{ $k }} = {{ $v }}

{{- end }}

{{- end }}

{{ end }}

🤖 Prompt for AI Agents

In charts/ctrlplane/charts/event-queue/templates/_helpers.tpl around lines 64 to 95, the pgbouncer.ini helper currently iterates the wrong path, emits concatenated DB params without spaces, and places the %include outside the [pgbouncer] section; update the template to iterate over $.Values.pgbouncer.config (not $.Values.pgbouncer) for the [pgbouncer] section, change the nested database-params range to print each key/value with a trailing space between pairs (e.g., emit " {{ $k }}={{ $v }} " for each param) so connection strings have spaces, and move the "%include" line into the [pgbouncer] section so the include directive is inside that section.

coderabbitai · 2025-09-30T15:34:38Z

charts/ctrlplane/charts/event-queue/templates/deployment.yaml

+            {{- toYaml .Values.resources | nindent 12 }}
+        - name: pgbouncer
+          image: "{{ .Values.pgbouncer.image.repository }}:{{ .Values.pgbouncer.image.tag }}"
+          imagePullPolicy: "{{ .Values.pgbouncer.image.pullPolicy }}"
+          ports:
+            - name: pgbouncer
+              containerPort: {{ .Values.pgbouncer.internalPort }}
+          volumeMounts:
+            - name: config
+              mountPath: /etc/pgbouncer
+              readOnly: true
+          resources:
+            {{- toYaml .Values.pgbouncer.resources | nindent 12 }}


⚠️ Potential issue | 🔴 Critical

Critical: Missing volumes section in deployment spec.

The pgbouncer container mounts a volume named "config" at /etc/pgbouncer, but there's no volumes section defined in the pod spec to provide this volume. This will cause the pod to fail with a mount error.

Add a volumes section to the pod spec that references the pgbouncer ConfigMap. Insert this after the containers section (around line 117):

+ volumes: + - name: config + configMap: + name: {{ template "pgbouncer.configFile" . }}

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

{{- toYaml .Values.resources | nindent 12 }}

- name: pgbouncer

image: "{{ .Values.pgbouncer.image.repository }}:{{ .Values.pgbouncer.image.tag }}"

imagePullPolicy: "{{ .Values.pgbouncer.image.pullPolicy }}"

ports:

- name: pgbouncer

containerPort: {{ .Values.pgbouncer.internalPort }}

volumeMounts:

- name: config

mountPath: /etc/pgbouncer

readOnly: true

resources:

{{- toYaml .Values.pgbouncer.resources | nindent 12 }}

{{- toYaml .Values.resources | nindent 12 }}

- name: pgbouncer

image: "{{ .Values.pgbouncer.image.repository }}:{{ .Values.pgbouncer.image.tag }}"

imagePullPolicy: "{{ .Values.pgbouncer.image.pullPolicy }}"

ports:

- name: pgbouncer

containerPort: {{ .Values.pgbouncer.internalPort }}

volumeMounts:

- name: config

mountPath: /etc/pgbouncer

readOnly: true

resources:

{{- toYaml .Values.pgbouncer.resources | nindent 12 }}

volumes:

- name: config

configMap:

name: {{ template "pgbouncer.configFile" . }}

🤖 Prompt for AI Agents

In charts/ctrlplane/charts/event-queue/templates/deployment.yaml around lines 104–116 the pgbouncer container mounts a volume named "config" but there is no corresponding pod.spec.volumes entry; add a volumes section immediately after the containers block (around line 117) that defines the "config" volume and sources it from the pgbouncer ConfigMap (use the chart value for the ConfigMap name if available, e.g. .Values.pgbouncer.configMapName or otherwise the conventional pgbouncer configmap name) so the /etc/pgbouncer mount is backed by that ConfigMap.

coderabbitai · 2025-09-30T15:34:38Z

charts/ctrlplane/charts/event-queue/templates/pgbouncer.yaml

+  name: {{ template "pgbouncer.configFile" . }}
+  namespace: {{ $.Release.Namespace }}
+  labels:
+    {{- include "pgbouncer.labels" . | nindent 4 }}


⚠️ Potential issue | 🔴 Critical

Critical: Missing helper template definitions.

This ConfigMap references two helper templates that are not defined in _helpers.tpl:

pgbouncer.configFile (line 4)

pgbouncer.labels (line 7)

These missing templates will cause the chart to fail during rendering.

Add these helper template definitions to charts/ctrlplane/charts/event-queue/templates/_helpers.tpl:

{{/* PgBouncer config file name */}} {{- define "pgbouncer.configFile" -}} {{- printf "%s-pgbouncer-config" (include "event-queue.fullname" .) }} {{- end }} {{/* PgBouncer labels */}} {{- define "pgbouncer.labels" -}} {{ include "event-queue.labels" . }} app.kubernetes.io/component: pgbouncer {{- end }}

🧰 Tools

🪛 YAMLlint (1.37.1)

[error] 7-7: syntax error: expected the node content, but found '-'

(syntax)

🤖 Prompt for AI Agents

In charts/ctrlplane/charts/event-queue/templates/pgbouncer.yaml around lines 4 to 7, the ConfigMap references helper templates "pgbouncer.configFile" and "pgbouncer.labels" which are not defined; add definitions for these helpers into charts/ctrlplane/charts/event-queue/templates/_helpers.tpl: define "pgbouncer.configFile" to return a config file name based on the release fullname (e.g., "%s-pgbouncer-config" using include "event-queue.fullname"), and define "pgbouncer.labels" to include the existing "event-queue.labels" and append app.kubernetes.io/component: pgbouncer so rendering succeeds.

coderabbitai · 2025-09-30T15:34:38Z

charts/ctrlplane/charts/event-queue/values.yaml

+    limits:
+      cpu: 500m
+      memory: 512Mi
+  internalPort: 6379


⚠️ Potential issue | 🟠 Major

Fix incorrect internalPort value.

The internalPort is set to 6379 (Redis default port), but it should be 6432 to match the listen_port in the config section (line 26). This inconsistency will cause the container port to not match the actual PgBouncer listening port.

Apply this diff:

- internalPort: 6379 + internalPort: 6432

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

internalPort: 6379

internalPort: 6432

🤖 Prompt for AI Agents

In charts/ctrlplane/charts/event-queue/values.yaml around line 23 the internalPort is incorrectly set to 6379; update that value to 6432 so the container port matches the PgBouncer listen_port defined in the config (line 26). Make the single-line change replacing 6379 with 6432 to keep ports consistent.

coderabbitai

Actionable comments posted: 3

♻️ Duplicate comments (1)

charts/ctrlplane/charts/event-queue/templates/deployment.yaml (1)

122-127: Critical: Missing volumes section in deployment spec.

As noted in a previous review, the pgbouncer container mounts a volume named "config" at /etc/pgbouncer, but there's no volumes section defined in the pod spec to provide this volume. This will cause the pod to fail with a mount error.

The volumes section should be added after the containers block, referencing the pgbouncer ConfigMap.

🧹 Nitpick comments (3)

charts/ctrlplane/charts/workspace-engine/Chart.yaml (1)
1-6: Consider improving chart metadata.

The chart metadata is valid but could be enhanced:

The description is generic ("A Helm chart for Kubernetes"). Consider describing what workspace-engine specifically does.

The appVersion: "1.0.0" appears to be a placeholder. Ensure it matches the actual application version deployed by this chart.

Example improvement:
-description: A Helm chart for Kubernetes
+description: Helm chart for Ctrlplane workspace engine component
 type: application
 version: 0.1.0
-appVersion: "1.0.0"
+appVersion: "1.16.0"
charts/ctrlplane/charts/workspace-engine/templates/statefulset.yaml (1)
1-1: Remove unused variable.

The $imageCfg dict is defined but never used in this template. The image reference on line 41 uses .Values.image.repository and .Values.image.tag directly.
-{{- $imageCfg := dict "global" $.Values.global.image "local" $.Values.image -}}
 apiVersion: apps/v1
charts/ctrlplane/charts/event-queue/templates/deployment.yaml (1)
128-128: Remove extra blank line.

YAMLlint flags an extra blank line here. Remove it for cleaner formatting.
           resources:
             {{- toYaml .Values.pgbouncer.resources | nindent 12 }}
-

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 7518662 and 8f43d10.

📒 Files selected for processing (8)

charts/ctrlplane/Chart.yaml (2 hunks)
charts/ctrlplane/charts/event-queue/templates/deployment.yaml (1 hunks)
charts/ctrlplane/charts/workspace-engine/.helmignore (1 hunks)
charts/ctrlplane/charts/workspace-engine/Chart.yaml (1 hunks)
charts/ctrlplane/charts/workspace-engine/templates/_helpers.tpl (1 hunks)
charts/ctrlplane/charts/workspace-engine/templates/serviceaccount.yaml (1 hunks)
charts/ctrlplane/charts/workspace-engine/templates/statefulset.yaml (1 hunks)
charts/ctrlplane/charts/workspace-engine/values.yaml (1 hunks)

✅ Files skipped from review due to trivial changes (2)

charts/ctrlplane/charts/workspace-engine/values.yaml
charts/ctrlplane/charts/workspace-engine/.helmignore

🧰 Additional context used

🪛 GitHub Actions: Lint and Test Charts

charts/ctrlplane/Chart.yaml

[error] 1-1: Failed linting charts: failed building dependencies for chart 'ctrlplane'.

charts/ctrlplane/charts/workspace-engine/templates/serviceaccount.yaml