elasticsearch search source ElasticSearch Index Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Search data on ElasticSearch

Configuration Options

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

Property Name Description Type Default Example

clusterName

ElasticSearch Cluster Name

Required 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 ElasticSearch

Required The name of the index to act against.

string

query

Query

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

string

enableSSL

Enable SSL

Do we want to connect using SSL?.

boolean

true

password

Password

Password to connect to ElasticSearch.

string

period

Period

The time interval between two searches.

integer

1000

user

Username

Username to connect to ElasticSearch.

string

Dependencies

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

  • camel:core

  • camel:kamelet

  • camel:timer

  • mvn:org.apache.camel.k:camel-k-kamelet-reify

  • camel:elasticsearch-rest

  • camel:gson

Usage

This section describes how you can use the elasticsearch-search-source.

Knative source

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

elasticsearch-search-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: elasticsearch-search-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: elasticsearch-search-source
    properties:
      clusterName: The ElasticSearch Cluster Name
      hostAddresses: The Host Addresses
      indexName: The Index in ElasticSearch
      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 elasticsearch-search-source-binding.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 elasticsearch-search-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind elasticsearch-search-source -p "source.clusterName=The ElasticSearch Cluster Name" -p "source.hostAddresses=The Host Addresses" -p "source.indexName=The Index in ElasticSearch" -p "source.query=The Query" channel:mychannel

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

Kafka source

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

elasticsearch-search-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: elasticsearch-search-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: elasticsearch-search-source
    properties:
      clusterName: The ElasticSearch Cluster Name
      hostAddresses: The Host Addresses
      indexName: The Index in ElasticSearch
      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 elasticsearch-search-source-binding.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 elasticsearch-search-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind elasticsearch-search-source -p "source.clusterName=The ElasticSearch Cluster Name" -p "source.hostAddresses=The Host Addresses" -p "source.indexName=The Index in ElasticSearch" -p "source.query=The Query" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

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