Skip to content

Commit

Permalink
Custom triggers (#493)
Browse files Browse the repository at this point in the history
* feat(custom-trigger): added proto file

* feat(custom-triggers): added custom trigger types and proto

* feat(custom-trigger): adding the implementation for the custom trigger

* feat(custom-triggers): updated api docs

* feat(custom-triggers): updated events data location

* feat(custom-triggers): add test

* feat(custom-triggers): updated gen file for sensor

* feat(custom-trigger): added custom trigger to the list of available triggers

* feat(custom-trigger): added validation for custom trigger

* feat(custom-trigger): added payload for custom trigger
  • Loading branch information
VaibhavPage authored Feb 25, 2020
1 parent 22de2c4 commit 3883e47
Show file tree
Hide file tree
Showing 40 changed files with 1,970 additions and 104 deletions.
4 changes: 2 additions & 2 deletions api/event-source.html
Original file line number Diff line number Diff line change
Expand Up @@ -722,7 +722,7 @@ <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec
<td>
<code>type</code></br>
<em>
Argo Events common.EventSourceType
github.com/argoproj/argo-events/pkg/apis/common.EventSourceType
</em>
</td>
<td>
Expand Down Expand Up @@ -2272,5 +2272,5 @@ <h3 id="argoproj.io/v1alpha1.StripeEventSource">StripeEventSource
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>02c6134</code>.
on git commit <code>b0ce469</code>.
</em></p>
5 changes: 3 additions & 2 deletions api/event-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -1397,7 +1397,8 @@ Generic event source

<td>

<code>type</code></br> <em> Argo Events common.EventSourceType </em>
<code>type</code></br> <em>
github.com/argoproj/argo-events/pkg/apis/common.EventSourceType </em>

</td>

Expand Down Expand Up @@ -4526,6 +4527,6 @@ all types of events will be processed. More info at
<p>

<em> Generated with <code>gen-crd-api-reference-docs</code> on git
commit <code>02c6134</code>. </em>
commit <code>b0ce469</code>. </em>

</p>
10 changes: 5 additions & 5 deletions api/gateway.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h3 id="argoproj.io/v1alpha1.Gateway">Gateway
<td>
<code>type</code></br>
<em>
Argo Events common.EventSourceType
github.com/argoproj/argo-events/pkg/apis/common.EventSourceType
</em>
</td>
<td>
Expand Down Expand Up @@ -186,7 +186,7 @@ <h3 id="argoproj.io/v1alpha1.Gateway">Gateway
<td>
<code>eventProtocol</code></br>
<em>
Argo Events common.EventProtocol
github.com/argoproj/argo-events/pkg/apis/common.EventProtocol
</em>
</td>
<td>
Expand Down Expand Up @@ -303,7 +303,7 @@ <h3 id="argoproj.io/v1alpha1.GatewaySpec">GatewaySpec
<td>
<code>type</code></br>
<em>
Argo Events common.EventSourceType
github.com/argoproj/argo-events/pkg/apis/common.EventSourceType
</em>
</td>
<td>
Expand Down Expand Up @@ -353,7 +353,7 @@ <h3 id="argoproj.io/v1alpha1.GatewaySpec">GatewaySpec
<td>
<code>eventProtocol</code></br>
<em>
Argo Events common.EventProtocol
github.com/argoproj/argo-events/pkg/apis/common.EventProtocol
</em>
</td>
<td>
Expand Down Expand Up @@ -669,5 +669,5 @@ <h3 id="argoproj.io/v1alpha1.Subscribers">Subscribers
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>02c6134</code>.
on git commit <code>b0ce469</code>.
</em></p>
16 changes: 9 additions & 7 deletions api/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,8 @@ configurations for the gateway

<td>

<code>type</code></br> <em> Argo Events common.EventSourceType </em>
<code>type</code></br> <em>
github.com/argoproj/argo-events/pkg/apis/common.EventSourceType </em>

</td>

Expand Down Expand Up @@ -357,8 +358,8 @@ Port on which the gateway event source processor is running on.

<td>

<code>eventProtocol</code></br> <em> Argo Events common.EventProtocol
</em>
<code>eventProtocol</code></br> <em>
github.com/argoproj/argo-events/pkg/apis/common.EventProtocol </em>

</td>

Expand Down Expand Up @@ -600,7 +601,8 @@ configurations for the gateway

<td>

<code>type</code></br> <em> Argo Events common.EventSourceType </em>
<code>type</code></br> <em>
github.com/argoproj/argo-events/pkg/apis/common.EventSourceType </em>

</td>

Expand Down Expand Up @@ -687,8 +689,8 @@ Port on which the gateway event source processor is running on.

<td>

<code>eventProtocol</code></br> <em> Argo Events common.EventProtocol
</em>
<code>eventProtocol</code></br> <em>
github.com/argoproj/argo-events/pkg/apis/common.EventProtocol </em>

</td>

Expand Down Expand Up @@ -1321,6 +1323,6 @@ NATS refers to the subscribers over NATS protocol.
<p>

<em> Generated with <code>gen-crd-api-reference-docs</code> on git
commit <code>02c6134</code>. </em>
commit <code>b0ce469</code>. </em>

</p>
111 changes: 107 additions & 4 deletions api/sensor.html
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ <h3 id="argoproj.io/v1alpha1.ArtifactLocation">ArtifactLocation
<td>
<code>s3</code></br>
<em>
Argo Events common.S3Artifact
github.com/argoproj/argo-events/pkg/apis/common.S3Artifact
</em>
</td>
<td>
Expand Down Expand Up @@ -421,6 +421,93 @@ <h3 id="argoproj.io/v1alpha1.ConfigmapArtifact">ConfigmapArtifact
</tr>
</tbody>
</table>
<h3 id="argoproj.io/v1alpha1.CustomTrigger">CustomTrigger
</h3>
<p>
(<em>Appears on:</em>
<a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>)
</p>
<p>
<p>CustomTrigger refers to the specification of the custom trigger.</p>
</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>serverURL</code></br>
<em>
string
</em>
</td>
<td>
<p>ServerURL is the url of the gRPC server that executes custom trigger</p>
</td>
</tr>
<tr>
<td>
<code>secure</code></br>
<em>
bool
</em>
</td>
<td>
<p>Secure refers to type of the connection between sensor to custom trigger gRPC</p>
</td>
</tr>
<tr>
<td>
<code>certFilePath</code></br>
<em>
string
</em>
</td>
<td>
<p>CertFilePath is path to the cert file within sensor for secure connection between sensor and custom trigger gRPC server.</p>
</td>
</tr>
<tr>
<td>
<code>serverNameOverride</code></br>
<em>
string
</em>
</td>
<td>
<p>ServerNameOverride for the secure connection between sensor and custom trigger gRPC server.</p>
</td>
</tr>
<tr>
<td>
<code>triggerBody</code></br>
<em>
string
</em>
</td>
<td>
<p>TriggerBody is the custom trigger resource specification that custom trigger gRPC server knows how to interpret.</p>
</td>
</tr>
<tr>
<td>
<code>parameters</code></br>
<em>
<a href="#argoproj.io/v1alpha1.TriggerParameter">
[]TriggerParameter
</a>
</em>
</td>
<td>
<p>Parameters is the list of parameters that is applied to resolved custom trigger trigger object.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="argoproj.io/v1alpha1.DataFilter">DataFilter
</h3>
<p>
Expand Down Expand Up @@ -635,7 +722,7 @@ <h3 id="argoproj.io/v1alpha1.EventDependencyFilter">EventDependencyFilter
<td>
<code>context</code></br>
<em>
Argo Events common.EventContext
github.com/argoproj/argo-events/pkg/apis/common.EventContext
</em>
</td>
<td>
Expand Down Expand Up @@ -1336,7 +1423,7 @@ <h3 id="argoproj.io/v1alpha1.NodeStatus">NodeStatus
<td>
<code>event</code></br>
<em>
Argo Events common.Event
github.com/argoproj/argo-events/pkg/apis/common.Event
</em>
</td>
<td>
Expand Down Expand Up @@ -2234,6 +2321,7 @@ <h3 id="argoproj.io/v1alpha1.TriggerParameter">TriggerParameter
(<em>Appears on:</em>
<a href="#argoproj.io/v1alpha1.AWSLambdaTrigger">AWSLambdaTrigger</a>,
<a href="#argoproj.io/v1alpha1.ArgoWorkflowTrigger">ArgoWorkflowTrigger</a>,
<a href="#argoproj.io/v1alpha1.CustomTrigger">CustomTrigger</a>,
<a href="#argoproj.io/v1alpha1.HTTPTrigger">HTTPTrigger</a>,
<a href="#argoproj.io/v1alpha1.OpenFaasTrigger">OpenFaasTrigger</a>,
<a href="#argoproj.io/v1alpha1.StandardK8sTrigger">StandardK8sTrigger</a>,
Expand Down Expand Up @@ -2570,9 +2658,24 @@ <h3 id="argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate
</em>
</td>
<td>
<em>(Optional)</em>
<p>AWSLambda refers to the trigger designed to invoke AWS Lambda function with with on-the-fly constructable payload.</p>
</td>
</tr>
<tr>
<td>
<code>customTrigger</code></br>
<em>
<a href="#argoproj.io/v1alpha1.CustomTrigger">
CustomTrigger
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>CustomTrigger refers to the trigger designed to connect to a gRPC trigger server and execute a custom trigger.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="argoproj.io/v1alpha1.URLArtifact">URLArtifact
Expand Down Expand Up @@ -2619,5 +2722,5 @@ <h3 id="argoproj.io/v1alpha1.URLArtifact">URLArtifact
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>02c6134</code>.
on git commit <code>b0ce469</code>.
</em></p>
Loading

0 comments on commit 3883e47

Please sign in to comment.