Update wiki Home page for elasticsearch-rest-client

gitea_admin 2026-03-11 14:37:43 +00:00
parent d25c2573e5
commit d3c256251c

48
Home.md

@ -1,21 +1,41 @@
# Deploy the Project on CamelX Platform
# Elasticsearch Low level Rest Client
Deploy on CamelX Platform in three steps
Perform queries and other operations on Elasticsearch or OpenSearch (uses low-level client).
## Step 1: Create a release
From the project space, click on **"Create a release"**
## Metadata
The new version is automatically available in the list
| Property | Value |
|----------|-------|
| Scheme | `elasticsearch-rest-client` |
| Support Level | Stable |
| Labels | search |
| Version | 4.10.2 |
## Step 2: Deploy
Click on **"Deploy"**
## Maven Dependency
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
```xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-elasticsearch-rest-client</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose
Enable **"Expose"**
## Endpoint Properties
Choose an **API Gateway** (Internal, Public, etc.)
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `clusterName` | string | ✓ | | Cluster Name |
| `connectionTimeout` | integer | | `30000` | Connection timeout |
| `hostAddressesList` | string | | | List of host Addresses, multiple hosts can be separated by comma. |
| `indexName` | string | | | Index Name |
| `operation` | object | | | Operation |
| `socketTimeout` | integer | | `30000` | Socket timeout |
| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
| `enableSniffer` | boolean | | `false` | Enabling Sniffer |
| `restClient` | object | | | Rest Client of type org.elasticsearch.client.RestClient. This is only for advanced usage |
| `sniffAfterFailureDelay` | integer | | `60000` | Sniffer after failure delay (in millis) |
| `snifferInterval` | integer | | `60000` | Sniffer interval (in millis) |
| `certificatePath` | string | | | Certificate Path |
| `password` | string | | | Password |
| `user` | string | | | Username |