WPB-24072 mount galley.yaml into background-worker by battermann · Pull Request #5180 · wireapp/wire-server

battermann · 2026-04-14T13:17:43Z

Checklist

Add a new entry in an appropriate subdirectory of changelog.d
Read and follow the PR guidelines

Copilot

Pull request overview

Moves Galley option/key handling into wire-subsystems and updates background-worker to load and reuse galley.yaml (plus related K8s config/secrets), removing duplicated Galley-related settings from background-worker configuration.

Changes:

Rename Galley.Options/Galley.Keys to Wire.Options.Galley/Wire.Options.Keys and update imports/usages across Galley + tests.
Update background-worker to accept/load a separate Galley config file and derive Cassandra/Postgres/federation-domain settings from it.
Update Helm chart/templates and integration harness to mount/pass Galley config/secrets to background-worker; remove redundant background-worker values.

Reviewed changes

Copilot reviewed 44 out of 44 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
services/galley/test/integration/TestSetup.hs	Switch test imports from `Galley.Options` to `Wire.Options.Galley`.
services/galley/test/integration/TestHelpers.hs	Switch test imports from `Galley.Options` to `Wire.Options.Galley`.
services/galley/test/integration/Run.hs	Switch integration runner imports to `Wire.Options.Galley`.
services/galley/test/integration/Federation.hs	Switch imports to `Wire.Options.Galley`.
services/galley/test/integration/API/Util/TeamFeature.hs	Switch imports to `Wire.Options.Galley`.
services/galley/test/integration/API/Util.hs	Switch qualified options import to `Wire.Options.Galley`.
services/galley/test/integration/API/Teams/LegalHold/Util.hs	Switch imports to `Wire.Options.Galley`.
services/galley/test/integration/API/Teams.hs	Switch imports to `Wire.Options.Galley`.
services/galley/test/integration/API/SQS.hs	Switch imports to `Wire.Options.Galley`.
services/galley/test/integration/API/MLS/Util.hs	Switch imports from `Galley.Options/Keys` to `Wire.Options.*`.
services/galley/test/integration/API.hs	Switch imports to `Wire.Options.Galley`.
services/galley/src/Galley/Run.hs	Switch runtime options import to `Wire.Options.Galley`.
services/galley/src/Galley/Env.hs	Switch options import to `Wire.Options.Galley`.
services/galley/src/Galley/App.hs	Switch options/keys imports to `Wire.Options.*`.
services/galley/src/Galley/API/Update.hs	Switch options import to `Wire.Options.Galley`.
services/galley/src/Galley/API/Teams/Features.hs	Switch options import to `Wire.Options.Galley`.
services/galley/src/Galley/API/Teams.hs	Switch options import to `Wire.Options.Galley`.
services/galley/src/Galley/API/Message.hs	Switch options import to `Wire.Options.Galley`.
services/galley/src/Galley/API/LegalHold/Conflicts.hs	Switch options import to `Wire.Options.Galley`.
services/galley/src/Galley/API/Internal.hs	Switch options import and update lens chain to `Wire.Options.Galley`.
services/galley/src/Galley/API/Federation/Handlers.hs	Switch options import to `Wire.Options.Galley`.
services/galley/galley.cabal	Drop `Galley.Options/Keys` modules and crypto deps now housed in `wire-subsystems`.
services/galley/default.nix	Align Nix deps with moved options/keys implementation.
services/background-worker/src/Wire/BackgroundWorker/Options.hs	Remove duplicated Galley/Postgres/federation fields from background-worker options.
services/background-worker/src/Wire/BackgroundWorker/Env.hs	Build env using Galley opts for Cassandra/Postgres/federation-domain.
services/background-worker/src/Wire/BackgroundWorker.hs	Thread Galley opts through `run`.
services/background-worker/exec/Main.hs	Add CLI flag and config loading for a separate Galley config file.
services/background-worker/default.nix	Add `optparse-applicative` to executable deps.
services/background-worker/background-worker.integration.yaml	Remove duplicated Galley/Postgres/federation settings from sample integration config.
services/background-worker/background-worker.cabal	Add `optparse-applicative` dependency for the executable.
libs/wire-subsystems/wire-subsystems.cabal	Add deps + expose new `Wire.Options.*` modules.
libs/wire-subsystems/src/Wire/Options/Keys.hs	Rename module to `Wire.Options.Keys`.
libs/wire-subsystems/src/Wire/Options/Galley.hs	Rename module to `Wire.Options.Galley` and depend on `Wire.Options.Keys`.
libs/wire-subsystems/default.nix	Add deps for the moved keys/options modules.
libs/types-common/src/Util/Options.hs	Factor out `decodeConfigFile` helper and reuse it from `getOptions`.
integration/test/Testlib/ModService.hs	Start background-worker with both its config and a generated Galley config; clean up multiple temp paths.
hack/helmfile.yaml.gotmpl	Remove background-worker federationDomain value injection (now sourced from Galley).
hack/helm_vars/wire-server/values.yaml.gotmpl	Remove redundant background-worker Postgres/Galley Cassandra/federationDomain values.
charts/wire-server/values.yaml	Remove redundant background-worker Postgres/Galley Cassandra/federationDomain values and docs.
charts/wire-server/templates/background-worker/deployment.yaml	Mount Galley config/secret into background-worker pod; add checksums.
charts/wire-server/templates/background-worker/configmap.yaml	Remove Galley/Postgres/federationDomain config emission; adjust RabbitMQ CA cert path logic.
charts/wire-server/templates/background-worker/cassandra-secret.yaml	Remove background-worker Galley Cassandra secret (now sourced from Galley).
charts/wire-server/templates/_helpers.tpl	Remove background-worker-specific Galley TLS helper; add `galley.tlsSecretRef`.
changelog.d/0-release-notes/WPB-24072	Release note describing the config unification.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-15T10:59:45Z

