opensearch index sink OpenSearch Index Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Stores JSON-formatted data into Opensearch.

The input data must be formatted in JSON according to the requirements of the index.

If you specify the certificate property, you must base64 encode it before you pass it as a parameter.

In the header, you can set the following properties:

  • indexId / ce-indexid: The index ID for OpenSearch.

  • indexName / ce-indexname: The index name for OpenSearch.

If you do not set a property in the header, the Kamelet uses the exchange ID for the index setting.

Configuration Options

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

Property Name Description Type Default Example

clusterName

OpenSearch Cluster Name

Required The name of the OpenSearch cluster.

string

quickstart

hostAddresses

Host Addresses

Required A comma-separated list of remote transport addresses in ip:port format.

string

quickstart-es-http:9200

certificate

Certificate

The Certificate for accessing the OpenSearch cluster. You must encode this value in base64.

string

enableSSL

Enable SSL

Specifies to connect by using SSL.

boolean

false

indexName

Index in OpenSearch

The name of the OpenSearch index.

string

data

password

Password

The password to connect to OpenSearch.

string

user

Username

The username to connect to OpenSearch.

string

Dependencies

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

  • camel:core

  • camel:jackson

  • camel:kamelet

  • camel:opensearch

  • camel:gson

  • camel:bean

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 opensearch-index-sink.

Knative sink

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

opensearch-index-sink-binding.yaml
apiVersion: camel.apache.org/v1
kind: KameletBinding
metadata:
  name: opensearch-index-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: opensearch-index-sink
    properties:
      clusterName: quickstart
      hostAddresses: quickstart-es-http:9200

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the opensearch-index-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 opensearch-index-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.clusterName=quickstart" -p "sink.hostAddresses=quickstart-es-http:9200" opensearch-index-sink

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

Kafka sink

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

opensearch-index-sink-binding.yaml
apiVersion: camel.apache.org/v1
kind: KameletBinding
metadata:
  name: opensearch-index-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: opensearch-index-sink
    properties:
      clusterName: quickstart
      hostAddresses: quickstart-es-http:9200

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 opensearch-index-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 opensearch-index-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.clusterName=quickstart" -p "sink.hostAddresses=quickstart-es-http:9200" opensearch-index-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/opensearch-index-sink.kamelet.yaml

Back to top