diff --git a/Home.md b/Home.md index 93a012c..4fa5f7a 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,28 @@ -# Deploy the Project on CamelX Platform +# MQTT 5 Source -Deploy on CamelX Platform in three steps +Allows receiving messages from any endpoint that supports the MQTT v5 protocol, such as a message broker. -## 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 | MQTT 5 | +| 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 to subscribe to | +| `brokerUrl` | string | ✓ | | The URL of the broker where to establish the connection | +| `clientId` | string | | `mqtt-source` | The client ID to use when connecting to the resource | +| `username` | string | | | Username to use when connecting to the MQTT v5 compliant broker | +| `password` | string | | | Password to use when connecting to the MQTT v5 compliant broker | -## Step 3: Expose -Enable **"Expose"** +## Dependencies -Choose an **API Gateway** (Internal, Public, etc.) +- `camel:paho-mqtt5` +- `camel:kamelet`