feat(zammad): add config to stack.yml #202

huzaifaedhi22 · 2025-05-22T18:15:21Z

This PR

adds Zammad image to stack.yml
adds zammad.localhost to dev certificates

TODO

A zammad role in postgres
A schema for zammad ( Draft )

Copilot

Pull Request Overview

This PR adds Zammad configuration support by defining several new services in stack.yml and updating development certificates to include zammad.localhost.

Introduces new Docker service definitions for Zammad components (elasticsearch, init, railsserver, scheduler, websocket, among others).
Adds a dedicated volume for Zammad's Elasticsearch data.
Updates mkcert.sh to generate certificates for zammad.localhost.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
src/development/stack.yml	Adds new service definitions and volume for Zammad, configuring image, dependencies, and traefik labels for routing.
src/development/certificates/mkcert.sh	Updates certificate generation to include zammad.localhost.

Comments suppressed due to low confidence (1)

src/development/stack.yml:697

[nitpick] Consider standardizing the naming convention between service names (e.g., 'zammad-elasticsearch') and the associated volume ('zammad_elasticsearch_data') for improved clarity.

zammad_elasticsearch_data: {}

Copilot · 2025-05-22T18:15:54Z

src/development/stack.yml

      - ../../../reccoom/:/srv/app/
+
+  zammad-elasticsearch:
+    image: zammad/zammad-docker-compose:latest


Using the 'latest' tag for the Zammad image can lead to unpredictable deployments. Consider pinning the image to a specific version to ensure consistency.

Suggested change

image: zammad/zammad-docker-compose:latest

image: zammad/zammad-docker-compose:5.0.3

dargmuesli

Dargstack expects each service to have a comment explaining what the service does, compare to the existing services. Also, run dargstack rgen to generate an updated README for others to see what services are in use.

dargmuesli · 2025-05-23T18:57:30Z

@huzaifaedhi22 please request review from @sthelemann instead of me to get a bit more into inter-team collaboration. I get notified about all new PRs either way and will comment if necessary. When you two are happy, you can request a final review from me.

sthelemann · 2025-05-25T19:51:49Z

src/development/stack.yml

+      - POSTGRESQL_USER=${POSTGRES_USER}
+      - POSTGRESQL_PASS=${POSTGRES_PASSWORD}


Instead of env variables we need to work with secrets, see postgres service definition.

sthelemann · 2025-05-25T19:51:56Z

src/development/stack.yml

+
+    secrets:
+      - source: postgres_user
+        target: POSTGRESQL_USER


Does this work? On https://docs.docker.com/reference/compose-file/services/#secrets it reads as if you have to name a file path for target.

That's right in Swarm mode target: under secrets: needs to be a file path, not a variable name. I'll update it.

feat(sqitch): add zammad secrets

dargmuesli · 2025-06-03T00:59:26Z

src/development/certificates/mkcert.sh

-    `# adminer` "adminer.localhost" \
-    `# grafana` "grafana.localhost" \
-    `# minio` "minio.localhost" \
-    `# portainer` "portainer.localhost" \
-    `# postgraphile` "postgraphile.localhost" \
-    `# prometheus` "prometheus.localhost" \
-    `# redpanda` "redpanda.localhost" \
-    `# traefik` "traefik.localhost" \
-    `# tusd` "tusd.localhost" \
-    `# vibetype` "localhost" "www.localhost" "127.0.0.1" "0.0.0.0"


No need to delete the comments

dargmuesli · 2025-06-03T01:10:34Z

src/development/stack.yml

      POSTGRES_PASSWORD_FILE: /run/secrets/postgres_password
      POSTGRES_USER_FILE: /run/secrets/postgres_user
-    image: postgis/postgis:17-3.5-alpine
+    image: imresamu/postgis:17-3.5.2-alpine3.21


To be reverted

dargmuesli · 2025-06-03T01:11:54Z

src/development/stack.yml

      - ../../../reccoom/:/srv/app/
+
+  zammad-elasticsearch:
+    image: bitnami/elasticsearch:${ELASTICSEARCH_VERSION:-8.18.0}


Suggested change

image: bitnami/elasticsearch:${ELASTICSEARCH_VERSION:-8.18.0}

image: bitnami/elasticsearch:8.18.0

dargmuesli · 2025-06-03T01:13:31Z

src/development/stack.yml

+
+  zammad-elasticsearch:
+    image: bitnami/elasticsearch:${ELASTICSEARCH_VERSION:-8.18.0}
+    restart: always


