Chapter 16. ElasticSearch Index Sink
The ElasticSearch Index Kamelet is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production.
These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview.
This sink stores documents into ElasticSearch.
Input data must have JSON format according to the index used.
The Kamelet expects the following headers:
-
indexId/ce-indexid: as the index ID for Elasticsearch
If the header won’t be set, the index will be generated by the ES Cluster.
-
indexName/ce-indexname: as the index Name for Elasticsearch
If the header is not set, camel-k-index-es will be used as the index name.
16.1. Configuration Options
The following table summarizes the configuration options available for the elasticsearch-index-sink Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
| clusterName * | ElasticSearch Cluster Name | Name of the cluster. | string |
| |
| hostAddresses * | Host Addresses | Comma separated list with ip:port formatted remote transport addresses to use. | string |
| |
| enableSSL | Enable SSL | Do we want to connect using SSL? | boolean |
| |
| indexName | Index in ElasticSearch | The name of the index to act against. | string |
| |
| password | Password | Password to connect to ElasticSearch. | string | ||
| user | Username | Username to connect to ElasticSearch. | string |
Fields marked with an asterisk (*) are mandatory.
16.2. Dependencies
At runtime, the elasticsearch-index-sink Kamelet relies upon the presence of the following dependencies:
- camel:jackson
- camel:kamelet
- mvn:org.apache.camel.k:camel-k-kamelet-reify
- camel:elasticsearch-rest
- camel:gson
- camel:bean
16.3. Usage
This section describes how you can use the elasticsearch-index-sink.
16.3.1. Knative Sink
You can use the elasticsearch-index-sink Kamelet as a Knative sink by binding it to a Knative object.
elasticsearch-index-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: elasticsearch-index-sink-binding
spec:
source:
ref:
kind: Channel
apiVersion: messaging.knative.dev/v1
name: mychannel
sink:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: elasticsearch-index-sink
properties:
clusterName: "quickstart"
hostAddresses: "quickstart-es-http:9200"
16.3.1.1. Prerequisite
Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
16.3.1.2. Procedure for using the cluster CLI
-
Save the
elasticsearch-index-sink-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the sink by using the following command:
oc apply -f elasticsearch-index-sink-binding.yaml
16.3.1.3. Procedure for using the Kamel CLI
Configure and run the sink by using the following command:
kamel bind channel:mychannel elasticsearch-index-sink -p "sink.clusterName=quickstart" -p "sink.hostAddresses=quickstart-es-http:9200"
This command creates the KameletBinding in the current namespace on the cluster.
16.3.2. Kafka Sink
You can use the elasticsearch-index-sink Kamelet as a Kafka sink by binding it to a Kafka topic.
elasticsearch-index-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: elasticsearch-index-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: elasticsearch-index-sink
properties:
clusterName: "quickstart"
hostAddresses: "quickstart-es-http:9200"
16.3.2.1. Prerequisites
Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
16.3.2.2. Procedure for using the cluster CLI
-
Save the
elasticsearch-index-sink-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the sink by using the following command:
oc apply -f elasticsearch-index-sink-binding.yaml
16.3.2.3. 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 elasticsearch-index-sink -p "sink.clusterName=quickstart" -p "sink.hostAddresses=quickstart-es-http:9200"
This command creates the KameletBinding in the current namespace on the cluster.