changelog.d/0-release-notes/WPB-24072

@@ -0,0 +1 @@
+`background-worker` now reuses `galley`'s configmap and secrets for cassandra, postgres and federation domain settings. This removes redundant settings and keeps the two services aligned. No operator action is strictly required, however we advice to remove the value overrides of the `background-worker` for galley's cassandra, postgres, and the federation domain as they are duplicate an no longer needed.


The release note contains a few typos/grammar issues (e.g. “we advice” / “duplicate an”). Please correct to improve clarity for operators.

Suggested change

`background-worker` now reuses `galley`'s configmap and secrets for cassandra, postgres and federation domain settings. This removes redundant settings and keeps the two services aligned. No operator action is strictly required, however we advice to remove the value overrides of the `background-worker` for galley's cassandra, postgres, and the federation domain as they are duplicate an no longer needed.

`background-worker` now reuses `galley`'s configmap and secrets for cassandra, postgres and federation domain settings. This removes redundant settings and keeps the two services aligned. No operator action is strictly required; however, we advise removing the `background-worker` value overrides for galley's cassandra, postgres, and federation domain settings, as they are duplicated and no longer needed.

Copilot · 2026-04-15T10:59:46Z

charts/wire-server/templates/background-worker/configmap.yaml

+      {{- if $.Values.galley.config.rabbitmq.tlsCaSecretRef }}
+      caCert: /etc/wire/galley/rabbitmq-ca/{{ $.Values.galley.config.rabbitmq.tlsCaSecretRef.key }}


caCert is now keyed off $.Values.galley.config.rabbitmq.tlsCaSecretRef, which ignores background-worker.config.rabbitmq.tlsCaSecretRef. This breaks setups where background-worker has its own RabbitMQ TLS CA configured (or where only background-worker uses TLS). Consider switching the condition/key back to the background-worker rabbitmq config, or explicitly documenting/removing support for background-worker-specific RabbitMQ TLS CA overrides.

Suggested change

{{- if $.Values.galley.config.rabbitmq.tlsCaSecretRef }}

caCert: /etc/wire/galley/rabbitmq-ca/{{ $.Values.galley.config.rabbitmq.tlsCaSecretRef.key }}

