artefactual/gearmand repository overview

⁠gearmand

artefactual/gearmand packages recent versions of gearmand using Alpine Linux as the base image.

⁠Supported tags and respective Dockerfile links

Only the following version is currently supported and maintained:

• 2.1.0-alpine, 2.1.0, latest (Dockerfile)⁠

This image is built on version 2.1.0⁠ of gearmand⁠.

⁠Supported gearmand backends

• builtin (default)
• libmemcached
• libsqlite3
• mysql (using mariadb-dev)
• redis

⁠Usage

Print help:

docker run --rm -i artefactual/gearmand:latest --help

Use redis backend and set verbose level to DEBUG.

docker run --rm -i artefactual/gearmand:latest --queue-type=redis --redis-server=192.168.1.1 --redis-port=6379 --verbose=DEBUG

The image health check uses the gearman --ping client command to verify that the job server responds to the Gearman protocol. It checks the port configured by GEARMAND_PORT, the legacy LISTEN_PORT, or port 4730 by default. Override the health check when using a custom configuration file that binds another address or port, or when accepting only SSL connections.

⁠MySQL queue

Set QUEUE_TYPE=mysql and provide the database connection settings to use a MySQL or MariaDB server for the persistent queue:

docker run --rm \
  -e QUEUE_TYPE=mysql \
  -e MYSQL_HOST=mysql \
  -e MYSQL_USER=gearman \
  -e MYSQL_PASSWORD=secret \
  -e MYSQL_DB=Gearmand \
  artefactual/gearmand:latest

MariaDB Connector/C 3.4 and newer enables verified TLS automatically for TCP connections. If the database server does not support TLS, gearmand exits with SSL is required, but the server does not support it. Set MARIADB_TLS_DISABLE_PEER_VERIFICATION=1 to allow the connector to use an unencrypted connection:

services:
  gearmand:
    image: artefactual/gearmand:latest
    environment:
      QUEUE_TYPE: mysql
      MYSQL_HOST: mysql
      MYSQL_USER: gearman
      MYSQL_PASSWORD: secret
      MYSQL_DB: Gearmand
      MARIADB_TLS_DISABLE_PEER_VERIFICATION: "1"

⁠Environment variables

This image includes an entry point that translates environment strings into configuration attributes⁠. The following is a list of the strings currently supported:

Gearman 2.x always uses round-robin scheduling and no longer provides a way to disable it. The deprecated ROUND_ROBIN environment variable is ignored and produces a warning when set.

Gearman 2.1 changed --job-retries=0 from unlimited retries to no retries. The image now uses -1 by default to preserve its previous unlimited-retry behavior. Users that explicitly set JOB_RETRIES=0 must change it to -1 if they want jobs to continue retrying without a limit.

Keepalive remains opt-in. When KEEPALIVE is enabled, the defaults above match the production values recommended in the Gearman 2.0.0 release notes⁠.

You can also inject your version of config file to /etc/gearmand.conf as needed.

⁠Release process

To create a new release, run the following command, replacing VERSION with the desired version (which must match a directory for the build context in this repository), e.g. 2.1.0:

gh workflow run release.yml --field version=VERSION

Beginning with Gearman 2.0.0, packaging-only rebuilds keep the upstream version and append a release suffix, starting with -r1 (for example, 2.1.0-r1). Gearman 1.x images retain the legacy dotted scheme (for example, 1.1.22.1). See CONTRIBUTING.md⁠ for the versioning policy.

This command will automatically build and publish the images, create a git tag, and publish a GitHub release.

⁠Credits

See the list of contributors⁠.

Thanks to @Mararok for the new entry point bringing support for environment variables and secrets.