couchbase sink Couchbase Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Send documents to Couchbase.

Configuration Options

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

Property Name Description Type Default Example

bucket

Bucket

Required The bucket to use.

string

couchbaseHostname

Hostname

Required The hostname to use.

string

protocol

Protocol

Required The protocol to use.

string

autoStartId

Auto Start Id

Auto Start Id or not.

boolean

true

couchbasePort

Port

The port to use.

integer

8091

password

Password

Password to connect to Couchbase.

string

startingId

Starting Id

The starting id.

integer

1

username

Username

Username to connect to Couchbase.

string

Dependencies

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

  • camel:couchbase

  • camel:kamelet

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 couchbase-sink.

Knative sink

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

couchbase-sink-binding.yaml
apiVersion: camel.apache.org/v1
kind: KameletBinding
metadata:
  name: couchbase-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: couchbase-sink
    properties:
      bucket: The Bucket
      couchbaseHostname: The Hostname
      protocol: The Protocol

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the couchbase-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 couchbase-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind channel:mychannel -p "sink.bucket=The Bucket" -p "sink.couchbaseHostname=The Hostname" -p "sink.protocol=The Protocol" couchbase-sink

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

Kafka sink

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

couchbase-sink-binding.yaml
apiVersion: camel.apache.org/v1
kind: KameletBinding
metadata:
  name: couchbase-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: couchbase-sink
    properties:
      bucket: The Bucket
      couchbaseHostname: The Hostname
      protocol: The Protocol

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 couchbase-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 couchbase-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "sink.bucket=The Bucket" -p "sink.couchbaseHostname=The Hostname" -p "sink.protocol=The Protocol" couchbase-sink

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

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/couchbase-sink.kamelet.yaml

Back to top