Chapter 69. Throttle Action
Chapter 69. Throttle Action The Throttle action allows you to ensure that a specific sink does not get overloaded. 69.1. Configuration Options The following table summarizes the configuration options available for the throttle-action Kamelet: Property Name Description Type Default Example messages * Messages Number The number of messages to send in the time period set integer 10 timePeriod Time Period Sets the time period during which the maximum request count is valid for, in milliseconds string "1000" Note Fields marked with an asterisk (*) are mandatory. 69.2. Dependencies At runtime, the throttle-action Kamelet relies upon the presence of the following dependencies: camel:core camel:kamelet 69.3. Usage This section describes how you can use the throttle-action . 69.3.1. Knative Action You can use the throttle-action Kamelet as an intermediate step in a Knative binding. throttle-action-binding.yaml apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: throttle-action-binding spec: source: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: timer-source properties: message: "Hello" steps: - ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: throttle-action properties: messages: 1 sink: ref: kind: Channel apiVersion: messaging.knative.dev/v1 name: mychannel 69.3.1.1. Prerequisite Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you're connected to. 69.3.1.2. Procedure for using the cluster CLI Save the throttle-action-binding.yaml file to your local drive, and then edit it as needed for your configuration. Run the action by using the following command: oc apply -f throttle-action-binding.yaml 69.3.1.3. Procedure for using the Kamel CLI Configure and run the action by using the following command: kamel bind timer-source?message=Hello --step throttle-action -p "step-0.messages=10" channel:mychannel This command creates the KameletBinding in the current namespace on the cluster. 69.3.2. Kafka Action You can use the throttle-action Kamelet as an intermediate step in a Kafka binding. throttle-action-binding.yaml apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: throttle-action-binding spec: source: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: timer-source properties: message: "Hello" steps: - ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: throttle-action properties: messages: 1 sink: ref: kind: KafkaTopic apiVersion: kafka.strimzi.io/v1beta1 name: my-topic 69.3.2.1. Prerequisites Ensure that you've installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you're connected to. 69.3.2.2. Procedure for using the cluster CLI Save the throttle-action-binding.yaml file to your local drive, and then edit it as needed for your configuration. Run the action by using the following command: oc apply -f throttle-action-binding.yaml 69.3.2.3. Procedure for using the Kamel CLI Configure and run the action by using the following command: kamel bind timer-source?message=Hello --step throttle-action -p "step-0.messages=1" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic This command creates the KameletBinding in the current namespace on the cluster. 69.4. Kamelet source file https://github.com/openshift-integration/kamelet-catalog/throttle-action.kamelet.yaml
apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: throttle-action-binding spec: source: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: timer-source properties: message: "Hello" steps: - ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: throttle-action properties: messages: 1 sink: ref: kind: Channel apiVersion: messaging.knative.dev/v1 name: mychannel apply -f throttle-action-binding.yaml kamel bind timer-source?message=Hello --step throttle-action -p "step-0.messages=10" channel:mychannel apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: throttle-action-binding spec: source: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: timer-source properties: message: "Hello" steps: - ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: throttle-action properties: messages: 1 sink: ref: kind: KafkaTopic apiVersion: kafka.strimzi.io/v1beta1 name: my-topic apply -f throttle-action-binding.yaml kamel bind timer-source?message=Hello --step throttle-action -p "step-0.messages=1" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic