You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-3Lines changed: 18 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,19 @@ kafka-connect-mq-source is a [Kafka Connect](http://kafka.apache.org/documentati
3
3
4
4
The connector is supplied as source code which you can easily build into a JAR file.
5
5
6
+
## Contents
7
+
8
+
-[Building the connector](#building-the-connector)
9
+
-[Running the connector](#running-the-connector)
10
+
-[Data formats](#data-formats)
11
+
-[Security](#security)
12
+
-[Performance and syncpoint limit](#performance-and-syncpoint-limit)
13
+
-[Configuration](#configuration)
14
+
-[Troubleshooting](#troubleshooting)
15
+
-[Support](#support)
16
+
-[Issues and contributions](#issues-and-contributions)
17
+
-[License](#license)
18
+
6
19
7
20
## Building the connector
8
21
To build the connector, you must have the following installed:
@@ -29,6 +42,9 @@ Once built, the output is a single JAR called `target/kafka-connect-mq-source-1.
29
42
30
43
31
44
## Running the connector
45
+
46
+
**NOTE:** For a more detailed guide to running the connector see the [IBM Event Streams documentation](https://ibm.github.io/event-streams/connecting/mq/).
47
+
32
48
To run the connector, you must have:
33
49
* The JAR from building the connector
34
50
* A properties file containing the configuration for the connector
@@ -39,15 +55,14 @@ The connector can be run in a Kafka Connect worker in either standalone (single
39
55
40
56
You need two configuration files, one for the configuration that applies to all of the connectors such as the Kafka bootstrap servers, and another for the configuration specific to the MQ source connector such as the connection information for your queue manager. For the former, the Kafka distribution includes a file called `connect-standalone.properties` that you can use as a starting point. For the latter, you can use `config/mq-source.properties` in this repository.
41
57
42
-
The connector connects to MQ using a client connection. You must provide the name of the queue manager, the connection name (one or more host/port pairs) and the channel name. In addition, you can provide a user name and password if the queue manager is configured to require them for client connections. If you look at the supplied `config/mq-sink.properties`, you'll see how to specify the configuration required.
58
+
The connector connects to MQ using a client connection. You must provide the name of the queue manager, the connection name (one or more host/port pairs) and the channel name. In addition, you can provide a user name and password if the queue manager is configured to require them for client connections. If you look at the supplied `config/mq-source.properties`, you'll see how to specify the configuration required.
43
59
44
60
To run the connector in standalone mode from the directory into which you installed Apache Kafka, you use a command like this:
Kafka Connect is very flexible but it's important to understand the way that it processes messages to end up with a reliable system. When the connector encounters a message that it cannot process, it stops rather than throwing the message away. Therefore, you need to make sure that the configuration you use can handle the messages the connector will process.
53
68
@@ -132,7 +147,7 @@ You will need to put the public part of the queue manager's certificate in the J
132
147
### Setting up MQ connectivity using TLS for mutual authentication
133
148
You will need to put the public part of the client's certificate in the queue manager's key repository. You will also need to configure the worker's JVM with the location and password for the keystore containing the client's certificate.
134
149
135
-
### Troubleshooting
150
+
### Security troubleshooting
136
151
For troubleshooting, or to better understand the handshake performed by the IBM MQ Java client application in combination with your specific JSSE provider, you can enable debugging by setting `javax.net.debug=ssl` in the JVM environment.
0 commit comments