throttle action Throttle Action

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

The Throttle action allows to ensure that a specific sink does not get overloaded.

Configuration Options

The following table summarizes the configuration options available for the throttle-action Kamelet:

Property Name Description Type Default Example

messages

Messages Number

Required 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

Dependencies

At runtime, the throttle-action Kamelet relies upon the presence of the following dependencies:

  • camel:core

  • camel:kamelet

Usage

This section describes how you can use the throttle-action.

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: "10"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the throttle-action-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command:

    kubectl apply -f throttle-action-binding.yaml

Procedure for using the Kamel CLI

Configure and run the action by using the following command:

kamel bind throttle-action -p "step-0.messages=10" channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

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: "10"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the throttle-action-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command:

    kubectl apply -f throttle-action-binding.yaml

Procedure for using the Kamel CLI

Configure and run the action by using the following command:

kamel bind throttle-action -p "step-0.messages=10" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/throttle-action.kamelet.yaml

Back to top