{{- if .tlsCaSecretRef }}

caCert: /etc/wire/galley/rabbitmq-ca/{{ .tlsCaSecretRef.key }}

Copilot · 2026-04-15T10:59:46Z

charts/wire-server/templates/background-worker/deployment.yaml

+        {{- if .Values.galley.config.rabbitmq.tlsCaSecretRef }}
+        - name: "galley-rabbitmq-ca"
          secret:
-            secretName: {{ $backgroundWorker.config.rabbitmq.tlsCaSecretRef.name }}
+            secretName: {{ .Values.galley.config.rabbitmq.tlsCaSecretRef.name }}
        {{- end }}


The galley-rabbitmq-ca volume is only created when Values.galley.config.rabbitmq.tlsCaSecretRef is set. If background-worker is configured with a RabbitMQ TLS CA but galley is not, the CA secret will not be mounted and background-worker will fail to connect. Align the condition with the background-worker rabbitmq TLS CA configuration (or otherwise ensure the mount condition matches the path written into background-worker.yaml).

Copilot · 2026-04-15T10:59:46Z

charts/wire-server/templates/background-worker/deployment.yaml

+          secret:
+            secretName: "galley"


Mounting the entire galley Secret into the background-worker pod grants background-worker access to secrets it likely doesn't need (e.g. MLS private keys, galley RabbitMQ credentials). To follow least-privilege, consider creating a dedicated Secret (or a projected volume) containing only the shared items background-worker requires (e.g. Postgres password / Cassandra CA), and mount that instead of the full galley secret.

Suggested change

secret:

secretName: "galley"

projected:

sources:

- secret:

name: "galley"

items:

- key: "postgres-password"

path: "postgres-password"

Copilot · 2026-04-15T10:59:47Z

libs/types-common/src/Util/Options.hs

  exists <- doesFileExist path
  case (exists, mOpts) of
-    -- config file exists, take options from there
-    (True, _) -> do
-      decodeFileEither path >>= \case
-        Left e ->
-          fail $
-            show e
-              <> " while attempting to decode "
-              <> path
-        Right o -> pure o
-    -- config doesn't exist, take options from command line
+    (True, _) -> decodeConfigFile path
    (False, Just opts) -> pure opts
-    -- no config, no parser, just fail
-    (False, Nothing) ->
-      fail $ "Config file at " <> path <> " does not exist."
+    (False, Nothing) -> fail $ "Config file at " <> path <> " does not exist."


getOptions checks doesFileExist path and then immediately calls decodeConfigFile, which performs the same existence check again. Consider removing the pre-check in getOptions (and rely on decodeConfigFile for the error message) to avoid duplication and keep the code paths consistent.

akshaymankar · 2026-04-15T11:15:38Z

changelog.d/0-release-notes/WPB-24072

@@ -0,0 +1 @@
+`background-worker` now reuses `galley`'s configmap and secrets for cassandra, postgres and federation domain settings. This removes redundant settings and keeps the two services aligned. No operator action is strictly required, however we advice to remove the value overrides of the `background-worker` for galley's cassandra, postgres, and the federation domain as they are duplicate an no longer needed.


It would be nice to list all the options which are removed.

akshaymankar

I think we should keep the flexibility of configuring the hasql pool differently for the bcakground-worker. Other comments are nits.

akshaymankar · 2026-04-15T11:22:46Z

integration/test/Testlib/ModService.hs

+        (BackgroundWorker, _) -> do
+          config <- getConfig
+          galleyConf <- getGalleyConf
+          tempFile <- writeTempFile "/tmp" (execName <> "-" <> domain <> "-" <> ".yaml") (cs $ Yaml.encode config)
+          galleyConfTemp <- writeTempFile "/tmp" (configName Galley <> "-" <> domain <> "-" <> ".yaml") (cs $ Yaml.encode galleyConf)
+          let params = ["-c", tempFile, "--galley-config-file", galleyConfTemp]
+          (_, Just stdoutHdl, Just stderrHdl, ph) <- createProcess (proc exe params) {cwd = cwd, std_out = CreatePipe, std_err = CreatePipe}
+          let colorize = fromMaybe id (lookup execName processColors)
+          void $ forkIO $ logToConsoleDebug (Just stdOut) colorize prefix stdoutHdl
+          void $ forkIO $ logToConsoleDebug (Just stdErr) colorize prefix stderrHdl
+          liftIO $ writeIORef phRef (Just ph)
+          pure $ ServiceInstance ph [tempFile, galleyConfTemp]


