Update wiki Home page for kamelet
parent
9d37c9f30a
commit
c031b2b07d
45
Home.md
45
Home.md
@ -1,21 +1,38 @@
|
||||
# Deploy the Project on CamelX Platform
|
||||
# Kamelet
|
||||
|
||||
Deploy on CamelX Platform in three steps
|
||||
To call Kamelets
|
||||
|
||||
## 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 |
|
||||
|----------|-------|
|
||||
| Scheme | `kamelet` |
|
||||
| Support Level | Stable |
|
||||
| Labels | core |
|
||||
| Version | 4.20.0 (CEQ 3.36.0) |
|
||||
|
||||
## Step 2: Deploy
|
||||
Click on **"Deploy"**
|
||||
## Maven Dependency
|
||||
|
||||
- **Version:** Select the desired release
|
||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
||||
- **Configuration:** Select the configuration source
|
||||
- **Resources:** Set CPU and Memory
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>org.apache.camel.quarkus</groupId>
|
||||
<artifactId>camel-quarkus-kamelet</artifactId>
|
||||
<version>4.20.0 (CEQ 3.36.0)</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
## Step 3: Expose
|
||||
Enable **"Expose"**
|
||||
## Endpoint Properties
|
||||
|
||||
Choose an **API Gateway** (Internal, Public, etc.)
|
||||
| Name | Type | Required | Default | Description |
|
||||
|------|------|----------|---------|-------------|
|
||||
| `templateId` | string | ✓ | | The Route Template ID |
|
||||
| `routeId` | string | | | The Route ID. Default value notice: The ID will be auto-generated if not provided |
|
||||
| `bridgeErrorHandler` | boolean | | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
|
||||
| `exceptionHandler` | object | | | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
|
||||
| `exchangePattern` | enum | | | Sets the exchange pattern when the consumer creates an exchange. |
|
||||
| `block` | boolean | | `true` | If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active. |
|
||||
| `failIfNoConsumers` | boolean | | `true` | Whether the producer should fail by throwing an exception, when sending to a kamelet endpoint with no active consumers. |
|
||||
| `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. |
|
||||
| `timeout` | integer | | `30000` | The timeout value to use if block is enabled. |
|
||||
| `location` | string | | | Location of the Kamelet to use which can be specified as a resource from file system, classpath etc. The location cannot use wildcards, and must refer to a file including extension, for example file:/etc/foo-kamelet.xml |
|
||||
| `noErrorHandler` | boolean | | `false` | Whether kamelets should use error handling or not. By default, the Kamelet uses the same error handler as from the calling route. This means that if the calling route has error handling that performs retries, or routing to a dead letter channel, then the kamelet route will use this also. This can be turned off by setting this option to true. If off then the kamelet route is not using error handling, and any exception thrown will for source kamelets be logged by the consumer, and the sink/action kamelets will fail processing. |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user