1. Home
  2. Cloud
  3. Confluent Cloud への外部システムの接続

重要

このページの日本語コンテンツは古くなっている可能性があります。最新の英語版コンテンツをご覧になるには、こちらをクリックしてください。

IBM MQ Source Connector for Confluent Cloud

注釈

Confluent Platform 用にコネクターをローカルにインストールする場合は、「IBM MQ Source Connector for Confluent Platform」を参照してください。

フルマネージド型の Kafka Connect IBM MQ Source Connector は、IBM MQ クラスターからメッセージを読み取り、Apache Kafka® トピックに書き込みます。

機能

IBM MQ Source Connector には、以下の機能があります。

  • 少なくとも 1 回のデリバリー: レコードが Kafka のトピックに少なくとも 1 回は配信されることが保証されます。
  • 複数のタスク: このコネクターは複数のタスクをサポートしています。タスクが多いほどパフォーマンスが向上する可能性があります。
  • JMS メッセージタイプ: このコネクターは、TextMessage および BytesMessage をサポートしています。ObjectMessage と StreamMesssage は、サポートされていません。

Confluent Cloud API for Connect の詳細と使用例については、「Confluent Cloud API for Connect」セクションを参照してください。

制限

以下の情報を確認してください。

エラーと再試行

IBM MQ Source Connector では、ほとんどの Kafka Connect コネクターに実装されている一般的な再試行ポリシーが使用されます。さらに IBM MQ Source Connector では、各再試行の後で指数関数的バックオフが使用されます。バックオフ時間は再試行の間隔であり、0 から、指数関数的に増加する値までのランダムな値です。この指数関数的な値の上限は 1 分です。初期バックオフ時間は 100 ミリ秒に設定されています。

initialbackoffTime * 2 ^ (retry-1)

以下のエラーが発生すると、再試行がトリガーされます。MQRC_GET_INHIBITED を除き、以下のいずれかのエラーが発生すると、まず接続が切断され、再試行の前に再接続されます。

  • MQRC_GET_INHIBITED
  • MQRC_BACKED_OUT
  • MQRC_CHANNEL_NOT_AVAILABLE
  • MQRC_CONNECTION_BROKEN
  • MQRC_HOST_NOT_AVAILABLE
  • MQRC_NOT_AUTHORIZED
  • MQRC_Q_MGR_NOT_AVAILABLE
  • MQRC_Q_MGR_QUIESCING
  • MQRC_Q_MGR_STOPPING
  • MQRC_UNEXPECTED_ERROR

クイックスタート

このクイックスタートを使用して、Confluent Cloud IBM MQ Source Connector の利用を開始することができます。クイックスタートでは、コネクターを IBM MQ ブローカーに接続し、指定されたキューまたはトピックをサブスクライブして、データを Apache Kafka® にストリーミングする方法を示します。

前提条件
  • アマゾンウェブサービス （ AWS ）、Microsoft Azure （ Azure ）、または Google Cloud Platform （ GCP ）上の Confluent Cloud クラスターへのアクセスを許可されていること。
  • IBM MQ ブローカーへのアクセス。
  • Confluent CLI がインストールされ、クラスター用に構成されていること。「Confluent CLI のインストール」を参照してください。
  • スキーマレジストリ ベースのフォーマット（Avro、JSON_SR（JSON スキーマ）、Protobuf など）を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「スキーマレジストリ Enabled Environments」を参照してください。
  • ネットワークに関する考慮事項については、「Networking and DNS Considerations」を参照してください。静的なエグレス IP を使用する方法については、「静的なエグレス IP アドレス」を参照してください。
  • Kafka クラスターの認証情報。次のいずれかの方法で認証情報を指定できます。
    • 既存の サービスアカウント のリソース ID を入力する。
    • コネクター用の Confluent Cloud サービスアカウント を作成する。サービスアカウントのドキュメント で、必要な ACL エントリを確認してください。一部のコネクターには固有の ACL 要件があります。
    • Confluent Cloud の API キーとシークレットを作成する。キーとシークレットを作成するには、confluent api-key create を使用するか、コネクターのセットアップ時に Cloud Console で直接 API キーとシークレットを自動生成します。

Confluent Cloud Console の使用

ステップ 1: Confluent Cloud クラスターを起動します。

インストール手順については、「Quick Start for Confluent Cloud」を参照してください。

ステップ 2: コネクターを追加します。

左のナビゲーションメニューの Data integration をクリックし、Connectors をクリックします。クラスター内に既にコネクターがある場合は、+ Add connector をクリックします。

