file watch source File Watch Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Receive events related to a file or folder. It may require a volume mounting on Kubernetes.

Configuration Options

The following table summarizes the configuration options available for the file-watch-source Kamelet:

Property Name Description Type Default Example

events

Events

Required The type of events to consume.

string

CREATE,MODIFY,DELETE

filePath

Path to Watch

Required Path of file or folder to watch.

string

Dependencies

At runtime, the file-watch-source Kamelet relies upon the presence of the following dependencies:

  • camel:file-watch

  • camel:kamelet

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the file-watch-source.

Knative source

You can use the file-watch-source Kamelet as a Knative source by binding it to a Knative object.

file-watch-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: file-watch-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: file-watch-source
    properties:
      events: The Events
      filePath: The Path to Watch
  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 file-watch-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f file-watch-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind file-watch-source -p "source.events=The Events" -p "source.filePath=The Path to Watch" channel:mychannel

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka source

You can use the file-watch-source Kamelet as a Kafka source by binding it to a Kafka topic.

file-watch-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: file-watch-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: file-watch-source
    properties:
      events: The Events
      filePath: The Path to Watch
  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 file-watch-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f file-watch-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind file-watch-source -p "source.events=The Events" -p "source.filePath=The Path to Watch" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the Kamelet Pipe in the current namespace on the cluster.