diff --git a/Home.md b/Home.md index 93a012c..726b007 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,33 @@ -# Deploy the Project on CamelX Platform +# MongoDB Source -Deploy on CamelX Platform in three steps +Consume data from MongoDB. -## 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 | MongoDB | +| Namespace | Nosql | +| 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 | +|------|------|----------|---------|-------------| +| `hosts` | string | ✓ | | A comma-separated list of MongoDB host addresses in `host:port` format. | +| `collection` | string | ✓ | | The name of the MongoDB collection to bind to this endpoint. | +| `password` | string | | | The user password for accessing MongoDB. | +| `username` | string | | | The username for accessing MongoDB. The username must be present in the MongoDB's authentication database (`authenticationDatabase`). By default, the MongoDB `authenticationDatabase` is 'admin'. | +| `ssl` | boolean | | `true` | whether to enable ssl connection to mongodb | +| `sslValidationEnabled` | boolean | | `true` | IMPORTANT this should be disabled only in test environment since can pose security issues. | +| `database` | string | ✓ | | The name of the MongoDB database. | +| `persistentTailTracking` | boolean | | `false` | Specifies to enable persistent tail tracking, which is a mechanism to keep track of the last consumed data across system restarts. The next time the system is up, the endpoint recovers the cursor from the point where it last stopped consuimg data. This option will only work on capped collections. | +| `tailTrackIncreasingField` | string | | | The correlation field in the incoming data which is of increasing nature and is used to position the tailing cursor every time it is generated. | -## Step 3: Expose -Enable **"Expose"** +## Dependencies -Choose an **API Gateway** (Internal, Public, etc.) +- `camel:kamelet` +- `camel:mongodb` +- `camel:jackson`