containers/zabbixserver

Upstream repo

We use the official Zabbix Docker GitHub repo for Docker Compose deployment, we add a few local changes.

Create dir

mkdir -p '/opt/git/github.com/zabbix/zabbix-docker/branches/latest'

Pull repo

git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' clone 'https://github.com/zabbix/zabbix-docker' .

Docker Compose

Base setup

When everything's ready start Zabbix with Docker Compose, otherwise head down to Initial setup or Upgrade an existing repo first.

Define variables assuming the official Zabbix Docker repo lives at /opt/git/github.com/zabbix/zabbix-docker/branches/latest:

export COMPOSE_DIR='/opt/git/github.com/zabbix/zabbix-docker/branches/latest'
export COMPOSE_FILE="${COMPOSE_DIR}"'/docker-compose_v3_alpine_pgsql_latest.yaml'
export COMPOSE_ENV_FILE=<add accordingly>

Run Zabbix like so

docker compose --file "${COMPOSE_FILE}" --env-file "${COMPOSE_ENV_FILE}" up

Additional files

• common-settings.yml

  This file will be auto-created as part of the patch. Use it as an example in case patching fails

• env/fqdn_contaxt.env.example

  An example env file with all currently used variables after docker-compose_v3_alpine_pgsql_latest.yaml is patched

• Directory tree underneath build-context

  build-context/
  └── docker-data
      ├── postgres
      │   └── config
      │       ├── cert
      │       │   ├── ZBX_PGSQL_TLS_CA_CERT_FILE
      │       │   ├── ZBX_PGSQL_TLS_CERT_FILE
      │       │   └── ZBX_PGSQL_TLS_KEY_FILE
      │       └── docker-entrypoint-initdb.d
      │           └── init-user-db.sh
      ├── zabbixserver
      │   └── config
      │       └── cert
      │           ├── ZBX_SERVER_TLS_CA_CERT_FILE
      │           ├── ZBX_SERVER_TLS_CERT_FILE
      │           └── ZBX_SERVER_TLS_KEY_FILE
      └── zabbixwebnginx
          └── config
              └── cert
                  ├── dhparam.pem
                  ├── ZBX_WEBNGINX_TLS_CERT_FULLCHAIN_FILE
                  └── ZBX_WEBNGINX_TLS_KEY_FILE
  

  Example data you're going to want to physically place on your deployment machine. SSL certs and keys are blank files each of which has the exact same name used in the env file fqdn_contaxt.env.example.

  A PostgreSQL initialization script - when this container is run on a completely empty data directory - will create an additional read-only user ZBX_DB_USERNAME_RO with password ZBX_DB_USERNAME_PW. The example's intended to grant a Grafana daemon direct PostgreSQL database read access.

Upgrade an existing repo

Check Initial setup below for first time steps. On consecutive upgrades proceed as follows.

Revert unpushed local changes

Return repo state to exactly the upstream repo's original branch state throwing away the commits you added.

git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' reset --hard origin

Switch to trunk branch, get newest commits from upstream

git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' checkout trunk
git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' pull

Pick and checkout new tag

while IFS= read -r tag; do printf -- '%s %s\n' "$(git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' rev-list -n 1 'refs/tags/'"${tag}")" "${tag}"; done < <(git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' --no-pager tag --list --sort=v:refname)

# Output goes like:
...
89511f06ad4de6b373f10b06604dc5d8e1da02df 6.2.7
2025ec8ad74f59981ad6598e9f6cd2a5c9c99f6b 6.2.8
59a91bfbb6e46885f201e50f9197a7a44d3ba3ac 6.2.9
9f2e726e554b23595489eb66c8e11e5d114b573f 6.4.0
9f16f6d773a2a46f1595c86077899d1e040db283 6.4.1
0fa87156974e799e04bf99e5300bad6830d754ab 6.4.2
...

git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' checkout 'tags/x.y.z'

Lastly apply patch. If patch does not apply cleanly read on in the next section Create new patch to find out how to fix your patch.

Create new patch

Add your changes as commits

Get zabbix-docker repo into a state with which you're happy then

git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' format-patch 7665739620ba6d99090838d502ab76d2f5a47e96^..a17380598ca66153ddc2a42eb618d906d4f582e6 --stdout > '/opt/containers/zabbixserver/zabbix-docker.patch'

Where the first commit hash is our first commit and the other commit hash is our last commit. Note the caret (^) right after the first commit hash.

Investigation

You may have to try and find out how a known good base commit differs from a newer one in case the newer one does no longer cleanly accept the patch.

Get commit hashes from both affected tags, e.g.

while IFS= read -r tag; do printf -- '%s %s\n' "$(git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' rev-list -n 1 'refs/tags/'"${tag}")" "${tag}"; done < <(git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' --no-pager tag --list --sort=v:refname)

# Output goes like:
...
89511f06ad4de6b373f10b06604dc5d8e1da02df 6.2.7
2025ec8ad74f59981ad6598e9f6cd2a5c9c99f6b 6.2.8
59a91bfbb6e46885f201e50f9197a7a44d3ba3ac 6.2.9
9f2e726e554b23595489eb66c8e11e5d114b573f 6.4.0
9f16f6d773a2a46f1595c86077899d1e040db283 6.4.1
0fa87156974e799e04bf
# Run
99e5300bad6830d754ab 6.4.2
...

Diff them

git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' diff 9f16f6d773a2a46f1595c86077899d1e040db283 0fa87156974e799e04bf99e5300bad6830d754ab 'docker-compose_v3_alpine_pgsql_latest.yaml'

Output will be empty in case no difference exists in docker-compose_v3_alpine_pgsql_latest.yaml between both commit hashes.

Commit your updated patch file into this repo. With a new working patch in hand head back up to Upgrade an existing repo.

Initial setup

Prep

Get desired tag e.g. from version-sorted tags list

while IFS= read -r tag; do printf -- '%s %s\n' "$(git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' rev-list -n 1 'refs/tags/'"${tag}")" "${tag}"; done < <(git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' --no-pager tag --list --sort=v:refname)

# Output goes like:
...
89511f06ad4de6b373f10b06604dc5d8e1da02df 6.2.7
2025ec8ad74f59981ad6598e9f6cd2a5c9c99f6b 6.2.8
59a91bfbb6e46885f201e50f9197a7a44d3ba3ac 6.2.9
9f2e726e554b23595489eb66c8e11e5d114b573f 6.4.0
9f16f6d773a2a46f1595c86077899d1e040db283 6.4.1
0fa87156974e799e04bf99e5300bad6830d754ab 6.4.2
...

Switch to desired tag

git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' checkout 'tags/6.4.2'

Apply patch

Identify yourself to the local zabbix-docker repo

git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' config user.name "hygienic-books"
git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' config user.email "hygienic-books@tentic.net"

Apply zabbix-docker.patch to Docker Compose file. We use Zabbix' docker-compose_v3_alpine_pgsql_latest.yaml Compose file. Assuming this repo lives at /opt/containers/zabbixserver:

git -C '/opt/git/github.com/zabbix/zabbix-docker/branches/latest' am '/opt/containers/zabbixserver/zabbix-docker.patch'

# Output will be:
Applying: refactor(compose): Remove trailing whitespace
Applying: refactor(compose): 4 leading spaces
Applying: refactor(compose): Indent comments
Applying: refactor(zabbix-server): Set correct libs paths
Applying: refactor(zabbix-server): Set TLS cert file names
Applying: feat(zabbix-server): Replace env files with variables
...

And now back up to Docker Compose.