Update wiki Home page for kafka-ssl-sink

Home.md

@@ -1,21 +1,44 @@
-# Deploy the Project on CamelX Platform
+# Kafka SSL Sink
 
-Deploy on CamelX Platform in three steps
+Send data to Kafka topics wit TLS/SSL support.
 
-## Step 1: Create a release
+The Kamelet is able to understand the following headers to be set:
-From the project space, click on **"Create a release"**
 
-The new version is automatically available in the list
+- `key` / `ce-key`: as message key
 
-## Step 2: Deploy
+- `partition-key` / `ce-partitionkey`: as message partition key
-Click on **"Deploy"**
 
-- **Version:** Select the desired release
+Both the headers are optional.
-- **Environment:** Choose `Development`, `Staging`, or `Production` 
-- **Configuration:** Select the configuration source
-- **Resources:** Set CPU and Memory
 
-## Step 3: Expose
+## Metadata
-Enable **"Expose"**
 
-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 |
+|------|------|----------|---------|-------------|
+| `bootstrapServers` | string | ✓ |  | Comma separated list of Kafka Broker URLs |
+| `sslKeystoreLocation` | string | ✓ |  | The location of the key store file. This is optional for client and can be used for two-way authentication for client. |
+| `sslProtocol` | string |  | `TLSv1.2` | The SSL protocol used to generate the SSLContext. Default setting is TLS, which is fine for most cases. Allowed values in recent JVMs are TLS, TLSv1.1 and TLSv1.2. SSL, SSLv2 and SSLv3 may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities. |
+| `saslMechanism` | string |  | `GSSAPI` | The Simple Authentication and Security Layer (SASL) Mechanism used. |
+| `sslEnabledProtocols` | string |  | `TLSv1.2,TLSv1.1,TLSv1` | The list of protocols enabled for SSL connections. TLSv1.2, TLSv1.1 and TLSv1 are enabled by default. |
+| `sslKeystorePassword` | string | ✓ |  | The store password for the key store file.This is optional for client and only needed if ssl.keystore.location is configured. |
+| `sslTruststoreLocation` | string | ✓ |  | The location of the trust store file. |
+| `sslTruststorePassword` | string | ✓ |  | The store password for the trust store file. |
+| `sslKeyPassword` | string | ✓ |  | The password of the private key in the key store file. |
+| `sslEndpointAlgorithm` | string |  | `https` | The endpoint identification algorithm to validate server hostname using server certificate. Use none or false to disable server hostname verification. |
+| `topic` | string | ✓ |  | Comma separated list of Kafka topic names |
+| `securityProtocol` | string |  | `SSL` | Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT, SASL_SSL and SSL are supported |
+
+## Dependencies
+
+- `camel:core`
+- `camel:kafka`
+- `camel:kamelet`