7.6. Debezium PostgreSQL コネクターのデプロイメント

手順

1. Kafka Connect の Debezium PostgreSQL コンテナーを作成します。

   1. Debezium PostgreSQL コネクターアーカイブをダウンロードします。

   2. Debezium PostgreSQL コネクターアーカイブを展開して、コネクタープラグインのディレクトリー構造を作成します。以下に例を示します。

      ./my-plugins/
      ├── debezium-connector-postgresql
      │   ├── ...

   3. registry.redhat.io/amq7/amq-streams-kafka-28-rhel8:1.8.0 をベースイメージとして使用する Docker ファイルを作成します。たとえば、ターミナルウィンドウに以下のコマンドを入力します。my -plugins はプラグインディレクトリーの名前に置き換えます。

      cat <<EOF >debezium-container-for-postgresql.yaml 1
      FROM registry.redhat.io/amq7/amq-streams-kafka-28-rhel8:1.8.0
      USER root:root
      COPY ./<my-plugins>/ /opt/kafka/plugins/ 2
      USER 1001
      EOF

      1

      任意のファイル名を指定できます。

      2

      my-plugins は、プラグインディレクトリーの名前に置き換えます。

      このコマンドは、現在のディレクトリーに debezium-container-for-postgresql.yaml という名前の Docker ファイルを作成します。

   4. 前の手順で作成した debezium-container-for-postgresql.yaml Docker ファイルからコンテナーイメージをビルドします。ファイルを含むディレクトリーから、ターミナルウィンドウを開き、以下のコマンドのいずれかを入力します。

      podman build -t debezium-container-for-postgresql:latest .

      docker build -t debezium-container-for-postgresql:latest .

      build コマンドは、debezium-container-for-postgresql という名前のコンテナーイメージを構築します。

   5. カスタムイメージを quay.io などのコンテナーレジストリーまたは内部コンテナーレジストリーにプッシュします。コンテナーレジストリーは、イメージをデプロイする OpenShift インスタンスで利用できる必要があります。以下のいずれかのコマンドを実行します。

      podman push <myregistry.io>/debezium-container-for-postgresql:latest

      docker push <myregistry.io>/debezium-container-for-postgresql:latest

   6. 新しい Debezium PostgreSQL KafkaConnect カスタムリソース(CR)を作成します。たとえば、以下の例のように アノテーション およびイメージ プロパティーを指定する dbz-connect.yaml という名前の KafkaConnect CR を作成します。

      apiVersion: kafka.strimzi.io/v1beta2
      kind: KafkaConnect
      metadata:
        name: my-connect-cluster
        annotations: strimzi.io/use-connector-resources: "true" 1
      spec:
        image: debezium-container-for-postgresql 2

      1

      metadata.annotations は、KafkaConnectors リソースがこの Kafka Connect クラスターでコネクター を設定するために使用される ことを Cluster Operator に示します。

      2

      spec.image は、Debezium コネクターを実行するために作成したイメージの名前を指定します。このプロパティーは、Cluster Operator の STRIMZI_DEFAULT_KAFKA_CONNECT_IMAGE 変数を上書きします。

   7. 以下のコマンドを実行して、KafkaConnect CR を OpenShift Kafka インスタンスに適用します。

      oc create -f dbz-connect.yaml

      これにより、OpenShift の Kafka Connect 環境が更新され、Debezium コネクターを実行するために作成したイメージの名前を指定する Kafka Connector インスタンスが追加されます。