I'm wondering if it makes sense to write the config once before these processes start and then just use those configs as needed.

Also it'd be nice to dedup this code.

akshaymankar · 2026-04-15T11:28:40Z

services/background-worker/src/Wire/BackgroundWorker/Env.hs

-  hasqlPool <- initPostgresPool opts.postgresqlPool opts.postgresql opts.postgresqlPassword
+  hasqlPool <- initPostgresPool galleyOpts._postgresqlPool galleyOpts._postgresql galleyOpts._postgresqlPassword


This might be an exception that we'd want to keep as the pool requirements for the web process may need to be different from pool requirements for the background worker.

battermann added 2 commits April 14, 2026 12:38

mount galley.yaml into background-worker

f5f92d5

moved Galley.Options to wire-subsystems

c3db036

zebot added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Apr 14, 2026

battermann added 6 commits April 14, 2026 13:32

use galley options in background-worker

946a818

update usages in galley and patch the local integration setup

f5dfd4e

clean up all files, do it finally

14d1cd6

also mount the galley secrets into background-worker

7679f9b

remove redundancy

a95e399

changelog

6f0fea7

battermann marked this pull request as ready for review April 15, 2026 10:52

battermann requested review from a team as code owners April 15, 2026 10:52

battermann requested a review from Copilot April 15, 2026 10:53

Copilot started reviewing on behalf of battermann April 15, 2026 10:53 View session

Copilot AI reviewed Apr 15, 2026

View reviewed changes

akshaymankar reviewed Apr 15, 2026

View reviewed changes

akshaymankar requested changes Apr 15, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WPB-24072 mount galley.yaml into background-worker#5180

WPB-24072 mount galley.yaml into background-worker#5180
battermann wants to merge 8 commits intodevelopfrom
WPB-24072-wire-meeting-delete-endpoint-prep

battermann commented Apr 14, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 15, 2026

Uh oh!

Copilot AI Apr 15, 2026

Uh oh!

Copilot AI Apr 15, 2026

Uh oh!

Copilot AI Apr 15, 2026

Uh oh!

Copilot AI Apr 15, 2026

Uh oh!

akshaymankar Apr 15, 2026

Uh oh!

akshaymankar left a comment

Uh oh!

akshaymankar Apr 15, 2026

Uh oh!

akshaymankar Apr 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		@@ -0,0 +1 @@
		`background-worker` now reuses `galley`'s configmap and secrets for cassandra, postgres and federation domain settings. This removes redundant settings and keeps the two services aligned. No operator action is strictly required, however we advice to remove the value overrides of the `background-worker` for galley's cassandra, postgres, and the federation domain as they are duplicate an no longer needed.

		{{- if $.Values.galley.config.rabbitmq.tlsCaSecretRef }}
		caCert: /etc/wire/galley/rabbitmq-ca/{{ $.Values.galley.config.rabbitmq.tlsCaSecretRef.key }}

-          secret:
-            secretName: "galley"
+          projected:
+            sources:
+              - secret:
+                  name: "galley"
+                  items:
+                    - key: "postgres-password"
+                      path: "postgres-password"

		hasqlPool <- initPostgresPool opts.postgresqlPool opts.postgresql opts.postgresqlPassword
		hasqlPool <- initPostgresPool galleyOpts._postgresqlPool galleyOpts._postgresql galleyOpts._postgresqlPassword

Conversation

battermann commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

akshaymankar Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

akshaymankar left a comment

Choose a reason for hiding this comment

Uh oh!

akshaymankar Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

akshaymankar Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

battermann commented Apr 14, 2026 •

edited

Loading