feat: add list of event types for resource gateway (#561)

* feat: add list of event types for resource gateway * chore: revert resource event source example
argoproj · Mar 30, 2020 · b1a3e2b · b1a3e2b
1 parent 1a3cbe6
commit b1a3e2b
Show file tree

Hide file tree

Showing 12 changed files with 138 additions and 112 deletions.
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/api/event-source.html b/api/event-source.html
@@ -1822,7 +1822,8 @@ <h3 id="argoproj.io/v1alpha1.ResourceEventSource">ResourceEventSource
 </td>
 <td>
 <em>(Optional)</em>
-<p>Filter is applied on the metadata of the resource</p>
+<p>Filter is applied on the metadata of the resource
+If you apply filter, then the internal event informer will only monitor objects that pass the filter.</p>
 </td>
 </tr>
 <tr>
@@ -1843,17 +1844,16 @@ <h3 id="argoproj.io/v1alpha1.ResourceEventSource">ResourceEventSource
 </tr>
 <tr>
 <td>
-<code>eventType</code></br>
+<code>eventTypes</code></br>
 <em>
 <a href="#argoproj.io/v1alpha1.ResourceEventType">
-ResourceEventType
+[]ResourceEventType
 </a>
 </em>
 </td>
 <td>
-<em>(Optional)</em>
-<p>Type is the event type.
-If not provided, the gateway will watch all events for a resource.</p>
+<p>EventTypes is the list of event type to watch.
+Possible values are - ADD, UPDATE and DELETE.</p>
 </td>
 </tr>
 </tbody>

diff --git a/api/event-source.md b/api/event-source.md
@@ -3605,7 +3605,9 @@ Namespace where resource is deployed
 
 <p>
 
-Filter is applied on the metadata of the resource
+Filter is applied on the metadata of the resource If you apply filter,
+then the internal event informer will only monitor objects that pass the
+filter.
 
 </p>
 
@@ -3646,20 +3648,18 @@ Group of the resource
 
 <td>
 
-<code>eventType</code></br> <em>
-<a href="#argoproj.io/v1alpha1.ResourceEventType"> ResourceEventType
+<code>eventTypes</code></br> <em>
+<a href="#argoproj.io/v1alpha1.ResourceEventType"> \[\]ResourceEventType
 </a> </em>
 
 </td>
 
 <td>
 
-<em>(Optional)</em>
-
 <p>
 
-Type is the event type. If not provided, the gateway will watch all
-events for a resource.
+EventTypes is the list of event type to watch. Possible values are -
+ADD, UPDATE and DELETE.
 
 </p>
 
@@ -4775,5 +4775,4 @@ all types of events will be processed. More info at
 
 <em> Generated with <code>gen-crd-api-reference-docs</code> on git
 commit <code>1782e0f</code>. </em>
-
 </p>
diff --git a/api/gateway.md b/api/gateway.md
@@ -1322,5 +1322,4 @@ NATS refers to the subscribers over NATS protocol.
 
 <em> Generated with <code>gen-crd-api-reference-docs</code> on git
 commit <code>1782e0f</code>. </em>
-
 </p>
diff --git a/api/sensor.md b/api/sensor.md
@@ -6240,5 +6240,4 @@ VerifyCert decides whether the connection is secure or not
 
 <em> Generated with <code>gen-crd-api-reference-docs</code> on git
 commit <code>1782e0f</code>. </em>
-
 </p>
diff --git a/docs/setup/resource.md b/docs/setup/resource.md
@@ -59,7 +59,7 @@ The structure of an event dispatched by the gateway to the sensor looks like fol
         metadata:
           name: my-workflow
           labels:
-            app: my-workflow
+            name: my-workflow
         spec:
           entrypoint: whalesay
           templates:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1322,5 +1322,4 @@ NATS refers to the subscribers over NATS protocol.

		<em> Generated with <code>gen-crd-api-reference-docs</code> on git
		commit <code>1782e0f</code>. </em>

		</p>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6240,5 +6240,4 @@ VerifyCert decides whether the connection is secure or not

		<em> Generated with <code>gen-crd-api-reference-docs</code> on git
		commit <code>1782e0f</code>. </em>

		</p>