chore: update examples and api docs for v0.13.0-rc (argoproj#512)

icecoffee531 · Feb 26, 2020 · b9b6cb3 · b9b6cb3
1 parent 95e393b
commit b9b6cb3
Show file tree

Hide file tree

Showing 98 changed files with 192 additions and 135 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,13 +1,21 @@
 # Changelog
 
-## v0.12
+## v0.13.0-rc
++ Enriched structure for events generated by the gateways #493. Refer https://github.com/argoproj/argo-events/blob/master/pkg/apis/events/event-data.go
++ Introducing the custom triggers (Beta) #493
++ Added support for generic event source #467
++ Introducing gateway setup guides #507
++ Fix filters for the resource gateway #499
++ Fix Kafka gateway issue #490
+
+## v0.12.0
 + Added HTTP, AWS Lambda, OpenFaas triggers.
 + Support for special operations like submit, resubmit, retry, etc. for Argo workflow triggers
 + Support for Create and Update operations for K8s resource triggers.
 + Added Redis, Emitter, Stripe, NSQ, and Azure Events Hub gateways.
 + Simplified gateway subscriber logic.
 
-## v0.12-rc
+## v0.12.0-rc
 + Support Event Source as K8s custom resource #377 
 
 ## v0.11

diff --git a/api/event-source.html b/api/event-source.html
@@ -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>b0ce469</code>.
+on git commit <code>95e393b</code>.
 </em></p>
diff --git a/api/event-source.md b/api/event-source.md
@@ -4527,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>b0ce469</code>. </em>
+commit <code>95e393b</code>. </em>
 
 </p>
diff --git a/api/gateway.html b/api/gateway.html
@@ -190,7 +190,8 @@ <h3 id="argoproj.io/v1alpha1.Gateway">Gateway
 </em>
 </td>
 <td>
-<p>EventProtocol is the underlying protocol used to send events from gateway to watchers(components interested in listening to event from this gateway)</p>
+<p>EventProtocol is the underlying protocol used to send events
+from gateway to watchers(components interested in listening to event from this gateway)</p>
 </td>
 </tr>
 <tr>
@@ -357,7 +358,8 @@ <h3 id="argoproj.io/v1alpha1.GatewaySpec">GatewaySpec
 </em>
 </td>
 <td>
-<p>EventProtocol is the underlying protocol used to send events from gateway to watchers(components interested in listening to event from this gateway)</p>
+<p>EventProtocol is the underlying protocol used to send events
+from gateway to watchers(components interested in listening to event from this gateway)</p>
 </td>
 </tr>
 <tr>
@@ -669,5 +671,5 @@ <h3 id="argoproj.io/v1alpha1.Subscribers">Subscribers
 <hr/>
 <p><em>
 Generated with <code>gen-crd-api-reference-docs</code>
-on git commit <code>b0ce469</code>.
+on git commit <code>95e393b</code>.
 </em></p>
diff --git a/api/gateway.md b/api/gateway.md
@@ -1323,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>b0ce469</code>. </em>
+commit <code>95e393b</code>. </em>
 
 </p>
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -2,7 +2,7 @@
   "swagger": "2.0",
   "info": {
     "title": "Argo",
-    "version": "v0.12"
+    "version": "v0.13.0-rc"
   },
   "paths": {},
   "definitions": {

diff --git a/api/sensor.html b/api/sensor.html
@@ -506,6 +506,19 @@ <h3 id="argoproj.io/v1alpha1.CustomTrigger">CustomTrigger
 <p>Parameters is the list of parameters that is applied to resolved custom trigger trigger object.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>payload</code></br>
+<em>
+<a href="#argoproj.io/v1alpha1.TriggerParameter">
+[]TriggerParameter
+</a>
+</em>
+</td>
+<td>
+<p>Payload is the list of key-value extracted from an event payload to construct the request payload.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="argoproj.io/v1alpha1.DataFilter">DataFilter
@@ -1645,7 +1658,8 @@ <h3 id="argoproj.io/v1alpha1.Sensor">Sensor
 </em>
 </td>
 <td>
-<p>Template contains sensor pod specification. For more information, read <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core</a></p>
+<p>Template contains sensor pod specification. For more information,
+read <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core</a>.</p>
 </td>
 </tr>
 <tr>
@@ -1717,7 +1731,8 @@ <h3 id="argoproj.io/v1alpha1.Sensor">Sensor
 </em>
 </td>
 <td>
-<p>ServiceAnnotations refers to annotations to be set for the service generated</p>
+<p>ServiceAnnotations refers to annotations to be set
+for the service generated</p>
 </td>
 </tr>
 </table>
@@ -1836,7 +1851,8 @@ <h3 id="argoproj.io/v1alpha1.SensorSpec">SensorSpec
 </em>
 </td>
 <td>
-<p>Template contains sensor pod specification. For more information, read <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core</a></p>
+<p>Template contains sensor pod specification. For more information,
+read <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core</a>.</p>
 </td>
 </tr>
 <tr>
@@ -1908,7 +1924,8 @@ <h3 id="argoproj.io/v1alpha1.SensorSpec">SensorSpec
 </em>
 </td>
 <td>
-<p>ServiceAnnotations refers to annotations to be set for the service generated</p>
+<p>ServiceAnnotations refers to annotations to be set
+for the service generated</p>
 </td>
 </tr>
 </tbody>
@@ -2722,5 +2739,5 @@ <h3 id="argoproj.io/v1alpha1.URLArtifact">URLArtifact
 <hr/>
 <p><em>
 Generated with <code>gen-crd-api-reference-docs</code>
-on git commit <code>b0ce469</code>.
+on git commit <code>95e393b</code>.
 </em></p>
diff --git a/api/sensor.md b/api/sensor.md
@@ -1030,6 +1030,29 @@ trigger trigger object.
 
 </tr>
 
+<tr>
+
+<td>
+
+<code>payload</code></br> <em>
+<a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter
+</a> </em>
+
+</td>
+
+<td>
+
+<p>
+
+Payload is the list of key-value extracted from an event payload to
+construct the request payload.
+
+</p>
+
+</td>
+
+</tr>
+
 </tbody>
 
 </table>
@@ -3337,7 +3360,7 @@ Kubernetes core/v1.PodTemplateSpec </a> </em>
 <p>
 
 Template contains sensor pod specification. For more information, read
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/\#pod-v1-core</a>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/\#pod-v1-core</a>.
 
 </p>
 
@@ -3702,7 +3725,7 @@ Kubernetes core/v1.PodTemplateSpec </a> </em>
 <p>
 
 Template contains sensor pod specification. For more information, read
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/\#pod-v1-core</a>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#pod-v1-core">https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/\#pod-v1-core</a>.
 
 </p>
 
@@ -5479,6 +5502,6 @@ VerifyCert decides whether the connection is secure or not
 <p>
 
 <em> Generated with <code>gen-crd-api-reference-docs</code> on git
-commit <code>b0ce469</code>. </em>
+commit <code>95e393b</code>. </em>
 
 </p>
diff --git a/examples/gateways/amqp.yaml b/examples/gateways/amqp.yaml
@@ -16,12 +16,12 @@ spec:
         gateway-name: amqp-gateway
     spec:
       containers:
-        - name: gateway-client:v0.12
+        - name: gateway-client:v0.13.0-rc
           image: argoproj/gateway-client
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: amqp-events
-          image: argoproj/amqp-gateway:v0.12
+          image: argoproj/amqp-gateway:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/amqp-gateway"]
       serviceAccountName: argo-events-sa

diff --git a/examples/gateways/aws-sns.yaml b/examples/gateways/aws-sns.yaml
@@ -16,12 +16,12 @@ spec:
         gateway-name: aws-sns-gateway
     spec:
       containers:
-        - name: gateway-client:v0.12
+        - name: gateway-client:v0.13.0-rc
           image: argoproj/gateway-client
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: aws-sns-events
-          image: argoproj/aws-sns-gateway:v0.12
+          image: argoproj/aws-sns-gateway:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/aws-sns-gateway"]
       serviceAccountName: argo-events-sa

diff --git a/examples/gateways/aws-sqs.yaml b/examples/gateways/aws-sqs.yaml
@@ -18,11 +18,11 @@ spec:
     spec:
       containers:
         - name: gateway-client
-          image: argoproj/gateway-client:v0.12
+          image: argoproj/gateway-client:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: aws-sqs-events
-          image: argoproj/aws-sqs-gateway:v0.12
+          image: argoproj/aws-sqs-gateway:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/aws-sqs-gateway"]
       serviceAccountName: argo-events-sa

diff --git a/examples/gateways/azure-events-hub.yaml b/examples/gateways/azure-events-hub.yaml
@@ -17,11 +17,11 @@ spec:
     spec:
       containers:
         - name: gateway-client
-          image: argoproj/gateway-client:v0.12
+          image: argoproj/gateway-client:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: azure-events-hub-events
-          image: argoproj/azure-events-hub-gateway:v0.12
+          image: argoproj/azure-events-hub-gateway:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/azure-events-hub-gateway"]
       serviceAccountName: argo-events-sa

diff --git a/examples/gateways/calendar.yaml b/examples/gateways/calendar.yaml
@@ -17,11 +17,11 @@ spec:
     spec:
       containers:
         - name: gateway-client
-          image: argoproj/gateway-client:v0.12
+          image: argoproj/gateway-client:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: calendar-events
-          image: argoproj/calendar-gateway:v0.12
+          image: argoproj/calendar-gateway:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/calendar-gateway"]
       serviceAccountName: argo-events-sa

diff --git a/examples/gateways/emitter.yaml b/examples/gateways/emitter.yaml
@@ -17,11 +17,11 @@ spec:
     spec:
       containers:
         - name: gateway-client
-          image: argoproj/gateway-client:v0.12
+          image: argoproj/gateway-client:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: emitter-events
-          image: argoproj/emitter-gateway:v0.12
+          image: argoproj/emitter-gateway:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/emitter-gateway"]
       serviceAccountName: argo-events-sa

diff --git a/examples/gateways/file.yaml b/examples/gateways/file.yaml
@@ -17,11 +17,11 @@ spec:
     spec:
       containers:
         - name: gateway-client
-          image: argoproj/gateway-client:v0.12
+          image: argoproj/gateway-client:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: file-events
-          image: argoproj/file-gateway:v0.12
+          image: argoproj/file-gateway:v0.13.0-rc
           imagePullPolicy: Always
           volumeMounts:
             - mountPath: /bin

diff --git a/examples/gateways/gcp-pubsub.yaml b/examples/gateways/gcp-pubsub.yaml
@@ -18,11 +18,11 @@ spec:
     spec:
       containers:
         - name: gateway-client
-          image: argoproj/gateway-client:v0.12
+          image: argoproj/gateway-client:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: gcp-pubsub-events
-          image: argoproj/gcp-pubsub-gateway:v0.12
+          image: argoproj/gcp-pubsub-gateway:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gcp-pubsub-gateway"]
           volumeMounts:

diff --git a/examples/gateways/github.yaml b/examples/gateways/github.yaml
@@ -17,11 +17,11 @@ spec:
     spec:
       containers:
         - name: gateway-client
-          image: argoproj/gateway-client:v0.12
+          image: argoproj/gateway-client:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: github-events
-          image: argoproj/github-gateway:v0.12
+          image: argoproj/github-gateway:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/github-gateway"]
       serviceAccountName: argo-events-sa

diff --git a/examples/gateways/gitlab.yaml b/examples/gateways/gitlab.yaml
@@ -18,11 +18,11 @@ spec:
     spec:
       containers:
         - name: gateway-client
-          image: argoproj/gateway-client:v0.12
+          image: argoproj/gateway-client:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: gitlab-events
-          image: argoproj/gitlab-gateway:v0.12
+          image: argoproj/gitlab-gateway:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gitlab-gateway"]
       serviceAccountName: argo-events-sa

diff --git a/examples/gateways/hdfs.yaml b/examples/gateways/hdfs.yaml
@@ -18,11 +18,11 @@ spec:
     spec:
       containers:
         - name: gateway-client
-          image: argoproj/gateway-client:v0.12
+          image: argoproj/gateway-client:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: hdfs-events
-          image: argoproj/hdfs-gateway:v0.12
+          image: argoproj/hdfs-gateway:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/hdfs-gateway"]
       serviceAccountName: argo-events-sa

diff --git a/examples/gateways/kafka.yaml b/examples/gateways/kafka.yaml
@@ -18,11 +18,11 @@ spec:
     spec:
       containers:
         - name: gateway-client
-          image: argoproj/gateway-client:v0.12
+          image: argoproj/gateway-client:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: kafka-events
-          image: argoproj/kafka-gateway:v0.12
+          image: argoproj/kafka-gateway:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/kafka-gateway"]
       serviceAccountName: argo-events-sa

diff --git a/examples/gateways/minio.yaml b/examples/gateways/minio.yaml
@@ -17,11 +17,11 @@ spec:
     spec:
       containers:
         - name: gateway-client
-          image: argoproj/gateway-client:v0.12
+          image: argoproj/gateway-client:v0.13.0-rc
           imagePullPolicy: Always
           command: ["/bin/gateway-client"]
         - name: minio-events
-          image: argoproj/artifact-gateway:v0.12
+          image: argoproj/artifact-gateway:v0.13.0-rc
           imagePullPolicy: Always
       serviceAccountName: argo-events-sa
   subscribers: