diff --git a/Home.md b/Home.md index 93a012c..cf78fbe 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,45 @@ -# Deploy the Project on CamelX Platform +# Knative -Deploy on CamelX Platform in three steps +Send and receive events from Knative. -## 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 | `knative` | +| Support Level | Stable | +| Labels | cloud | +| Version | 4.10.2 | -## 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 + + org.apache.camel + camel-knative + 4.10.2 + +``` -## Step 3: Expose -Enable **"Expose"** +## Endpoint Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `type` | object | | | The Knative resource type | +| `typeId` | string | | | The identifier of the Knative resource | +| `ceOverride` | object | | | CloudEvent headers to override | +| `cloudEventsSpecVersion` | string | | `1.0` | Set the version of the cloudevents spec. | +| `cloudEventsType` | string | | `org.apache.camel.event` | Set the event-type information of the produced events. | +| `environment` | object | | | The environment | +| `filters` | object | | | Set the filters. | +| `sinkBinding` | object | | | The SinkBinding configuration. | +| `transportOptions` | object | | | Set the transport options. | +| `replyWithCloudEvent` | boolean | | `false` | Transforms the reply into a cloud event that will be processed by the caller. When listening to events from a Knative Broker, if this flag is enabled, replies will be published to the same Broker where the request comes from (beware that if you don't change the type of the received message, you may create a loop and receive your same reply). When this flag is disabled, CloudEvent headers are removed from the reply. | +| `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` | object | | | Sets the exchange pattern when the consumer creates an exchange. | +| `reply` | boolean | | `true` | If the consumer should construct a full reply to knative request. | +| `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. | +| `apiVersion` | string | | | The version of the k8s resource referenced by the endpoint. | +| `kind` | string | | | The type of the k8s resource referenced by the endpoint. | +| `name` | string | | | The name of the k8s resource referenced by the endpoint. |