Update wiki Home page for kafka-azure-schema-registry-source

gitea_admin 2026-03-11 14:37:53 +00:00
parent 1e0b7af5e1
commit 082b9dfc07

50
Home.md

@ -1,21 +1,43 @@
# Deploy the Project on CamelX Platform
# Azure Kafka through Eventhubs with Azure Schema Registry Source
Deploy on CamelX Platform in three steps
Receive data from Kafka topics on Azure Eventhubs combined with Azure Schema Registry.
## 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 | Preview |
| 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 | | `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. |
| `password` | string | ✓ | | Password to authenticate to kafka |
| `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. |
| `valueDeserializer` | string | | `com.microsoft.azure.schemaregistry.kafka.avro.KafkaAvroDeserializer` | Deserializer class for value that implements the Deserializer interface. |
| `azureRegistryUrl` | string | ✓ | | The Apicurio Schema Registry URL |
| `specificAvroValueType` | string | | | The Specific Type Avro will have to deal with |
| `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:kafka`
- `camel:core`
- `camel:kamelet`
- `camel:azure-schema-registry`
- `mvn:com.microsoft.azure:azure-schemaregistry-kafka-avro:1.1.1`
- `mvn:com.azure:azure-data-schemaregistry-apacheavro:1.1.23`
- `mvn:com.azure:azure-identity:1.15.0`