Skip to main content

Using a custom registry

zymtrace's public container images are published to Docker Hub. However, organizations with strict security policies or air-gapped environments may need to store and distribute images through a private registry, such as JFrog Artifactory.

To achieve this, you need to pull zymtrace's official images from Docker Hub, push them to your private registry, and update your Helm charts or Kunernetest manifests to use those images.

Follow the steps below to set up your custom registry.

Preparing images for your registry​

Step 1: Pull the required images​

First, pull the official zymtrace public images from Docker Hub:

docker pull docker.io/zystemio/zymtrace-pub-backend:<VERSION>
docker pull docker.io/zystemio/zymtrace-pub-ui:<VERSION>
docker pull docker.io/zystemio/zymtrace-pub-profiler:<VERSION>

When using create mode for datbases or storageservices, you'll also need to pull these supporting images:

# Only required if using create mode for databases and storage
docker pull docker.io/clickhouse/clickhouse-server:<VERSION>
docker pull docker.io/scylladb/scylla:<VERSION>
docker pull docker.io/minio/minio:<VERSION>

Replace <VERSION> with the specific tag version from https://hub.docker.com/r/zystemio

Step 2: Tag and push images​

Tag the images with your registry prefix:

# zymtrace services
docker tag docker.io/zystemio/zymtrace-pub-backend:<VERSION> <REGISTRY>/zymtrace-pub-backend:<VERSION>
docker tag docker.io/zystemio/zymtrace-pub-ui:<VERSION> <REGISTRY>/zymtrace-pub-ui:<VERSION>
docker tag docker.io/zystemio/zymtrace-pub-profiler:<VERSION> <REGISTRY>/zymtrace-pub-profiler:<VERSION>

# Storage services (only if using create mode)
docker tag docker.io/clickhouse/clickhouse-server:<VERSION> <REGISTRY>/clickhouse-server:<VERSION>
docker tag docker.io/scylladb/scylla:<VERSION> <REGISTRY>/scylla:<VERSION>
docker tag docker.io/minio/minio:<VERSION> <REGISTRY>/minio:<VERSION>

Push the tagged images to your registry:

# zymtrace services
docker push <REGISTRY>/zymtrace-pub-backend:<VERSION>
docker push <REGISTRY>/zymtrace-pub-ui:<VERSION>
docker push <REGISTRY>/zymtrace-pub-profiler:<VERSION>

# Infrastructure services (only if using create mode)
docker push <REGISTRY>/clickhouse-server:<VERSION>
docker push <REGISTRY>/scylla:<VERSION>
docker push <REGISTRY>/minio:<VERSION>

Update zymtrace helm charts​

Backend configuration​

Update your backend-custom-values.yaml to use your registry:

backend-custom-values.yaml
global:
  imageRegistry: "<REGISTRY>"  # Your registry prefix
  appImageRegistry: "<REGISTRY>"  # Same as imageRegistry for unified registry
  registry:
    requirePullSecret: false  # Set to true if authentication is required

# Application Services
services:
  common:
    imageTag: "<VERSION>"  
  
  ingest:
    image:
      repository: zymtrace-pub-backend
  
  migrate:
    image:
      repository: zymtrace-pub-backend
  
  web:
    image:
      repository: zymtrace-pub-backend
  
  symdb:
    image:
      repository: zymtrace-pub-backend
  
  identity:
    image:
      repository: zymtrace-pub-backend
  
  ui:
    image:
      repository: zymtrace-pub-ui

# Infrastructure Services (only include if using create mode)
clickhouse:
  mode: "create"
  create:
    image:
      repository: clickhouse-server
      tag: "2<VERSION>"

scylla:
  mode: "create"
  create:
    image:
      repository: scylla
      tag: "<VERSION>"

storage:
  mode: "create"
  create:
    image:
      repository: minio
      tag: "<VERSION>"

Install or upgrade zymtrace backend with your custom registry configuration:

helm upgrade --install backend zymtrace/backend \
  -f custom-values.yaml \
  -n zymtrace

Profiler configuration​

Repeat the same step for the profiler-custom-values.yaml

profiler-custom-values.yaml

global:
  imageRegistry: "<REGISTRY>"
  registry:
    requirePullSecret: false

profiler:
  image:
    repository: zymtrace-pub-profiler
    tag: "<VERSION>"

Then install or upgrade zymtrace profiler with your custom registry configuration:

helm upgrade --install profiler zymtrace/profiler \
  -f custom-values.yaml \
  -n zymtrace
info

Our public images require a ZYMTRACE_SERIAL number to run the services. Please contact us to get yours.

Verification​

Verify that your deployment is using images from your custom registry:

kubectl get pods -n zymtrace -o=jsonpath='{range .items[*]}{"\n"}{.metadata.name}{":\n"}{range .spec.containers[*]}{.image}{"\n"}{end}{end}'

You should see all images referenced with your custom registry prefix instead of the default docker.io/zystemio.

Troubleshooting​

If you encounter image pull errors:

  1. Verify your registry credentials if authentication is enabled
  2. Check that all images were successfully pushed to your registry
  3. Ensure your Kubernetes cluster can access your registry

For version-related issues:

  1. Confirm all image versions match your zymtrace release
  2. Verify that global imageTag settings aren't conflicting with individual service tags
tip

For additional help, contact us.