File¶

File event-source listens to file system events and helps sensor trigger workloads.

Event Structure¶

The structure of an event dispatched by the event-source over the eventbus looks like following,

    {
        "context": {
          "type": "type_of_event_source",
          "specversion": "cloud_events_version",
          "source": "name_of_the_event_source",
          "id": "unique_event_id",
          "time": "event_time",
          "datacontenttype": "type_of_data",
          "subject": "name_of_the_configuration_within_event_source"
        },
        "data": {
            "name": "Relative path to the file or directory",
            "op": "File operation that triggered the event" // Create, Write, Remove, Rename, Chmod
        }
    }

Specification¶

File event-source specification is available here.

Setup¶

Create the event source by running the following command.

kubectl apply -n argo-events -f https://raw.githubusercontent.com/argoproj/argo-events/stable/examples/event-sources/file.yaml

The event source has configuration to listen to file system events for test-data directory and file called x.txt.

Create the sensor by running the following command.

kubectl apply -n argo-events -f https://raw.githubusercontent.com/argoproj/argo-events/stable/examples/sensors/file.yaml

Log into the event-source pod by running following command.

kubectl -n argo-events exec -it <event-source-pod-name> -c file-events -- /bin/bash

Let's create a file called x.txt under test-data directory in the event-source pod.
```
cd test-data
cat <<EOF > x.txt
hello
EOF
```
Once you create file x.txt, the sensor will trigger argo workflow. Run argo list to find the workflow.
For real-world use cases, you should use PersistentVolumeClaim.

Troubleshoot¶

Please read the FAQ.