2. Debezium PostgreSQL コネクターインスタンスを設定する KafkaConnector カスタムリソースを作成します。

   コネクターの設定プロパティーを指定する a .yaml ファイルで Debezium PostgreSQL コネクターを設定します。コネクター設定は、Debezium に対して、スキーマおよびテーブルのサブセットにイベントを生成するよう指示する可能性があり、または機密性の高い、大きすぎる、または不必要な指定のコラムで Debezium が値を無視、マスク、または切り捨てするようにプロパティーを設定する可能性もあります。Debezium PostgreSQL コネクターに設定できる設定プロパティーの完全リストは PostgreSQL コネクタープロパティー を参照してください。

   以下の例では、ポート 5432 で PostgreSQL サーバーホスト 192.168.99.100 に接続する Debezium コネクターを設定します。このホストには sampledb という名前のデータベースがあり、public という名前のスキーマがあり、fulfill ment はサーバーの論理名です。

   fulfillment-connector.yaml

   apiVersion: kafka.strimzi.io/v1beta2
     kind: KafkaConnector
     metadata:
       name: fulfillment-connector  1
       labels:
         strimzi.io/cluster: my-connect-cluster
     spec:
       class: io.debezium.connector.postgresql.PostgresConnector
       tasksMax: 1  2
       config:  3
         database.hostname: 192.168.99.100   4
         database.port: 5432
         database.user: debezium
         database.password: dbz
         database.dbname: sampledb
         database.server.name: fulfillment   5
         schema.include.list: public   6
         plugin.name: pgoutput    7

   1

   コネクターの名前。

   2

   1 度に 1 つのタスクのみが動作する必要があります。PostgreSQL コネクターは PostgreSQL サーバーの binlog を読み取るため、単一のコネクタータスクを使用することで、順序とイベントの処理が適切に行われるようになります。Kafka Connect サービスはコネクターを使用して作業を行う 1 つ以上のタスクを開始し、実行中のタスクを自動的に Kafka Connect サービスのクラスター全体に分散します。いずれかのサービスが停止またはクラッシュすると、これらのタスクは稼働中のサービスに再分散されます。

   3

   コネクターの設定。

   4

   PostgreSQL サーバーを実行しているデータベースホストの名前。以下の例では、データベースのホスト名は 192.168.99.100 です。

   5

   一意のサーバー名。サーバー名は、PostgreSQL サーバーまたはサーバーのクラスターの論理識別子です。この名前は、変更イベントレコードを受信するすべての Kafka トピックのプレフィックスとして使用されます。

   6

   コネクターは パブリック スキーマでのみ変更をキャプチャーします。選択したテーブルでのみ変更をキャプチャーするようにコネクターを設定できます。table.include.list コネクター設定プロパティーを参照してください。

   7

   PostgreSQL サーバーにインストールされている PostgreSQL 論理デコードプラグイン の名前。PostgreSQL 10 以降でサポートされる値は pgoutput のみですが、plugin.name を pgoutput に明示的に設定する必要があります。

3. Kafka Connect でコネクターインスタンスを作成します。たとえば、KafkaConnector リソースを fulfill ment-connector.yaml ファイルに保存した場合、以下のコマンドを実行します。

   oc apply -f fulfillment-connector.yaml

   このレジスター meetment-connector と コネクターは KafkaConnector CR に定義されている sampledb データベースに対して実行を開始します。

4. コネクターが作成され、起動されたことを確認します。

   1. Kafka Connect ログ出力を表示して、コネクターが作成され、指定データベースの変更のキャプチャーが開始されたことを確認します。

      oc logs $(oc get pods -o name -l strimzi.io/cluster=my-connect-cluster)

   2. ログの出力を確認し、Debezium が初回のスナップショットを実行することを確認します。ログには、以下のメッセージと同様の出力が表示されます。

      ... INFO Starting snapshot for ...
      ... INFO Snapshot is using user 'debezium' ...

      コネクターがエラーがなく正常に起動すると、コネクターが変更をキャプチャーする各テーブルのトピックが作成されます。CR のサンプルでは、パブリック スキーマの各テーブルにトピックがあります。ダウンストリームアプリケーションは、これらのトピックをサブスクライブできます。

   3. 以下のコマンドを実行して、コネクターによってトピックが作成されたことを検証します。

      oc get kafkatopics