jms ibm mq source JMS - IBM MQ Kamelet Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

A Kamelet that can read events from an IBM MQ message queue using JMS.

In your KameletBinding file you’ll need to explicitly declare the IBM MQ Server driver dependency in spec→integration→dependencies

  • "mvn:com.ibm.mq:com.ibm.mq.allclient:<version>"

Configuration Options

The following table summarizes the configuration options available for the jms-ibm-mq-source Kamelet:

Property Name Description Type Default Example

channel

IBM MQ Channel

Required Name of the IBM MQ Channel.

string

destinationName

Destination Name

Required The destination name.

string

password

Password

Required Password to authenticate to IBM MQ server.

string

queueManager

IBM MQ Queue Manager

Required Name of the IBM MQ Queue Manager.

string

serverName

IBM MQ Server name

Required IBM MQ Server name or address.

string

serverPort

IBM MQ Server Port

Required IBM MQ Server port.

integer

1414

username

Username

Required Username to authenticate to IBM MQ server.

string

clientId

IBM MQ Client ID

Name of the IBM MQ Client ID.

string

destinationType

Destination Type

The JMS destination type (queue or topic).

string

queue

Dependencies

At runtime, the jms-ibm-mq-source Kamelet relies upon the presence of the following dependencies:

  • camel:jms

  • camel:kamelet

Usage

This section describes how you can use the jms-ibm-mq-source.

Knative source

You can use the jms-ibm-mq-source Kamelet as a Knative source by binding it to a Knative object.

jms-ibm-mq-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: jms-ibm-mq-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: jms-ibm-mq-source
    properties:
      channel: The IBM MQ Channel
      destinationName: The Destination Name
      password: The Password
      queueManager: The IBM MQ Queue Manager
      serverName: The IBM MQ Server name
      serverPort: The IBM MQ Server Port
      username: The Username
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the jms-ibm-mq-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f jms-ibm-mq-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind jms-ibm-mq-source -p "source.channel=The IBM MQ Channel" -p "source.destinationName=The Destination Name" -p "source.password=The Password" -p "source.queueManager=The IBM MQ Queue Manager" -p "source.serverName=The IBM MQ Server name" -p "source.serverPort=The IBM MQ Server Port" -p "source.username=The Username" channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

Kafka source

You can use the jms-ibm-mq-source Kamelet as a Kafka source by binding it to a Kafka topic.

jms-ibm-mq-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: jms-ibm-mq-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: jms-ibm-mq-source
    properties:
      channel: The IBM MQ Channel
      destinationName: The Destination Name
      password: The Password
      queueManager: The IBM MQ Queue Manager
      serverName: The IBM MQ Server name
      serverPort: The IBM MQ Server Port
      username: The Username
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the jms-ibm-mq-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f jms-ibm-mq-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind jms-ibm-mq-source -p "source.channel=The IBM MQ Channel" -p "source.destinationName=The Destination Name" -p "source.password=The Password" -p "source.queueManager=The IBM MQ Queue Manager" -p "source.serverName=The IBM MQ Server name" -p "source.serverPort=The IBM MQ Server Port" -p "source.username=The Username" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.