// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
= image:kamelets/file-watch-source.svg[] File Watch Source

*Provided by: "Apache Software Foundation"*

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:
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *events {empty}* *| The events| The type of events to consume| boolean| `"CREATE,MODIFY,DELETE"`| 
| *path {empty}* *| The path| Path of file or folder to watch| string| | 
|===

NOTE: Fields marked with ({empty}*) are mandatory.

== Usage

This section summarizes how the `file-watch-source` can be used in various contexts.

=== Knative Source

The `file-watch-source` Kamelet can be used as Knative source by binding it to a Knative object.

.file-watch-source-binding.yaml
[source,yaml]
----
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: file-watch-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: file-watch-source
    properties:
      path: "The The path"
  sink:
    ref:
      kind: InMemoryChannel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

----

Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.

Save the `file-watch-source-binding.yaml` file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

[source,shell]
----
kubectl apply -f file-watch-source-binding.yaml
----
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
