generated from camel.apache.org/kamelet
Update wiki Home page for opensearch-index-sink
parent
f181701252
commit
bd3cad0e72
53
Home.md
53
Home.md
@ -1,21 +1,46 @@
|
||||
# Deploy the Project on CamelX Platform
|
||||
# OpenSearch Index Sink
|
||||
|
||||
Deploy on CamelX Platform in three steps
|
||||
Stores JSON-formatted data into Opensearch.
|
||||
|
||||
## 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 OpenSearch.
|
||||
|
||||
## Step 3: Expose
|
||||
Enable **"Expose"**
|
||||
- `indexName` / `ce-indexname`: The index name for OpenSearch.
|
||||
|
||||
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 | OpenSearch |
|
||||
| Namespace | Search |
|
||||
| Support Level | Stable |
|
||||
| Provider | Apache Software Foundation |
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Required | Default | Description |
|
||||
|------|------|----------|---------|-------------|
|
||||
| `user` | string | | | The username to connect to OpenSearch. |
|
||||
| `password` | string | | | The password to connect to OpenSearch. |
|
||||
| `enableSSL` | boolean | | `false` | 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 OpenSearch cluster. |
|
||||
| `indexName` | string | | | The name of the OpenSearch index. |
|
||||
| `certificate` | string | | | The Certificate for accessing the OpenSearch cluster. You must encode this value in base64. |
|
||||
|
||||
## Dependencies
|
||||
|
||||
- `camel:core`
|
||||
- `camel:jackson`
|
||||
- `camel:kamelet`
|
||||
- `camel:opensearch`
|
||||
- `camel:gson`
|
||||
- `camel:bean`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user