feat: Replace gatewayName with eventSourceName in Sensor dependencies

This is the first step of merging Gateway to EventSource.
argoproj · Jun 9, 2020 · 0a3100f · 0a3100f
1 parent 5eed0c4
commit 0a3100f
Show file tree

Hide file tree

Showing 83 changed files with 167 additions and 101 deletions.
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -1357,19 +1357,24 @@
       "required": [
         "name",
         "gatewayName",
+        "eventSourceName",
         "eventName"
       ],
       "properties": {
         "eventName": {
           "description": "EventName is the name of the event",
           "type": "string"
         },
+        "eventSourceName": {
+          "description": "EventSourceName is the name of EventSource that Sensor depends on",
+          "type": "string"
+        },
         "filters": {
           "description": "Filters and rules governing toleration of success and constraints on the context and data of an event",
           "$ref": "#/definitions/io.argoproj.sensor.v1alpha1.EventDependencyFilter"
         },
         "gatewayName": {
-          "description": "GatewayName is the name of the gateway from whom the event is received",
+          "description": "GatewayName is the name of the gateway from whom the event is received DEPRECATED: Use EventSourceName instead.",
           "type": "string"
         },
         "name": {

diff --git a/api/sensor.html b/api/sensor.html
@@ -886,7 +886,19 @@ <h3 id="argoproj.io/v1alpha1.EventDependency">EventDependency
 </em>
 </td>
 <td>
-<p>GatewayName is the name of the gateway from whom the event is received</p>
+<p>GatewayName is the name of the gateway from whom the event is received
+DEPRECATED: Use EventSourceName instead.</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>eventSourceName</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<p>EventSourceName is the name of EventSource that Sensor depends on</p>
 </td>
 </tr>
 <tr>

diff --git a/api/sensor.md b/api/sensor.md
@@ -1798,6 +1798,27 @@ Name is a unique name of this dependency
 <p>
 
 GatewayName is the name of the gateway from whom the event is received
+DEPRECATED: Use EventSourceName instead.
+
+</p>
+
+</td>
+
+</tr>
+
+<tr>
+
+<td>
+
+<code>eventSourceName</code></br> <em> string </em>
+
+</td>
+
+<td>
+
+<p>
+
+EventSourceName is the name of EventSource that Sensor depends on
 
 </p>
 

diff --git a/docs/demo/notebooks.md b/docs/demo/notebooks.md
@@ -94,7 +94,7 @@ In this demo, we are going to set up an image processing pipeline using 2 notebo
             serviceAccountName: argo-events-sa
           dependencies:
             - name: test-dep
-              gatewayName: webhook-gateway
+              eventSourceName: webhook-event-source
               eventName: example
           subscription:
             http:

diff --git a/docs/triggers/argo-workflow.md b/docs/triggers/argo-workflow.md
@@ -33,7 +33,7 @@ Argo workflow is K8s custom resource which help orchestrating parallel jobs on K
             serviceAccountName: argo-events-sa
           dependencies:
             - name: test-dep
-              gatewayName: webhook-gateway
+              eventSourceName: webhook-event-source
               eventName: example
           subscription:
             http:

diff --git a/docs/triggers/build-your-own-trigger.md b/docs/triggers/build-your-own-trigger.md
@@ -56,7 +56,7 @@ Let's look at the following sensor,
               serviceAccountName: argo-events-sa
           dependencies:
             - name: test-dep
-              gatewayName: webhook-gateway
+              eventSourceName: webhook-event-source
               eventName: example
           subscription:
             http:

diff --git a/docs/triggers/http-trigger.md b/docs/triggers/http-trigger.md
@@ -188,7 +188,7 @@ to invoke OpenFaas function.
             serviceAccountName: argo-events-sa
           dependencies:
             - name: test-dep
-              gatewayName: redis-gateway
+              eventSourceName: redis-event-source
               eventName: example
           subscription:
             http:
@@ -240,7 +240,7 @@ Similar to REST API calls, you can easily invoke Kubeless functions using HTTP t
             serviceAccountName: argo-events-sa
           dependencies:
             - name: test-dep
-              gatewayName: nats-gateway
+              eventSourceName: nats-event-source
               eventName: example
           subscription:
             http:

diff --git a/docs/triggers/k8s-object-trigger.md b/docs/triggers/k8s-object-trigger.md
@@ -36,7 +36,7 @@ set up event-driven pipelines for existing workloads.
             serviceAccountName: argo-events-sa
           dependencies:
             - name: test-dep
-              gatewayName: webhook-gateway
+              eventSourceName: webhook-event-source
               eventName: example
           subscription:
             http:

diff --git a/docs/triggers/kafka-trigger.md b/docs/triggers/kafka-trigger.md
@@ -24,7 +24,7 @@ The Kafka trigger specification is available [here](https://github.com/argoproj/
             serviceAccountName: argo-events-sa
           dependencies:
             - name: test-dep
-              gatewayName: minio-gateway
+              eventSourceName: minio-event-source
               eventName: example
           subscription:
             http:

diff --git a/docs/triggers/nats-trigger.md b/docs/triggers/nats-trigger.md
@@ -24,7 +24,7 @@ The NATS trigger specification is available [here](https://github.com/argoproj/a
             serviceAccountName: argo-events-sa
           dependencies:
             - name: test-dep
-              gatewayName: minio-gateway
+              eventSourceName: minio-event-source
               eventName: example
           subscription:
             http:

diff --git a/docs/tutorials/02-parameterization.md b/docs/tutorials/02-parameterization.md
@@ -24,9 +24,9 @@ The structure of the event the Webhook sensor receives from the gateway looks li
 
         {
             "context": {
-              "type": "type_of_gateway",
+              "type": "type_of_eventsource",
               "specVersion": "cloud_events_version",
-              "source": "name_of_the_gateway",
+              "source": "name_of_the_eventsource",
               "eventID": "unique_event_id",
               "time": "event_time",
               "dataContentType": "type_of_data",
@@ -193,9 +193,9 @@ Consider the event the sensor received has format like,
 
         {
             "context": {
-              "type": "type_of_gateway",
+              "type": "type_of_eventsource",
               "specVersion": "cloud_events_version",
-              "source": "name_of_the_gateway",
+              "source": "name_of_the_eventsource",
               "eventID": "unique_event_id",
               "time": "event_time",
               "dataContentType": "type_of_data",

diff --git a/docs/tutorials/07-filters.md b/docs/tutorials/07-filters.md
@@ -20,9 +20,9 @@ payload structure as,
 
         {
             "context": {
-              "type": "type_of_gateway",
+              "type": "type_of_eventsource",
               "specVersion": "cloud_events_version",
-              "source": "name_of_the_gateway",
+              "source": "name_of_the_eventsource",
               "eventID": "unique_event_id",
               "time": "event_time",
               "dataContentType": "type_of_data",

diff --git a/docs/tutorials/09-events-over-nats.md b/docs/tutorials/09-events-over-nats.md
@@ -110,7 +110,7 @@ Up until now, you have seen the gateway dispatch events to sensor over HTTP. In
             serviceAccountName: argo-events-sa
           dependencies:
             - name: test-dep
-              gatewayName: webhook-gateway
+              eventSourceName: webhook-event-source
               eventName: example
           subscription:
             nats:
@@ -214,7 +214,7 @@ You can easily set up a gateway to send events over both HTTP and NATS,
             serviceAccountName: argo-events-sa
           dependencies:
             - name: test-dep
-              gatewayName: webhook-gateway
+              eventSourceName: webhook-event-source
               eventName: example
           subscription:
             http:

diff --git a/examples/sensors/amqp.yaml b/examples/sensors/amqp.yaml
@@ -10,7 +10,7 @@ spec:
       port: 9300
   dependencies:
     - name: test-dep
-      gatewayName: amqp
+      eventSourceName: amqp-event-source
       eventName: example
   triggers:
     - template:

diff --git a/examples/sensors/aws-lambda-trigger.yaml b/examples/sensors/aws-lambda-trigger.yaml
@@ -7,7 +7,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: webhook
+      eventSourceName: webhook-event-source
       eventName: example
   subscription:
     http:

diff --git a/examples/sensors/aws-sns.yaml b/examples/sensors/aws-sns.yaml
@@ -10,7 +10,7 @@ spec:
       port: 9300
   dependencies:
     - name: test-dep
-      gatewayName: aws-sns
+      eventSourceName: aws-sns-event-source
       eventName: example
   triggers:
     - template:

diff --git a/examples/sensors/aws-sqs.yaml b/examples/sensors/aws-sqs.yaml
@@ -10,7 +10,7 @@ spec:
       port: 9300
   dependencies:
     - name: test-dep
-      gatewayName: aws-sqs
+      eventSourceName: aws-sqs-event-source
       eventName: example
   triggers:
     - template:

diff --git a/examples/sensors/azure-events-hub.yaml b/examples/sensors/azure-events-hub.yaml
@@ -10,7 +10,7 @@ spec:
       port: 9300
   dependencies:
     - name: test-dep
-      gatewayName: azure-events-hub
+      eventSourceName: azure-events-hub-event-source
       eventName: example
   triggers:
     - template:

diff --git a/examples/sensors/calendar.yaml b/examples/sensors/calendar.yaml
@@ -7,7 +7,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: calendar
+      eventSourceName: calendar-event-source
       eventName: example-with-interval
   subscription:
     http:

diff --git a/examples/sensors/complete-trigger-parameterization.yaml b/examples/sensors/complete-trigger-parameterization.yaml
@@ -25,7 +25,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: webhook
+      eventSourceName: webhook-event-source
       eventName: example
   subscription:
     http:

diff --git a/examples/sensors/context-filter-webhook.yaml b/examples/sensors/context-filter-webhook.yaml
@@ -7,7 +7,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: webhook
+      eventSourceName: webhook-event-source
       eventName: example
       # The filter is applied on the context of the event.
       # The trigger will be executed only of the event passes the filter

diff --git a/examples/sensors/custom-trigger.yaml b/examples/sensors/custom-trigger.yaml
@@ -7,7 +7,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: webhook
+      eventSourceName: webhook-event-source
       eventName: example
   subscription:
     http:

diff --git a/examples/sensors/data-filter-comparator-webhook.yaml b/examples/sensors/data-filter-comparator-webhook.yaml
@@ -7,7 +7,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: webhook
+      eventSourceName: webhook-event-source
       eventName: example
       filters:
         name: data-filter

diff --git a/examples/sensors/data-filter-value-webhook.yaml b/examples/sensors/data-filter-value-webhook.yaml
@@ -7,7 +7,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: webhook
+      eventSourceName: webhook-event-source
       eventName: example
       filters:
         name: data-filter

diff --git a/examples/sensors/data-filter-webhook.yaml b/examples/sensors/data-filter-webhook.yaml
@@ -7,7 +7,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: webhook
+      eventSourceName: webhook-event-source
       eventName: example
       filters:
         name: data-filter

diff --git a/examples/sensors/dependencies-circuit.yaml b/examples/sensors/dependencies-circuit.yaml
@@ -8,10 +8,10 @@ spec:
   # defines list of all events sensor will accept
   dependencies:
     - name: test-dep
-      gatewayName: webhook
+      eventSourceName: webhook-event-source
       eventName: example
     - name: test-dep-foo
-      gatewayName: webhook
+      eventSourceName: webhook-event-source
       eventName: example-foo
 
   # group event dependencies

diff --git a/examples/sensors/emitter.yaml b/examples/sensors/emitter.yaml
@@ -10,7 +10,7 @@ spec:
       port: 9300
   dependencies:
     - name: test-dep
-      gatewayName: emitter
+      eventSourceName: emitter-event-source
       eventName: example
   triggers:
     - template:

diff --git a/examples/sensors/file.yaml b/examples/sensors/file.yaml
@@ -7,7 +7,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: file
+      eventSourceName: file-event-source
       eventName: example
   subscription:
     http:

diff --git a/examples/sensors/gcp-pubsub.yaml b/examples/sensors/gcp-pubsub.yaml
@@ -10,7 +10,7 @@ spec:
       port: 9300
   dependencies:
     - name: test-dep
-      gatewayName: gcp-pubsub
+      eventSourceName: gcp-pubsub-event-source
       eventName: example
   triggers:
     - template:

diff --git a/examples/sensors/github.yaml b/examples/sensors/github.yaml
@@ -7,7 +7,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: github
+      eventSourceName: github-event-source
       eventName: example
   subscription:
     http:

diff --git a/examples/sensors/gitlab.yaml b/examples/sensors/gitlab.yaml
@@ -10,7 +10,7 @@ spec:
       port: 9300
   dependencies:
     - name: test-dep
-      gatewayName: gitlab
+      eventSourceName: gitlab-event-source
       eventName: example
   triggers:
     - template:

diff --git a/examples/sensors/hdfs.yaml b/examples/sensors/hdfs.yaml
@@ -7,7 +7,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: hdfs
+      eventSourceName: hdfs-event-source
       eventName: example
   subscription:
     http:

diff --git a/examples/sensors/http-trigger.yaml b/examples/sensors/http-trigger.yaml
@@ -7,7 +7,7 @@ spec:
     serviceAccountName: argo-events-sa
   dependencies:
     - name: test-dep
-      gatewayName: minio
+      eventSourceName: minio-event-source
       eventName: example
   subscription:
     http:

diff --git a/examples/sensors/kafka.yaml b/examples/sensors/kafka.yaml
@@ -10,7 +10,7 @@ spec:
       port: 9300
   dependencies:
     - name: test-dep
-      gatewayName: kafka
+      eventSourceName: kafka-event-source
       eventName: example
   triggers:
     - template: