Containerized deployment

You can use either Docker or Podman container management engines.

This guide uses Docker to illustrate the required commands. If you are using Podman, simply replace docker with podman below.

  • Change directory to your Redis Data Integration configuration folder created by the scaffold command.

  • Verify that you’ve configured a debezium/application.properties file based on these instructions.

  • Run:

    docker run -d --name debezium --restart always -v $PWD/debezium:/debezium/conf --log-driver local --log-opt max-size=100m --log-opt max-file=4 --log-opt mode=non-blocking debezium/server:2.1.1.Final

  • Check the Debezium Server log:

    docker logs debezium --follow

Custom timezone

The UTC timezone is used in the Debezium Server container by default. To use another timezone, specify it by setting the TZ environment variable when running the container. For example:

docker run -d --name debezium -e TZ=Europe/London --restart always -v $PWD/debezium:/debezium/conf --log-driver local --log-opt max-size=100m --log-opt max-file=4 --log-opt mode=non-blocking debezium/server:2.1.1.Final

SELinux

If your Linux machine has SELinux enabled in enforced mode (default for Red Hat Enterprise Linux), you need to configure the SELinux label for the bind mount volume by adding :Z at the end of the mount directive:

-v $PWD/debezium:/debezium/conf:Z

Network configuration

The examples in this document assume that the default Docker bridge network is used. Depending on your network topology, you may need to add the --network option, either for a user-defined bridge or for the host network. For example:

--network=host

Oracle

If you are using Oracle as your source database, note that Debezium Server does not include the Oracle JDBC driver. As result, it will fail with an error. You should follow these steps to add the JDBC driver and restart Debezium Server:

  • Download the driver:

    wget -P oracle https://repo1.maven.org/maven2/com/oracle/database/jdbc/ojdbc8/21.1.0.0/ojdbc8-21.1.0.0.jar

  • Bind mount the driver into the container:

    docker run -d --name debezium --restart always -v $PWD/oracle/ojdbc8-21.1.0.0.jar:/debezium/lib/ojdbc8-21.1.0.0.jar -v $PWD/debezium:/debezium/conf --log-driver local --log-opt max-size=100m --log-opt max-file=4 --log-opt mode=non-blocking debezium/server:2.1.1.Final

Running Docker as a non-root user

We recommend running Docker as a non-root user. To allow this, follow these steps:

  • If group docker doesn’t exist in /etc/group:

    sudo groupadd docker

  • Add the current user to group docker:

    sudo usermod -aG docker $USER

  • Restart the terminal session so the changes take effect

For added security, the Debezium Server container can be run in a rootless Docker or Podman environment.

Non-containerized deployment

  • Install Java 11 or Java 17.

  • Download Debezium Server 2.3.0.Final from here.

  • Unpack Debezium Server:

    tar xvfz debezium-server-dist-2.3.0.Final.tar.gz

  • Copy the scaffolded application.properties file (created by the scaffold command to the extracted debezium-server/conf directory. Verify that you’ve configured this file based on these instructions.

  • If you are using Oracle as your source database, please note that Debezium Server does not include the Oracle JDBC driver. You should download it and locate under debezium-server/lib directory:

    cd debezium-server/lib
wget https://repo1.maven.org/maven2/com/oracle/database/jdbc/ojdbc8/21.1.0.0/ojdbc8-21.1.0.0.jar

  • Uncomment the following lines in the application.properties file and set the value for the quarkus.log.file.path property:

quarkus.log.file.enable=true
# The full path to the Debezium Server log files.
quarkus.log.file.path=<LOG_FILE_PATH>
# The maximum file size of the log file after which a rotation is executed.
quarkus.log.file.rotation.max-file-size=100M
# Indicates whether to rotate log files on server initialization.
quarkus.log.file.rotation.rotate-on-boot=true
# File handler rotation file suffix. When used, the file will be rotated based on its suffix.
quarkus.log.file.rotation.file-suffix=.yyyy-MM-dd.gz
# The maximum number of backups to keep.
quarkus.log.file.rotation.max-backup-index=3
  • Start Debezium Server from the debezium-server directory:
    ./run.sh