-
Notifications
You must be signed in to change notification settings - Fork 232
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a572053
commit 524e61b
Showing
9 changed files
with
203 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
FROM postgres:17-alpine | ||
|
||
LABEL maintainer="Debezium Community" | ||
ENV PLUGIN_VERSION=v3.0.0.Final | ||
|
||
RUN apk add --no-cache protobuf-c-dev | ||
|
||
# Compile the plugins from sources and install | ||
RUN apk add --no-cache --virtual .debezium-build-deps gcc clang15 llvm15 git make musl-dev pkgconf \ | ||
&& git clone https://github.com/debezium/postgres-decoderbufs -b $PLUGIN_VERSION --single-branch \ | ||
&& (cd /postgres-decoderbufs && make && make install) \ | ||
&& rm -rf postgres-decoderbufs \ | ||
&& apk del .debezium-build-deps | ||
|
||
# Copy the custom configuration which will be passed down to the server (using a .sample file is the preferred way of doing it by | ||
# the base Docker image) | ||
COPY postgresql.conf.sample /usr/local/share/postgresql/postgresql.conf.sample | ||
|
||
# Copy the script which will initialize the replication permissions | ||
COPY /docker-entrypoint-initdb.d /docker-entrypoint-initdb.d |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
The [Postgres](https://www.postgresql.org) relational database management system has a feature called [logical decoding](https://www.postgresql.org/docs/17/static/logicaldecoding-explanation.html) that allows clients to extract all persistent changes to a database's tables into a coherent, easy to understand format which can be interpreted without detailed knowledge of the database's internal state. An output plugin transform the data from the write-ahead log's internal representation into the format the consumer of a replication slot desires. | ||
|
||
This image is based upon [`postgres:17-alpine`](https://hub.docker.com/_/postgres/) and adds one logical decoding plug-in: | ||
|
||
* [postgres-decoderbufs](https://github.com/debezium/), based on Protocol Buffers and maintained by the Debezium community | ||
|
||
It is supported by the [Debezium PostgreSQL Connector](http://debezium.io/docs/connectors/postgresql/) to capture changes committed to the database and record the data change events in Kafka topics. | ||
In addition, Debezium supports the `pgoutput` plug-in, which is available by default on Postgres 10 and later. | ||
|
||
This provides an example of how the Debezium output plugin can be installed and how to enable PostgreSQL's logical decoding feature. | ||
|
||
# What is Debezium? | ||
|
||
Debezium is a distributed platform that turns your existing databases into event streams, so applications can quickly react to each row-level change in the databases. Debezium is built on top of Kafka and provides Kafka Connect compatible connectors that monitor specific database management systems. Debezium records the history of data changes in Kafka logs, so your application can be stopped and restarted at any time and can easily consume all of the events it missed while it was not running, ensuring that all events are processed correctly and completely. | ||
|
||
Running Debezium involves Zookeeper, Kafka, and services that run Debezium's connectors. For simple evaluation and experimentation, all services can all be run on a single host machine, using the recipe outlined below. Production environments, however, require properly running and networking multiple instances of each service to provide the performance, reliability, replication, and fault tolerance. This can be done with a platform like [OpenShift](https://www.openshift.com) that manages multiple Docker containers running on multiple hosts and machines. But running Kafka in a Docker container has limitations, so for scenarios where very high throughput is required, you should run Kafka on dedicated hardware as explained in the [Kafka documentation](http://kafka.apache.org/documentation.html). | ||
|
||
|
||
# How to use this image | ||
|
||
This image is used in the same manner as the [`postgres:17-alpine`](https://hub.docker.com/_/postgres/) image, though the `/usr/share/postgresql/postgresql.conf.sample` file configures the logical decoding feature: | ||
|
||
``` | ||
# LOGGING | ||
log_min_error_statement = fatal | ||
# CONNECTION | ||
listen_addresses = '*' | ||
# MODULES | ||
shared_preload_libraries = 'decoderbufs' | ||
# REPLICATION | ||
wal_level = logical # minimal, archive, hot_standby, or logical (change requires restart) | ||
max_wal_senders = 1 # max number of walsender processes (change requires restart) | ||
#wal_keep_segments = 4 # in logfile segments, 16MB each; 0 disables | ||
#wal_sender_timeout = 60s # in milliseconds; 0 disables | ||
max_replication_slots = 1 # max number of replication slots (change requires restart) | ||
``` | ||
|
||
This file instructs PostgreSQL to load [Debezium's logical decoding output plugin](https://github.com/debezium/postgres-decoderbufs), enable the logical decoding feature, and configure a single replication slot that will be used by the Debezium PostgreSQL Connector. |
4 changes: 4 additions & 0 deletions
4
postgres/17-alpine/docker-entrypoint-initdb.d/init-permissions.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
#!/bin/bash | ||
set -e | ||
|
||
{ echo "host replication $POSTGRES_USER 0.0.0.0/0 trust"; } >> "$PGDATA/pg_hba.conf" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# LOGGING | ||
# log_min_error_statement = fatal | ||
# log_min_messages = DEBUG1 | ||
|
||
# CONNECTION | ||
listen_addresses = '*' | ||
|
||
# MODULES | ||
shared_preload_libraries = 'decoderbufs' | ||
|
||
# REPLICATION | ||
wal_level = logical # minimal, archive, hot_standby, or logical (change requires restart) | ||
max_wal_senders = 4 # max number of walsender processes (change requires restart) | ||
#wal_keep_segments = 4 # in logfile segments, 16MB each; 0 disables | ||
#wal_sender_timeout = 60s # in milliseconds; 0 disables | ||
max_replication_slots = 4 # max number of replication slots (change requires restart) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
FROM postgres:17-bullseye AS build | ||
|
||
ARG USE_POSTGIS=true | ||
ENV PLUGIN_VERSION=v3.0.0.Final | ||
ENV PROTOC_VERSION=1.4 | ||
|
||
# Install the packages which will be required to get everything to compile | ||
RUN apt-get update \ | ||
&& apt-get install -f -y --no-install-recommends \ | ||
software-properties-common \ | ||
build-essential \ | ||
pkg-config \ | ||
git \ | ||
clang-11 \ | ||
llvm-11 \ | ||
postgresql-server-dev-$PG_MAJOR \ | ||
&& add-apt-repository "deb http://ftp.debian.org/debian testing main contrib" \ | ||
&& apt-get update && apt-get install -f -y --no-install-recommends \ | ||
libprotobuf-c-dev=$PROTOC_VERSION.* \ | ||
&& rm -rf /var/lib/apt/lists/* | ||
|
||
# Compile the plugin from sources and install it | ||
RUN git clone https://github.com/debezium/postgres-decoderbufs -b $PLUGIN_VERSION --single-branch \ | ||
&& cd /postgres-decoderbufs \ | ||
&& make && make install \ | ||
&& cd / \ | ||
&& rm -rf postgres-decoderbufs | ||
|
||
|
||
FROM postgres:17-bullseye | ||
|
||
LABEL maintainer="Debezium Community" | ||
|
||
ENV POSTGIS_VERSION=3 | ||
|
||
RUN apt-get update \ | ||
&& apt-get install -f -y --no-install-recommends \ | ||
software-properties-common \ | ||
&& if [ "$USE_POSTGIS" != "false" ]; then apt-get install -f -y --no-install-recommends \ | ||
postgresql-$PG_MAJOR-postgis-$POSTGIS_VERSION \ | ||
postgresql-$PG_MAJOR-postgis-$POSTGIS_VERSION-scripts \ | ||
postgis; \ | ||
fi \ | ||
&& if [ "$USE_PGVECTOR" != "false" ]; then apt-get install -f -y --no-install-recommends \ | ||
postgresql-$PG_MAJOR-pgvector; \ | ||
fi \ | ||
&& add-apt-repository "deb http://ftp.debian.org/debian testing main contrib" \ | ||
&& apt-get update && apt-get install -f -y --no-install-recommends \ | ||
libprotobuf-c1 \ | ||
&& rm -rf /var/lib/apt/lists/* | ||
|
||
COPY --from=build /usr/lib/postgresql/$PG_MAJOR/lib/decoderbufs.so /usr/lib/postgresql/$PG_MAJOR/lib/ | ||
COPY --from=build /usr/share/postgresql/$PG_MAJOR/extension/decoderbufs.control /usr/share/postgresql/$PG_MAJOR/extension/ | ||
# Copy the custom configuration which will be passed down to the server (using a .sample file is the preferred way of doing it by | ||
# the base Docker image) | ||
COPY postgresql.conf.sample /usr/share/postgresql/postgresql.conf.sample | ||
|
||
# Copy the script which will initialize the replication permissions | ||
COPY /docker-entrypoint-initdb.d /docker-entrypoint-initdb.d |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
The [Postgres](https://www.postgresql.org) relational database management system has a feature called [logical decoding](https://www.postgresql.org/docs/17/static/logicaldecoding-explanation.html) that allows clients to extract all persistent changes to a database's tables into a coherent, easy to understand format which can be interpreted without detailed knowledge of the database's internal state. An output plugin transform the data from the write-ahead log's internal representation into the format the consumer of a replication slot desires. | ||
|
||
This image is based upon [`postgres:17`](https://hub.docker.com/_/postgres/) and adds one logical decoding plug-in: | ||
|
||
* [postgres-decoderbufs](https://github.com/debezium/), based on Protocol Buffers and maintained by the Debezium community | ||
|
||
It is supported by the [Debezium PostgreSQL Connector](http://debezium.io/docs/connectors/postgresql/) to capture changes committed to the database and record the data change events in Kafka topics. | ||
In addition, Debezium supports the `pgoutput` plug-in, which is available by default on Postgres 10 and later. | ||
The image also includes [PostGIS](http://www.postgis.net) spatial database extender used to provide geospatial queries, so that changes to geometric data can also be captured by Debezium. | ||
|
||
This provides an example of how the Debezium output plugin can be installed and how to enable PostgreSQL's logical decoding feature. | ||
|
||
# What is Debezium? | ||
|
||
Debezium is a distributed platform that turns your existing databases into event streams, so applications can quickly react to each row-level change in the databases. Debezium is built on top of Kafka and provides Kafka Connect compatible connectors that monitor specific database management systems. Debezium records the history of data changes in Kafka logs, so your application can be stopped and restarted at any time and can easily consume all of the events it missed while it was not running, ensuring that all events are processed correctly and completely. | ||
|
||
Running Debezium involves Zookeeper, Kafka, and services that run Debezium's connectors. For simple evaluation and experimentation, all services can all be run on a single host machine, using the recipe outlined below. Production environments, however, require properly running and networking multiple instances of each service to provide the performance, reliability, replication, and fault tolerance. This can be done with a platform like [OpenShift](https://www.openshift.com) that manages multiple Docker containers running on multiple hosts and machines. But running Kafka in a Docker container has limitations, so for scenarios where very high throughput is required, you should run Kafka on dedicated hardware as explained in the [Kafka documentation](http://kafka.apache.org/documentation.html). | ||
|
||
|
||
# How to use this image | ||
|
||
This image is used in the same manner as the [`postgres:17`](https://hub.docker.com/_/postgres/) image, though the `/usr/share/postgresql/postgresql.conf.sample` file configures the logical decoding feature: | ||
|
||
``` | ||
# LOGGING | ||
log_min_error_statement = fatal | ||
# CONNECTION | ||
listen_addresses = '*' | ||
# MODULES | ||
shared_preload_libraries = 'decoderbufs' | ||
# REPLICATION | ||
wal_level = logical # minimal, archive, hot_standby, or logical (change requires restart) | ||
max_wal_senders = 1 # max number of walsender processes (change requires restart) | ||
#wal_keep_segments = 4 # in logfile segments, 16MB each; 0 disables | ||
#wal_sender_timeout = 60s # in milliseconds; 0 disables | ||
max_replication_slots = 1 # max number of replication slots (change requires restart) | ||
``` | ||
|
||
This file instructs PostgreSQL to load [Debezium's logical decoding output plugin](https://github.com/debezium/postgres-decoderbufs), enable the logical decoding feature, and configure a single replication slot that will be used by the Debezium PostgreSQL Connector. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
#!/bin/bash | ||
set -e | ||
|
||
{ echo "host replication $POSTGRES_USER 0.0.0.0/0 trust"; } >> "$PGDATA/pg_hba.conf" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# LOGGING | ||
# log_min_error_statement = fatal | ||
# log_min_messages = DEBUG1 | ||
|
||
# CONNECTION | ||
listen_addresses = '*' | ||
|
||
# MODULES | ||
shared_preload_libraries = 'decoderbufs' | ||
|
||
# REPLICATION | ||
wal_level = logical # minimal, archive, hot_standby, or logical (change requires restart) | ||
max_wal_senders = 4 # max number of walsender processes (change requires restart) | ||
#wal_keep_segments = 4 # in logfile segments, 16MB each; 0 disables | ||
#wal_sender_timeout = 60s # in milliseconds; 0 disables | ||
max_replication_slots = 4 # max number of replication slots (change requires restart) |