diff --git a/Home.md b/Home.md index 93a012c..e2b7af0 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,39 @@ -# Deploy the Project on CamelX Platform +# ElasticSearch Search Source -Deploy on CamelX Platform in three steps +Search data on ElasticSearch -## Step 1: Create a release -From the project space, click on **"Create a release"** +The `query` parameter must be formatted in JSON. -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"** +## Metadata -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +| Property | Value | +|----------|-------| +| Type | source | +| Group | ElasticSearch | +| Namespace | Search | +| Support Level | Stable | +| Provider | Apache Software Foundation | -## Step 3: Expose -Enable **"Expose"** +## Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `period` | integer | | `1000` | The time interval between two searches | +| `query` | string | ✓ | | The query we want to use to search on ElasticSearch. | +| `user` | string | | | Username to connect to ElasticSearch. | +| `password` | string | | | Password to connect to ElasticSearch. | +| `enableSSL` | boolean | | `true` | Do we want to connect using SSL? | +| `hostAddresses` | string | ✓ | | Comma separated list with ip:port formatted remote transport addresses to use. | +| `indexName` | string | ✓ | | The name of the index to act against. | +| `clusterName` | string | ✓ | | The name of the cluster. | +| `certificate` | string | | | The Certificate for accessing the Elasticsearch cluster. You must encode this value in base64. | + +## Dependencies + +- `camel:core` +- `camel:kamelet` +- `camel:timer` +- `camel:elasticsearch` +- `camel:gson`