diff --git a/Home.md b/Home.md index 93a012c..e63bcd3 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,45 @@ -# Deploy the Project on CamelX Platform +# Pulsar Source -Deploy on CamelX Platform in three steps +Receive data from Pulsar 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 | Pulsar | +| Namespace | Messaging | +| 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 | ✓ | | The topic name or regexp | +| `tenant` | string | ✓ | | The Tenant Name | +| `topicType` | string | ✓ | | The topic type. | +| `namespaceName` | string | ✓ | | The Pulsar Namespace Name | +| `serviceUrl` | string | ✓ | | The Pulsar Service URL to point while creating the client from URI. | +| `authenticationClass` | string | | | The Authentication FQCN to be used while creating the client from URI. | +| `authenticationParams` | string | | | The Authentication Parameters to be used while creating the client from URI. | +| `consumerNamePrefix` | string | | `cons` | Prefix to add to consumer names when a SHARED or FAILOVER subscription is used | +| `consumerQueueSize` | integer | | `10` | Size of the consumer queue | +| `deadLetterTopic` | integer | | | Name of the topic where the messages which fail maxRedeliverCount times will be sent. Note: if not set, default topic name will be topicName-subscriptionName-DLQ. | +| `maxRedeliverCount` | integer | | | Maximum number of times that a message will be redelivered before being sent to the dead letter queue. If this value is not set, no Dead Letter Policy will be created. | +| `negativeAckRedeliveryDelayMicros` | integer | | `60000000` | Set the negative acknowledgement delay. | +| `messageListener` | boolean | | `true` | Whether to use the messageListener interface, or to receive messages using a separate thread pool. | +| `numberOfConsumers` | integer | | `1` | Number of consumers. | +| `numberOfConsumerThreads` | integer | | `1` | Number of threads to receive and handle messages when using a separate thread pool. | +| `readCompacted` | boolean | | `false` | Enable compacted topic reading. | +| `subscriptionInitialPosition` | string | | `LATEST` | Control the initial position in the topic of a newly created subscription. Default is latest message. | +| `subscriptionName` | string | | `subs` | Name of the subscription to use. | +| `subscriptionTopicsMode` | string | | `PersistentOnly` | Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions. | +| `subscriptionType` | string | | `EXCLUSIVE` | Type of the subscription. | +| `topicsPattern` | boolean | | `false` | Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace. | -## Step 3: Expose -Enable **"Expose"** +## Dependencies -Choose an **API Gateway** (Internal, Public, etc.) +- `camel:pulsar` +- `camel:kamelet` +- `camel:core`