Documentation updates. (#69)

Add info about inlined, file and url sources for trigger workflows in the docs as well as changelog. Refs #41.
argoproj · Jul 26, 2018 · ddee233 · ddee233
1 parent b45849c
commit ddee233
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 + Signals as separate deployments [#49](https://github.com/argoproj/argo-events/pull/49)
 + Fixed code-gen bug [#46](https://github.com/argoproj/argo-events/issues/46)
 + Filters for signals [#26](https://github.com/argoproj/argo-events/issues/26)
++ Inline, file and url sources for trigger workflows [#41](https://github.com/argoproj/argo-events/issues/41)
 
 ## v0.5-alpha1
-+ Initial release
++ Initial release
diff --git a/docs/trigger-guide.md b/docs/trigger-guide.md
@@ -1,12 +1,17 @@
 # Trigger Guide
 Triggers are the sensor's actions. Triggers are only executed after all of the sensor's signals have been resolved.
 
-## What is a trigger?
-A `trigger` is an output or an action, namely:
-- a Kubernetes resource object
-- a message on a streaming service
+The `resource` field in the trigger object has details of what to execute when the signals have been resolved. The `source` field in the `resource` object can have 3 types of values:
+
+- inline:
+In this case, the workflow to execute as part of the trigger is inlined in the sensor yaml itself. E.g. [inline-sensor](https://github.com/argoproj/argo-events/blob/master/examples/inline-sensor.yaml)
+
+- file:
+In this case, the workflow to execute is specified as a file-system path. This file-system path should exist in the sensor-controller deployment. The default sensor-controller does not have any volume mounts and therefore does not have any workflow yamls. If users are going to use this, they should explicitly mount appropriate volumes in the sensor-controller deployment. E.g. [file-sensor](https://github.com/argoproj/argo-events/blob/master/examples/file-sensor.yaml)
+
+- url:
+In this case, the workflow to execute is specified as a url path. E.g. [url-sensor](https://github.com/argoproj/argo-events/blob/master/examples/url-sensor.yaml)
 
-## Types of Trigger
 
 ### Resource Object
 Resources define a YAML or JSON K8 resource. The set of currently resources supported are implemented in the `store` package. Adding support for new resources is as simple as including the type you want to create in the store's `decodeAndUnstructure()` method. We hope to change this functionality so that permissions for CRUD operations against certain resources can be controlled through RBAC roles instead.