restart does not exist for stack I believe, see deploy.restart_policy.condition (https://docs.docker.com/reference/compose-file/deploy/#restart_policy)

dargmuesli · 2025-06-03T01:14:23Z

src/development/stack.yml

    volumes:
      - ../../../reccoom/:/srv/app/
+
+  zammad-elasticsearch:


Can elasticsearch be used by Zammad only or can we have it as elasticsearch only, similar to postgres?

Reading https://github.com/zammad/zammad-docker-compose?tab=readme-ov-file#running-without-elasticsearch it seems like elasticsearch could be excluded from the stack for "small teams". It appears some maintenance may be required for upgrades which I'm not sure how complicated they are. Please check that a bit further.

dargmuesli · 2025-06-03T01:21:11Z

src/development/stack.yml

+  zammad-init:
+    image: zammad/zammad-docker-compose:latest
+    restart: on-failure
+    depends_on:


depends_on does not exist for stacks I believe

dargmuesli · 2025-06-03T01:22:11Z

src/development/stack.yml

+    restart: always
+
+  zammad-websocket:
+    image: zammad/zammad-docker-compose:latest


Suggested change

image: zammad/zammad-docker-compose:latest

image: zammad/zammad-docker-compose:6.5.0-85

maybe?

dargmuesli · 2025-06-03T01:22:54Z

src/development/stack.yml

    # The message queue's data.
    {}
+  zammad_elasticsearch_data: {}
+  zammad_storage: {}


Suggested change

zammad_storage: {}

zammad_data: {}

dargmuesli

In general, why do the additions look so different compared to the source definition? Especially in that some services have some labels but not all? Isn't it possible to use x-shared?

dargmuesli · 2025-06-03T01:55:57Z

src/development/stack.yml

+      - NGINX_SERVER_NAME=zammad.${STACK_DOMAIN}
+      - REDIS_URL=redis://zammad-redis:6379


When I apply the same environment variables as for zammad-websocket the container starts nginx successfully. Also, port 8080 needs to be used, not 80.

dargmuesli · 2025-06-03T01:57:42Z

src/development/stack.yml

+        target: POSTGRESQL_PASS
+    command: ["zammad-scheduler"]
+
+  zammad-redis:


Similar to elasticsearch, can this just be called redis?

dargmuesli · 2025-06-03T02:24:12Z

src/development/stack.yml

+        target: POSTGRESQL_PASS
+    command: ["zammad-scheduler"]
+
+  zammad-redis:


In Postgraphile you see an unnamed volume:

Clicking it reveals that it is mounted by redis under /data:

So you can add a volume named redis_data on that path here too.

sthelemann · 2025-06-16T21:26:49Z

No idea what is still wrong with the [CI / dargstack rgen / Build (ubuntu-latest, 22) (pull_request) test.

dargmuesli · 2025-06-17T00:27:36Z

@sthelemann you have to run dargstack rgen to regenerate the README so that it accurately represents the stack contents for people interested in finding our configuration.

An x-shared section was added to the stack.yml file, similar as in the original docker-compose yaml file to reuse environment settings etc. in several Zammad services.

CLAassistant · 2025-06-28T08:02:29Z

All committers have signed the CLA.

feat(zammad): add config to stack.yml

5a70cc4

huzaifaedhi22 requested review from Copilot and dargmuesli May 22, 2025 18:15

Copilot AI reviewed May 22, 2025

View reviewed changes

dargmuesli reviewed May 22, 2025

View reviewed changes

sthelemann reviewed May 25, 2025

View reviewed changes

sthelemann and others added 3 commits May 25, 2025 22:14

feat(sqitch): add zammad secrets

b1d4bd4

Merge pull request #204 from maevsi/feat/sqitch/zammad-secrets

809c76b

feat(sqitch): add zammad secrets

fix: use postgres role

2db82da

dargmuesli reviewed Jun 3, 2025

View reviewed changes

Merge branch 'main' into feat/zammad

4a73d7e

sthelemann force-pushed the feat/zammad branch 3 times, most recently from bc2a3ae to 032e6c0 Compare June 16, 2025 21:20

feat(zammad): use x-shared section

8038985

An x-shared section was added to the stack.yml file, similar as in the original docker-compose yaml file to reuse environment settings etc. in several Zammad services.

sthelemann force-pushed the feat/zammad branch from 032e6c0 to 8038985 Compare June 17, 2025 20:59

	image: zammad/zammad-docker-compose:latest
	image: zammad/zammad-docker-compose:5.0.3

		- POSTGRESQL_USER=${POSTGRES_USER}
		- POSTGRESQL_PASS=${POSTGRES_PASSWORD}

	image: bitnami/elasticsearch:${ELASTICSEARCH_VERSION:-8.18.0}
	image: bitnami/elasticsearch:8.18.0

	image: zammad/zammad-docker-compose:latest
	image: zammad/zammad-docker-compose:6.5.0-85

		- NGINX_SERVER_NAME=zammad.${STACK_DOMAIN}
		- REDIS_URL=redis://zammad-redis:6379

Uh oh!

feat(zammad): add config to stack.yml #202

Are you sure you want to change the base?

feat(zammad): add config to stack.yml #202

Uh oh!

Conversation

huzaifaedhi22 commented May 22, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 22, 2025

Choose a reason for hiding this comment

Uh oh!

dargmuesli left a comment

Choose a reason for hiding this comment

Uh oh!

dargmuesli commented May 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dargmuesli left a comment

Choose a reason for hiding this comment

Uh oh!

dargmuesli Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sthelemann commented Jun 16, 2025

Uh oh!

dargmuesli commented Jun 17, 2025

Uh oh!

CLAassistant commented Jun 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dargmuesli Jun 3, 2025 •

edited

Loading

CLAassistant commented Jun 28, 2025 •

edited

Loading