mongodb changes stream source MongoDB Changes Stream Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Consume Changes from MongoDB Collection in streaming mode.

Configuration Options

The following table summarizes the configuration options available for the mongodb-changes-stream-source Kamelet:

Property Name Description Type Default Example

collection

MongoDB Collection

Required Sets the name of the MongoDB collection to bind to this endpoint.

string

database

MongoDB Database

Required Sets the name of the MongoDB database to target.

string

hosts

MongoDB Hosts

Required Comma separated list of MongoDB Host Addresses in host:port format.

string

password

MongoDB Password

User password for accessing MongoDB.

string

ssl

Enable Ssl for Mongodb Connection

whether to enable ssl connection to mongodb.

boolean

true

sslValidationEnabled

Enables Ssl Certificates Validation and Host name checks.

IMPORTANT this should be disabled only in test environment since can pose security issues.

boolean

true

streamFilter

Stream Filter

Filter condition for change streams consumer.

string

{ '$match':{'$or':[{'fullDocument.stringValue': 'specificValue'}]} }

username

MongoDB Username

Username for accessing MongoDB. The username must be present in the MongoDB’s authentication database (authenticationDatabase). By default, the MongoDB authenticationDatabase is 'admin'.

string

Dependencies

At runtime, the mongodb-changes-stream-source Kamelet relies upon the presence of the following dependencies:

  • camel:kamelet

  • camel:mongodb

  • camel:jackson

  • mvn:org.apache.camel.kamelets:camel-kamelets-utils:4.6.0-SNAPSHOT

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the mongodb-changes-stream-source.

Knative source

You can use the mongodb-changes-stream-source Kamelet as a Knative source by binding it to a Knative object.

mongodb-changes-stream-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: mongodb-changes-stream-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: mongodb-changes-stream-source
    properties:
      collection: The MongoDB Collection
      database: The MongoDB Database
      hosts: The MongoDB Hosts
  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 mongodb-changes-stream-source-pipe.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 mongodb-changes-stream-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind channel:mychannel -p "source.collection=The MongoDB Collection" -p "source.database=The MongoDB Database" -p "source.hosts=The MongoDB Hosts" mongodb-changes-stream-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka source

You can use the mongodb-changes-stream-source Kamelet as a Kafka source by binding it to a Kafka topic.

mongodb-changes-stream-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: mongodb-changes-stream-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: mongodb-changes-stream-source
    properties:
      collection: The MongoDB Collection
      database: The MongoDB Database
      hosts: The MongoDB Hosts
  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 mongodb-changes-stream-source-pipe.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 mongodb-changes-stream-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "source.collection=The MongoDB Collection" -p "source.database=The MongoDB Database" -p "source.hosts=The MongoDB Hosts" mongodb-changes-stream-source

This command creates the Kamelet Pipe in the current namespace on the cluster.