From 923c0c2b70dfb82d0280d8c3aa99486184d0b424 Mon Sep 17 00:00:00 2001 From: gitea_admin Date: Mon, 12 Oct 2026 05:32:43 +0000 Subject: [PATCH] Update wiki Home page for kafka-source --- Home.md | 52 ++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 38 insertions(+), 14 deletions(-) diff --git a/Home.md b/Home.md index 93a012c..33111ff 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,45 @@ -# Deploy the Project on CamelX Platform +# Kafka Source -Deploy on CamelX Platform in three steps +Receive data from Kafka topics. -## 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 | +| `saslAuthType` | string | | `NONE` | Authentication type to use. Use NONE for no authentication, PLAIN or SCRAM_SHA_256/SCRAM_SHA_512 for username/password, SSL for certificate-based, OAUTH for OAuth 2.0, AWS_MSK_IAM for MSK, or KERBEROS for Kerberos. | +| `saslUsername` | string | | | Username for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512. | +| `saslPassword` | string | | | Password for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512. | +| `oauthClientId` | string | | | OAuth client ID. Required when saslAuthType is OAUTH. | +| `oauthClientSecret` | string | | | OAuth client secret. Required when saslAuthType is OAUTH. | +| `oauthTokenEndpointUri` | string | | | OAuth token endpoint URI. Required when saslAuthType is OAUTH. | +| `oauthScope` | string | | | OAuth scope. Optional when saslAuthType is OAUTH. | +| `sslTruststoreLocation` | string | | | The location of the trust store file. | +| `sslTruststorePassword` | string | | | The password for the trust store file. | +| `sslKeystoreLocation` | string | | | The location of the key store file. Used for mTLS authentication. | +| `sslKeystorePassword` | string | | | The password for the key store file. | +| `sslKeyPassword` | string | | | The password of the private key in the key store file. | +| `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. | +| `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`