mongodb sink MongoDB Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Send data to MongoDB.

This Kamelet expects a JSON-formatted body.

In the header, you can set the db-upsert / ce-dbupsert property, a boolean value that specifies whether the database should create an element if it does not exist.

Configuration Options

The following table summarizes the configuration options available for the mongodb-sink Kamelet:

Property Name Description Type Default Example

collection

MongoDB Collection

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

string

database

MongoDB Database

Required The name of the MongoDB database.

string

hosts

MongoDB Hosts

Required A comma-separated list of MongoDB host addresses in host:port format.

string

createCollection

Collection

Create a collection during initialization if it doesn’t exist.

boolean

false

password

MongoDB Password

A 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

username

MongoDB Username

A username for accessing MongoDB.

string

writeConcern

Write Concern

The level of acknowledgment requested from MongoDB for write operations. Possible values are ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED, or MAJORITY.

string

Dependencies

At runtime, the mongodb-sink Kamelet relies upon the presence of the following dependencies:

  • camel:core

  • camel:kamelet

  • camel:mongodb

  • camel:jackson

Usage

This section describes how you can use the mongodb-sink.

Knative sink

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

mongodb-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: mongodb-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: mongodb-sink
    properties:
      collection: The MongoDB Collection
      database: The MongoDB Database
      hosts: The MongoDB Hosts

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the mongodb-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f mongodb-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

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

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

Kafka sink

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

mongodb-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: mongodb-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: mongodb-sink
    properties:
      collection: The MongoDB Collection
      database: The MongoDB Database
      hosts: The MongoDB Hosts

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-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f mongodb-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

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

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