Installing Adapter for Apache Kafka

About this task

Note: If you are installing Adapter for Apache Kafka in a clustered environment, you must install the adapter on each Integration Server in the cluster, and each installation must be identical. For more information about working with Adapter for Apache Kafka in a clustered environment, see Adapter for Apache Kafka in a Clustered Environment

To install Adapter for Apache Kafka

Procedure

  1. Download Installer.
  2. If you are installing the adapter on an existing Integration Server, shut down the Integration Server.
  3. Start the Installer wizard.
  4. Select the webMethods release that includes the Integration Server on which you want to install the adapter. For example, if you want to install the adapter on Integration Server 9.6, select the 9.6 release.
  5. Specify the installation directory as follows:
    • If you are installing on an existing Integration Server, specify the webMethods installation directory that contains the host Integration Server.
    • If you are installing on an existing Integration Server and the adapter, specify the installation directory to use.
  6. In the product selection list, select Adapters > webMethods Adapter 9.6 for Apache Kafka.
    If you are Integration Server using 9.6 and later, you can install the package in the default instance. In this case, IBM webMethods Installer installs the adapter in both locations, Integration Server_directory \packages and the default instance packages directory located in Integration Server_directory \instances\default\packages.
  7. After the installation completes, close the Installer.
  8. Copy the following libraries from your installation of the Apache Kafka or Confluent Kafka's lib folder to Integration Server_directory \instances\instance_name\packages\WmKafkaAdapter\code\jars folder.
    • JAR names and samples for Apache Kafka:
      • zkclient-<<X.XX.XXX>>.jar (zkclient-0.10.jar required for Apache Kafka 2.12-2.3.1 or lower versions)
      • kafka-tools-<<X.XX.XXX>>.jar (kafka-tools-2.0.0.jar)
      • kafka-clients-<<X.XX.XXX>>.jar (kafka-clients-2.0.0.jar)
      • kafka_<<X.XX.XXX>>.jar (kafka_2.12-2.0.0.jar )
    • JAR names and samples for Confluent Kafka:
      • avro-<<X.XX.XXX>>.jar (avro-1.10.1.jar)
      • common-config-<<X.XX.XXX>>.jar (common-config-6.2.0.jar)
      • common-utils-<<X.XX.XXX>>.jar (common-utils-6.2.0.jar)
      • jakarta.ws.rs-api-<<X.XX.XXX>>.jar (jakarta.ws.rs-api-2.1.6.jar)
      • jersey-client-<<X.XX.XXX>>.jar (jersey-client-2.30.jar)
      • jersey-common-<<X.XX.XXX>>.jar (jersey-common-2.30.jar)
      • kafka_<<X.XX.XXX>>-ccs.jar (kafka_2.13-6.2.0-ccs.jar)
      • kafka-avro-serializer-<<X.XX.XXX>>.jar (kafka-avro-serializer-6.2.0.jar)
      • kafka-clients-<<X.XX.XXX>>-ccs.jar (kafka-clients-6.2.0-ccs.jar)
      • kafka-schema-registry-client-<<X.XX.XXX>>.jar (kafka-schema-registry-client-6.2.0.jar)
      • kafka-schema-serializer-<<X.XX.XXX>>.jar (kafka-schema-serializer-6.2.0.jar)
      • kafka-tools-<<X.XX.XXX>>-ccs.jar (kafka-tools-6.2.0-ccs.jar)
      • wm-kafka-v<<X.XX.XXX>>.jar (wm-kafka-v9.jar)
      • zookeeper-<<X.XX.XXX>>.jar (zookeeper-3.5.9.jar)
    Note: You can use the JAR files with versions specified or higher.
  9. If the Kafka broker is configured to use zstd compression or if zstd is required at the adapter level, you must include the following JAR files in the Integration Server_directory \instances\instance_name\packages\WmKafkaAdapter\code\jars folder.
    • JAR names and samples.
      • lz4-java-<<X.XX.XXX>>.jar (lz4-java-1.8.0.jar)
      • zstd-jni-<<X.XX.XXX>>.jar (zstd-jni-1.5.5-6. jar)
    Note: You can use the JAR files with versions specified or higher.
  10. Start the host Integration Server.