peerdb-flow-worker

packaged by Chainguard

Chainguard Container for peerdb-flow-worker

PeerDB flow components (API, worker, snapshot worker, and maintenance) for Postgres-native data replication.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/peerdb-flow-worker:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

The peerdb-flow image group provides role-specific replacements for external PeerDB flow images:

• cgr.dev/ORGANIZATION/peerdb-flow-api:latest
• cgr.dev/ORGANIZATION/peerdb-flow-worker:latest
• cgr.dev/ORGANIZATION/peerdb-flow-snapshot-worker:latest
• cgr.dev/ORGANIZATION/peerdb-flow-maintenance:latest

Each image contains the same PeerDB peer-flow binary and sets a role-specific entrypoint. The API image starts peer-flow api --port 8112 --gateway-port 8113, while the worker, snapshot worker, and maintenance images start their corresponding peer-flow subcommands.

Use the same PeerDB version tag across all flow images and the rest of your PeerDB deployment. The flow API, CDC worker, snapshot worker, catalog, Temporal services, and UI are designed to run as one versioned stack.

The Chainguard images run as non-root UID 1000 with /home/peerdb as the working directory. Like other minimal production Chainguard Containers, they do not include a shell or package manager.

PeerDB's flow binary reads /sys/fs/cgroup/memory.max during startup. Standard Docker and Kubernetes environments provide this file automatically. In Docker-in-Docker (DinD) or bare-metal CI environments where cgroup v2 is not exposed to containers, add privileged: true and mount the host cgroup filesystem read-only (/sys/fs/cgroup:/sys/fs/cgroup:ro). Do not add this mount on Docker Desktop (macOS/Windows), as it replaces the container's native cgroup with an empty host directory and prevents the binary from starting.

Getting Started

PeerDB is normally deployed as a stack. Use the upstream PeerDB deployment files for your selected PeerDB version, then override only the flow images with their Chainguard equivalents.

Clone PeerDB and check out the version you want to deploy:

git clone https://github.com/PeerDB-io/peerdb.git
cd peerdb
git checkout vX.Y.Z

Create a Docker Compose override for the Chainguard flow images:

cat > docker-compose.chainguard.yaml <<EOF
services:
  flow-api:
    image: cgr.dev/ORGANIZATION/peerdb-flow-api:latest
    environment:
      GOMEMLIMIT: 1GiB

  flow-worker:
    image: cgr.dev/ORGANIZATION/peerdb-flow-worker:latest
    environment:
      GOMEMLIMIT: 1GiB

  flow-snapshot-worker:
    image: cgr.dev/ORGANIZATION/peerdb-flow-snapshot-worker:latest
    environment:
      GOMEMLIMIT: 1GiB
EOF

Be sure to replace ORGANIZATION with the name used for your organization's private repository within the Chainguard Registry. Replace latest with the PeerDB version tag you use in production when pinning versions.

Start the PeerDB stack with the override file:

docker compose -f docker-compose.yml -f docker-compose.chainguard.yaml up -d

Confirm that the flow services are running:

docker compose -f docker-compose.yml -f docker-compose.chainguard.yaml ps flow-api flow-worker flow-snapshot-worker

The peerdb-flow-maintenance image is a one-shot maintenance and upgrade tool. Use it anywhere your PeerDB upgrade procedure or upstream deployment manifests call for the upstream flow-maintenance image.

Documentation and Resources

• PeerDB Documentation
• PeerDB Quickstart Guide
• PeerDB GitHub Repository

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.