Update wiki Home page for kafka-ssl-source

gitea_admin 2026-03-11 14:38:28 +00:00
parent 105c0f8942
commit 82a9c65b83

51
Home.md

@ -1,21 +1,44 @@
# Deploy the Project on CamelX Platform
# Kafka SSL Source
Deploy on CamelX Platform in three steps
Receive data from Kafka topics with SSL/TLS support
## 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 |
|----------|-------|
| Type | source |
| Group | Kafka |
| Namespace | Kafka |
| Support Level | Stable |
| Provider | Apache Software Foundation |
## Step 2: Deploy
Click on **"Deploy"**
## Properties
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
| 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 | | `SSL` | Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT, SASL_SSL and SSL are supported |
| `saslMechanism` | string | | `GSSAPI` | The Simple Authentication and Security Layer (SASL) Mechanism used. |
| `autoCommitEnable` | boolean | | `true` | If true, periodically commit to ZooKeeper the offset of messages already fetched by the consumer |
| `allowManualCommit` | boolean | | `false` | Whether to allow doing manual commits |
| `pollOnError` | string | | `ERROR_HANDLER` | What to do if kafka threw an exception while polling for new messages. There are 5 enums and the value can be one of DISCARD, ERROR_HANDLER, RECONNECT, RETRY, STOP |
| `autoOffsetReset` | string | | `latest` | What to do when there is no initial offset. There are 3 enums and the value can be one of latest, earliest, none |
| `consumerGroup` | string | | | A string that uniquely identifies the group of consumers to which this source belongs |
| `deserializeHeaders` | boolean | | `true` | When enabled the Kamelet source will deserialize all message headers to String representation. |
| `sslKeyPassword` | string | ✓ | | The password of the private key in the key store file. |
| `sslKeystorePassword` | string | | | The store password for the key store file.This is optional for client and only needed if ssl.keystore.location is configured. |
| `sslEndpointAlgorithm` | string | | `https` | The endpoint identification algorithm to validate server hostname using server certificate. Use none or false to disable server hostname verification. |
| `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. |
| `sslKeystoreLocation` | string | | | The location of the key store file. This is optional for client and can be used for two-way authentication for client. |
| `sslTruststoreLocation` | string | ✓ | | The location of the trust store file. |
| `sslTruststorePassword` | string | ✓ | | The store password for the trust store file. |
| `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. |
| `saslJaasConfig` | string | | | Java Authentication and Authorization Service (JAAS) for Simple Authentication and Security Layer (SASL) configuration. |
| `topicIsPattern` | boolean | | `false` | Whether the topic is a pattern (regular expression). This can be used to subscribe to dynamic number of topics matching the pattern. |
## Step 3: Expose
Enable **"Expose"**
## Dependencies
Choose an **API Gateway** (Internal, Public, etc.)
- `camel:core`
- `camel:kafka`
- `camel:kamelet`