ステップ 3: コネクターを選択します。

Click the IBM MQ Source connector card.

IBM MQ Source Connector Card

Step 4: Enter the connector details.

注釈

  • すべての 前提条件 を満たしていることを確認してください。
  • アスタリスク（ * ）は必須項目であることを示しています。

At the Add IBM MQ Source Connector screen, complete the following:

Select the topic you want to send data to from the Topics list. To create a new topic, click +Add new topic.

Step 5: Check the Kafka topic.

コネクターが実行中になったら、メッセージが Kafka トピックに取り込まれていることを確認します。

Confluent Cloud API for Connect の詳細と使用例については、「Confluent Cloud API for Connect」セクションを参照してください。

参考

フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。

../_images/topology.ja.png

Confluent CLI の使用

以下の手順に従うと、Confluent CLI を使用してコネクターをセットアップし、実行できます。

注釈

ステップ 1: 使用可能なコネクターをリスト表示します。

以下のコマンドを入力して、使用可能なコネクターをリスト表示します。

confluent connect plugin list

ステップ 2: コネクターの必須の構成プロパティを表示します。

以下のコマンドを実行して、コネクターの必須プロパティを表示します。

confluent connect plugin describe <connector-catalog-name>

例:

confluent connect plugin describe IbmMQSource

出力例:

The following are required configs:
connector.class : IbmMQSource
name
kafka.api.key
kafka.api.secret
kafka.topic
output.data.format
jms.destination.name
mq.username
mq.hostname
mq.queue.manager
tasks.max

ステップ 3: コネクターの構成ファイルを作成します。

コネクター構成プロパティを含む JSON ファイルを作成します。以下の例は、コネクターの必須プロパティを示しています。

{
  "connector.class": " IbmMQSource",
  "name": "IbmMQSource",
  "kafka.auth.mode": "KAFKA_API_KEY",
  "kafka.api.key": "<my-kafka-api-key>",
  "kafka.api.secret": "<my-kafka-api-secret>",
  "kafka.topic" : "data_topic_0",
  "output.data.format": "AVRO",
  "jms.destination.name": "<destination-name>",
  "mq.username": "<authorized-user>",
  "mq.password": "<user-password>"
  "mq.hostname": "<server-hostname>",
  "mq.queue.manager": <queue-name>",
  "tasks.max" : "1"
}

以下のプロパティ定義に注意してください。

  • "name": 新しいコネクターの名前を設定します。
  • "connector.class": コネクターのプラグイン名を指定します。

  • "kafka.auth.mode": 使用するコネクターの認証モードを指定します。オプションは SERVICE_ACCOUNT または KAFKA_API_KEY （デフォルト）です。API キーとシークレットを使用するには、構成プロパティ kafka.api.key と kafka.api.secret を構成例（前述）のように指定します。サービスアカウント を使用するには、プロパティ kafka.service.account.id=<service-account-resource-ID> に リソース ID を指定します。使用できるサービスアカウントのリソース ID のリストを表示するには、次のコマンドを使用します。

    confluent iam service-account list

    例:

    confluent iam service-account list

   Id     | Resource ID |       Name        |    Description
+---------+-------------+-------------------+-------------------
   123456 | sa-l1r23m   | sa-1              | Service account 1
   789101 | sa-l4d56p   | sa-2              | Service account 2

  • "kafka.topic": データの送信先とする Kafka トピックの名前（複数の場合は、コンマ区切りのトピック名）。

  • "output.data.format": AVRO、JSON、JSON_SR、PROTOBUF がサポートされます。スキーマレジストリ ベースのフォーマットを使用するには、Schema Registry を有効にしておく必要があります。

  • "jms.destination.name": 読み取り元の JMS 送信先（queue または topic）の名前。

  • "mq.username": ブローカーホストの許可されたユーザー。追加の接続セキュリティを使用しない場合は、mq.password が必要です。

  • "mq.queue.manager": IBM MQ キューマネージャー。

  • "tasks.max": このコネクターで使用する タスク の数を入力します。このコネクターは複数のタスクに対応しています。タスクが多いほどパフォーマンスが向上する可能性があります。

Single Message Transforms: SMT 追加の詳細については、Single Message Transforms（SMT） のドキュメントを参照してください。このコネクターでサポートされていない SMT のリストについては、「サポートされない変換」を参照してください。

すべてのプロパティの値と定義については、「構成プロパティ」を参照してください。

ステップ 4: プロパティファイルを読み込み、コネクターを作成します。

