camel-apache-org/ibm-cos-source
camel-apache-org/ibm-cos-source
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update wiki Home page for ibm-cos-source

gitea_admin 2026-10-12 05:31:45 +00:00
parent c2481e7b45
commit b92a6bf2f7
1 changed files with 34 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
Home.md

@ -1,21 +1,41 @@
# Deploy the Project on CamelX Platform
# IBM Cloud Object Storage Source
Deploy on CamelX Platform in three steps
Receive data from an IBM Cloud Object Storage Bucket.
## 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 | IBM Cloud Object Storage |
| Namespace | IBM |
| 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 |
|------|------|----------|---------|-------------|
| `bucketName` | string | ✓ | | The IBM COS Bucket name. |
| `apiKey` | string | ✓ | | IBM Cloud API Key for authentication. |
| `serviceInstanceId` | string | ✓ | | IBM COS Service Instance ID (CRN). |
| `endpointUrl` | string | ✓ | | IBM COS Endpoint URL (e.g., https://s3.us-south.cloud-object-storage.appdomain.cloud). |
| `location` | string | | | IBM COS Location/Region (e.g., us-south, eu-gb). |
| `deleteAfterRead` | boolean | | `true` | Specifies to delete objects after consuming them. |
| `moveAfterRead` | boolean | | `false` | Move objects from IBM COS bucket to a different bucket after they have been retrieved. |
| `destinationBucket` | string | | | Define the destination bucket where an object must be moved when moveAfterRead is set to true. |
| `destinationBucketPrefix` | string | | | Define the destination bucket prefix to use when an object must be moved, and moveAfterRead is set to true. |
| `destinationBucketSuffix` | string | | | Define the destination bucket suffix to use when an object must be moved, and moveAfterRead is set to true. |
| `autoCreateBucket` | boolean | | `false` | Specifies to automatically create the IBM COS bucket. |
| `prefix` | string | | | The IBM COS bucket prefix to consider while searching. |
| `delimiter` | string | | | The delimiter to use for listing objects. |
| `includeBody` | boolean | | `true` | If true, the object body is included in the exchange. If false, only headers are set. |
| `includeFolders` | boolean | | `true` | Include folders/directories when listing objects. |
| `delay` | integer | | `500` | The number of milliseconds before the next poll of the selected bucket. |
| `maxMessagesPerPoll` | integer | | `10` | Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited. |
## Step 3: Expose
Enable **"Expose"**
## Dependencies
Choose an **API Gateway** (Internal, Public, etc.)
- `camel:core`
- `camel:ibm-cos`
- `camel:kamelet`