Update wiki Home page for ibm-cos-sink

gitea_admin 2026-10-12 05:31:44 +00:00
parent ecea5d72d4
commit 6d971195da

41
Home.md

@ -1,21 +1,34 @@
# Deploy the Project on CamelX Platform
# IBM Cloud Object Storage Sink
Deploy on CamelX Platform in three steps
Upload data to 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 | sink |
| 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). |
| `autoCreateBucket` | boolean | | `false` | Specifies to automatically create the IBM COS bucket. |
| `keyName` | string | | | The key name for saving an element in the bucket. |
| `multiPartUpload` | boolean | | `false` | Use multi-part upload for large files. |
| `partSize` | integer | | `26214400` | Part size for multi-part uploads (default 25MB). |
| `storageClass` | string | | | The storage class to use when storing objects (e.g., STANDARD, VAULT, COLD, FLEX). |
## Step 3: Expose
Enable **"Expose"**
## Dependencies
Choose an **API Gateway** (Internal, Public, etc.)
- `camel:core`
- `camel:ibm-cos`
- `camel:kamelet`