diff --git a/Home.md b/Home.md index 93a012c..80a6ae3 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,46 @@ -# Deploy the Project on CamelX Platform +# ElasticSearch Index Sink -Deploy on CamelX Platform in three steps +Stores JSON-formatted data into ElasticSearch. -## Step 1: Create a release -From the project space, click on **"Create a release"** +The input data must be formatted in JSON according to the requirements of the index. -The new version is automatically available in the list +If you specify the `certificate` property, you must base64 encode it before you pass it as a parameter. -## Step 2: Deploy -Click on **"Deploy"** +In the header, you can set the following properties: -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +- `indexId` / `ce-indexid`: The index ID for ElasticSearch. -## Step 3: Expose -Enable **"Expose"** +- `indexName` / `ce-indexname`: The index name for ElasticSearch. -Choose an **API Gateway** (Internal, Public, etc.) +If you do not set a property in the header, the Kamelet uses the exchange ID for the index setting. + +## Metadata + +| Property | Value | +|----------|-------| +| Type | sink | +| Group | ElasticSearch | +| Namespace | Search | +| Support Level | Stable | +| Provider | Apache Software Foundation | + +## Properties + +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `user` | string | | | The username to connect to ElasticSearch. | +| `password` | string | | | The password to connect to ElasticSearch. | +| `enableSSL` | boolean | | `true` | Specifies to connect by using SSL. | +| `hostAddresses` | string | ✓ | | A comma-separated list of remote transport addresses in `ip:port format`. | +| `clusterName` | string | ✓ | | The name of the ElasticSearch cluster. | +| `indexName` | string | | | The name of the ElasticSearch index. | +| `certificate` | string | | | The Certificate for accessing the Elasticsearch cluster. You must encode this value in base64. | + +## Dependencies + +- `camel:core` +- `camel:jackson` +- `camel:kamelet` +- `camel:elasticsearch` +- `camel:gson` +- `camel:bean`