以下のコマンドを入力して、構成を読み込み、コネクターを起動します。

confluent connect create --config <file-name>.json

例:

confluent connect create --config ibmmq-source.json

出力例:

Created connector  IbmMQSource_0 lcc-ix4dl

ステップ 5: コネクターのステータスを確認します。

以下のコマンドを入力して、コネクターのステータスを確認します。

confluent connect plugin list

出力例:

ID          |    Name           | Status  |  Type
+-----------+-------------------+---------+-------+
lcc-ix4dl   |  IbmMQSource_0    | RUNNING | source

ステップ 6: ブローカーで結果を確認します。

コネクターが実行中になったら、メッセージが Kafka トピックに取り込まれていることを確認します。

Confluent Cloud API for Connect の詳細と使用例については、「Confluent Cloud API for Connect」セクションを参照してください。

構成プロパティ

このコネクターでは、以下のコネクター構成プロパティを使用します。

データへの接続方法（How should we connect to your data?）

name

コネクターの名前を設定します。

  • 型: string
  • 指定可能な値: 最大 64 文字の文字列
  • 重要度: 高

Kafka クラスターの認証情報（Kafka Cluster credentials）

kafka.auth.mode

Kafka の認証モード。KAFKA_API_KEY または SERVICE_ACCOUNT を指定できます。デフォルトは KAFKA_API_KEY モードです。

  • 型: string
  • デフォルト: KAFKA_API_KEY
  • 指定可能な値: KAFKA_API_KEY、SERVICE_ACCOUNT
  • 重要度: 高
kafka.api.key
  • 型: password
  • 重要度: 高
kafka.service.account.id

Kafka クラスターとの通信用の API キーを生成するために使用されるサービスアカウント。

  • 型: string
  • 重要度: 高
kafka.api.secret
  • 型: password
  • 重要度: 高

データの送信先トピック（Which topic do you want to send data to?）

kafka.topic

データの書き込み先トピック名を指定します。

  • 型: string
  • 重要度: 高

出力メッセージ（Output messages）

output.data.format

Kafka 出力レコード値のフォーマットを設定します。指定可能なエントリは、AVRO、JSON_SR、PROTOBUF、または JSON です。スキーマベースのメッセージフォーマット（AVRO、JSON_SR、PROTOBUF など）を使用する場合は、Confluent Cloud Schema Registry を構成しておく必要がある点に注意してください

  • 型: string
  • 重要度: 高

IBM MQ へのセキュアな接続（IBM MQ Secure Connection）

mq.tls.protocol

IBM MQ へのセキュアな接続の TLS プロトコルバージョン。デフォルトは TLSv1.2 で、ほとんどのケースに適していますが、実際に使用できる値は JVM によって異なります。最新の JVM では、TLSv1.3、TLSv1.2、TLSv1.1、および TLS がサポートされています。古い JVM では SSL、SSLv2、および SSLv3 がサポートされている場合もありますが、セキュリティに関する既知の脆弱性があるため、これらのバージョンは無効になっています。

  • 型: string
  • デフォルト: TLSv1.2
  • 重要度: 中
mq.tls.keystore.type

キーストアファイルのファイルフォーマット。これは、IBM MQ とのセキュアな TLS 通信を使用する場合にのみ必要です。MQ on Cloud キューマネージャーのバージョン 9.2.1 リビジョン 2 以降では、TLS がデフォルトで有効になります。

  • 型: string
  • デフォルト: JKS
  • 重要度: 中
mq.tls.keystore.location

キーストアファイル。これは、IBM MQ とのセキュアな TLS 通信を使用する場合にのみ必要です。

  • 型: password
  • 重要度: 高
mq.tls.keystore.password

キーストアファイルのストアパスワード。クライアントでは省略可能です。TLS Keystore file を構成した場合にのみ必要です。

  • 型: password
  • 重要度: 高
mq.tls.key.password

IBM MQ とのセキュアな TLS 通信に使用されるプライベートキーのパスワード。

  • 型: password
  • 重要度: 高
mq.tls.truststore.type

トラストストアファイルのファイルフォーマットです。これは、IBM MQ との TLS 通信およびセキュアな通信を使用する場合にのみ必要です。

  • 型: string
  • デフォルト: JKS
  • 重要度: 中
mq.tls.truststore.location

トラストストアファイル。これは、IBM MQ とのセキュアな TLS 通信を使用する場合にのみ必要です。

  • 型: password
  • 重要度: 高
mq.tls.truststore.password

トラストストアファイルのパスワード。パスワードが設定されていなくてもトラストストアにアクセスできますが、整合性チェックが無効になります。これは、IBM MQ とのセキュアな TLS 通信を使用する場合にのみ必要です。

  • 型: password
  • 重要度: 高
mq.tls.keymanager.algorithm

SSL 接続のキーマネージャーファクトリで使用されるアルゴリズム。デフォルト値は、Java 仮想マシンに構成されているキーマネージャーファクトリアルゴリズムです。これは、IBM MQ とのセキュアな TLS 通信を使用する場合にのみ必要です。

  • 型: string
  • デフォルト: SunX509
  • 重要度: 低
mq.tls.trustmanager.algorithm

SSL 接続のトラストマネージャーファクトリで使用されるアルゴリズム。デフォルト値は、Java 仮想マシン用に構成されているトラストマネージャーファクトリアルゴリズムです。これは、IBM MQ とのセキュアな TLS 通信を使用する場合にのみ必要です。

  • 型: string
  • デフォルト: PKIX
  • 重要度: 低
mq.tls.secure.random.implementation

SSL 暗号化操作に使用する SecureRandom PRNG 実装。デフォルトでは、まず PKCS11 実装を試みます。PKCS11 がサポートされていない場合は、プロバイダーを反復処理し、動作している最初の実装を返します。これは、IBM MQ とのセキュアな TLS 通信を使用する場合にのみ必要です。

  • 型: string
  • 重要度: 低

IBM MQ セッション（IBM MQ Session）

jms.destination.name

読み取り元である JMS 送信先（キューまたはトピック）の名前です。

  • 型: string
  • 重要度: 高
jms.destination.type

JMS 送信先のタイプであり、queue または topic のいずれかです。

  • 型: string
  • デフォルト: queue
  • 重要度: 高
max.poll.duration

各タスクでバッチのビルドにかけることができる最長時間。割り当てられた時間内に十分な数のメッセージが読み取られなかった場合、バッチは閉じられ、Kafka に送信されます。これにより、JMS キュー/トピックのスループットが低い場合に、コネクターのラグを制限できます。

  • 型: int
  • 重要度: 低
character.encoding

メッセージの受信時に使用する文字エンコーディング。

  • 型: string
  • デフォルト: UTF-8
  • 重要度: 低
jms.subscription.durable

JMS トピックへのコネクタータスクのサブスクリプションを永続的にするかどうかを指定します。永続サブスクリプションにするためには、jms.subscription.name でサブスクリプション名が設定されている必要があります。

  • 型: boolean
  • 重要度: 中
jms.subscription.name

JMS サブスクリプションの名前。永続サブスクリプション（jms.subscription.durable = true）でのみサポートされ、対象となるのは JMS トピックのみです。

  • 型: string
  • 重要度: 中
jms.message.selector

送信先のメッセージに適用する必要がある JMS メッセージセレクター。

  • 型: string
  • 重要度: 高

IBM MQ 接続（IBM MQ Connection）

mq.username

IBM MQ に接続する際に使用するユーザー名。

  • 型: string
  • 重要度: 高
mq.password

IBM MQ に接続する際に使用するパスワード。

  • 型: password
  • 重要度: 高
mq.hostname

IBM MQ ブローカーホスト。

  • 型: string
  • 重要度: 高
mq.port

IBM MQ ブローカーポート。

  • 型: int
  • デフォルト: 1414
  • 重要度: 高
mq.queue.manager

キューマネージャーの名前。

  • 型: string
  • 重要度: 高
mq.channel

クライアント接続のチャネル。

  • 型: string
  • デフォルト: ""
  • 重要度: 高
mq.ssl.cipher.suite

SSL 接続の CipherSuite。

  • 型: string
  • デフォルト: ""
  • 重要度: 高
mq.ssl.fips.required

SSL FIPS が必要かどうかを指定します。

  • 型: boolean
  • 重要度: 高
mq.ssl.peer.name

識別名（DN）のパターンを設定します。sslCipherSuite が設定されている場合、このパターンにより、正しいキューマネージャーが確実に使用されます。キューマネージャーにより提供される識別名がこのパターンに一致しない場合、接続試行は失敗します。

  • 型: string
  • デフォルト: ""
  • 重要度: 高

このコネクターのタスク数（Number of tasks for this connector）

tasks.max
  • 型: int
  • 指定可能な値: [1,...]
  • 重要度: 高

次のステップ

参考

フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。

../_images/topology.ja.png