docs/modules/ROOT/pages/elasticsearch-index-sink.adoc

// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
= image:kamelets/elasticsearch-index-sink.svg[] ElasticSearch Index Sink

*Provided by: "Apache Software Foundation"*

Insert data into ElasticSearch. Input data must have JSON format.

== Configuration Options

The following table summarizes the configuration options available for the `elasticsearch-index-sink` Kamelet:
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *clusterName {empty}* *| ElasticSearch Cluster Name| Name of the cluster.| string| | 
| *hostAddresses {empty}* *| Host Addresses| Comma separated list with ip:port formatted remote transport addresses to use.| string| | 
| *indexName {empty}* *| Index in ElasticSearch| The name of the index to act against.| string| | 
| enableSSL| Enable SSL| Do we want to connect using SSL?| boolean| `true`| 
| password| Password| Password to connect to ElasticSearch.| string| | 
| user| Username| Username to connect to ElasticSearch.| string| | 
|===

NOTE: Fields marked with ({empty}*) are mandatory.

== Usage

This section summarizes how the `elasticsearch-index-sink` can be used in various contexts.

=== Knative Sink

The `elasticsearch-index-sink` Kamelet can be used as Knative sink by binding it to a Knative object.

.elasticsearch-index-sink-binding.yaml
[source,yaml]
----
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: elasticsearch-index-sink-binding
spec:
  source:
    ref:
      kind: InMemoryChannel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: elasticsearch-index-sink
    properties:
      clusterName: "The ElasticSearch Cluster Name"
      hostAddresses: "The Host Addresses"
      indexName: "The Index in ElasticSearch"

----

Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.

Save the `elasticsearch-index-sink-binding.yaml` file into your hard drive, then configure it according to your needs.

You can run the sink using the following command:

[source,shell]
----
kubectl apply -f elasticsearch-index-sink-binding.yaml
----
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT