opensearch search source OpenSearch Search Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Search data on OpenSearch

The query parameter must be formatted in JSON.

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

Configuration Options

The following table summarizes the configuration options available for the opensearch-search-source Kamelet:

Property Name Description Type Default Example

clusterName

OpenSearch Cluster Name

Required The name of the cluster.

string

hostAddresses

Host Addresses

Required Comma separated list with ip:port formatted remote transport addresses to use.

string

indexName

Index in OpenSearch

Required The name of the index to act against.

string

query

Query

Required The query we want to use to search on OpenSearch.

string

certificate

Certificate

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

string

enableSSL

Enable SSL

Do we want to connect using SSL?.

boolean

false

password

Password

Password to connect to OpenSearch.

string

period

Period

The time interval between two searches.

integer

1000

user

Username

Username to connect to OpenSearch.

string

Dependencies

At runtime, the opensearch-search-source Kamelet relies upon the presence of the following dependencies:

  • camel:core

  • camel:kamelet

  • camel:timer

  • camel:opensearch

  • camel:gson

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-search-source.

Knative source

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

opensearch-search-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: opensearch-search-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: opensearch-search-source
    properties:
      clusterName: The OpenSearch Cluster Name
      hostAddresses: The Host Addresses
      indexName: The Index in OpenSearch
      query: The Query
  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 opensearch-search-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 opensearch-search-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.clusterName=The OpenSearch Cluster Name" -p "source.hostAddresses=The Host Addresses" -p "source.indexName=The Index in OpenSearch" -p "source.query=The Query" opensearch-search-source

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

Kafka source

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

opensearch-search-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: opensearch-search-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: opensearch-search-source
    properties:
      clusterName: The OpenSearch Cluster Name
      hostAddresses: The Host Addresses
      indexName: The Index in OpenSearch
      query: The Query
  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 opensearch-search-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 opensearch-search-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.clusterName=The OpenSearch Cluster Name" -p "source.hostAddresses=The Host Addresses" -p "source.indexName=The Index in OpenSearch" -p "source.query=The Query" opensearch-search-source

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

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/opensearch-search-source.kamelet.yaml

Back to top