Update wiki Home page for aws2-msk

gitea_admin 2026-03-11 14:35:47 +00:00
parent a7367dd9f2
commit 39836896d1

53
Home.md

@ -1,21 +1,46 @@
# Deploy the Project on CamelX Platform # AWS Managed Streaming for Apache Kafka (MSK)
Deploy on CamelX Platform in three steps Manage AWS MSK instances.
## Step 1: Create a release ## Metadata
From the project space, click on **"Create a release"**
The new version is automatically available in the list | Property | Value |
|----------|-------|
| Scheme | `aws2-msk` |
| Support Level | Stable |
| Labels | cloud,management |
| Version | 4.10.2 |
## Step 2: Deploy ## Maven Dependency
Click on **"Deploy"**
- **Version:** Select the desired release ```xml
- **Environment:** Choose `Development`, `Staging`, or `Production` <dependency>
- **Configuration:** Select the configuration source <groupId>org.apache.camel</groupId>
- **Resources:** Set CPU and Memory <artifactId>camel-aws2-msk</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose ## Endpoint Properties
Enable **"Expose"**
Choose an **API Gateway** (Internal, Public, etc.) | Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `label` | string | ✓ | | Logical name |
| `operation` | object | ✓ | | The operation to perform |
| `overrideEndpoint` | boolean | | `false` | Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option |
| `pojoRequest` | boolean | | `false` | If we want to use a POJO request as body or not |
| `region` | string | | | The region in which the MSK client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id() |
| `uriEndpointOverride` | string | | | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option |
| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
| `mskClient` | object | | | To use an existing configured AWS MSK client |
| `proxyHost` | string | | | To define a proxy host when instantiating the MSK client |
| `proxyPort` | integer | | | To define a proxy port when instantiating the MSK client |
| `proxyProtocol` | object | | `HTTPS` | To define a proxy protocol when instantiating the MSK client |
| `accessKey` | string | | | Amazon AWS Access Key |
| `profileCredentialsName` | string | | | If using a profile credentials provider, this parameter will set the profile name |
| `secretKey` | string | | | Amazon AWS Secret Key |
| `sessionToken` | string | | | Amazon AWS Session Token used when the user needs to assume an IAM role |
| `trustAllCertificates` | boolean | | `false` | If we want to trust all certificates in case of overriding the endpoint |
| `useDefaultCredentialsProvider` | boolean | | `false` | Set whether the Kafka client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. |
| `useProfileCredentialsProvider` | boolean | | `false` | Set whether the MSK client should expect to load credentials through a profile credentials provider. |
| `useSessionCredentials` | boolean | | `false` | Set whether the MSK client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in MSK. |