diff --git a/Home.md b/Home.md index 93a012c..ea965dd 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,38 @@ -# Deploy the Project on CamelX Platform +# Kafka Sink -Deploy on CamelX Platform in three steps +Send data to Kafka topics through Plain Login Module. -## Step 1: Create a release -From the project space, click on **"Create a release"** +The Kamelet is able to understand the following headers to be set: -The new version is automatically available in the list +- `key` / `ce-key`: as message key -## Step 2: Deploy -Click on **"Deploy"** +- `partition-key` / `ce-partitionkey`: as message partition key -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +Both the headers are optional. -## Step 3: Expose -Enable **"Expose"** +## Metadata -Choose an **API Gateway** (Internal, Public, etc.) +| Property | Value | +|----------|-------| +| Type | sink | +| Group | Kafka | +| Namespace | Kafka | +| Support Level | Stable | +| Provider | Apache Software Foundation | + +## Properties + +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `topic` | string | ✓ | | Comma separated list of Kafka topic names | +| `bootstrapServers` | string | ✓ | | Comma separated list of Kafka Broker URLs | +| `securityProtocol` | string | | `SASL_SSL` | Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT, SASL_SSL and SSL are supported | +| `saslMechanism` | string | | `PLAIN` | The Simple Authentication and Security Layer (SASL) Mechanism used. | +| `user` | string | ✓ | | Username to authenticate to Kafka | +| `password` | string | ✓ | | Password to authenticate to kafka | + +## Dependencies + +- `camel:core` +- `camel:kafka` +- `camel:kamelet`