Update wiki Home page for opensearch

gitea_admin 2026-03-11 14:41:31 +00:00
parent eb6ed13591
commit 9d0f85702e

55
Home.md

@ -1,21 +1,48 @@
# Deploy the Project on CamelX Platform
# OpenSearch
Deploy on CamelX Platform in three steps
Send requests to OpenSearch via Java Client API.
## 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 | `opensearch` |
| Support Level | Stable |
| Labels | search,monitoring |
| 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-opensearch</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 | ✓ | | Name of the cluster |
| `connectionTimeout` | integer | | `30000` | The time in ms to wait before connection will time out. |
| `disconnect` | boolean | | `false` | Disconnect after it finish calling the producer |
| `from` | integer | | | Starting index of the response. |
| `hostAddresses` | string | | | Comma separated list with ip:port formatted remote transport addresses to use. |
| `indexName` | string | | | The name of the index to act against |
| `maxRetryTimeout` | integer | | `30000` | The time in ms before retry |
| `operation` | object | | | What operation to perform |
| `scrollKeepAliveMs` | integer | | `60000` | Time in ms during which OpenSearch will keep search context alive |
| `size` | integer | | | Size of the response. |
| `socketTimeout` | integer | | `30000` | The timeout in ms to wait before the socket will time out. |
| `useScroll` | boolean | | `false` | Enable scroll usage |
| `waitForActiveShards` | integer | | `1` | Index creation waits for the write consistency number of shards to be available |
| `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. |
| `documentClass` | string | | `ObjectNode` | The class to use when deserializing the documents. |
| `enableSniffer` | boolean | | `false` | Enable automatically discover nodes from a running OpenSearch cluster. If this option is used in conjunction with Spring Boot, then it's managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot). |
| `hostnameVerifier` | object | | | The class to use as HostnameVerifier. By default there is no HostnameVerifier. |
| `sniffAfterFailureDelay` | integer | | `60000` | The delay of a sniff execution scheduled after a failure (in milliseconds) |
| `snifferInterval` | integer | | `300000` | The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions |
| `certificatePath` | string | | | The certificate that can be used to access the ES Cluster. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. |
| `enableSSL` | boolean | | `false` | Enable SSL |