mirror of https://github.com/knative/docs.git
1903 lines
194 KiB
XML
1903 lines
194 KiB
XML
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||
<channel>
|
||
<title>Knative – Knative Eventing</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/</link>
|
||
<description>Recent content in Knative Eventing on Knative</description>
|
||
<generator>Hugo -- gohugo.io</generator>
|
||
|
||
<atom:link href="https://knative.dev/v0.23-docs/eventing/index.xml" rel="self" type="application/rss+xml" />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Getting Started with Knative Eventing</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/getting-started/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/getting-started/</guid>
|
||
<description>
|
||
|
||
|
||
<p>After you install Knative Eventing, you can create, send, and verify events.
|
||
This guide shows how you can use a basic workflow for managing events.</p>
|
||
<p>Before you start to manage events, you must create the objects needed to
|
||
transport the events.</p>
|
||
<h2 id="creating-a-knative-eventing-namespace">Creating a Knative Eventing namespace</h2>
|
||
<p>Namespaces are used to group together and organize your Knative resources.</p>
|
||
<!--TODO: Add documentation about namespaces to core docs?-->
|
||
<p>Create a new namespace called <code>event-example</code> by entering the following command:</p>
|
||
<pre><code>kubectl create namespace event-example
|
||
</code></pre><h2 id="adding-a-broker-to-the-namespace">Adding a broker to the namespace</h2>
|
||
<p>The <a href="../broker">broker</a> allows you to route events to different event sinks or consumers.</p>
|
||
<ol>
|
||
<li>
|
||
<p>Add a broker named <code>default</code> to your namespace by entering the following command:</p>
|
||
<pre><code>kubectl create -f - &lt;&lt;EOF
|
||
apiVersion: eventing.knative.dev/v1
|
||
kind: broker
|
||
metadata:
|
||
name: default
|
||
namespace: event-example
|
||
EOF
|
||
</code></pre></li>
|
||
<li>
|
||
<p>Verify that the broker is working correctly, by entering the following command:</p>
|
||
<pre><code>kubectl -n event-example get broker default
|
||
</code></pre><p>This shows information about your broker. If the broker is working correctly, it shows a <code>READY</code> status of <code>True</code>:</p>
|
||
<pre><code>NAME READY REASON URL AGE
|
||
default True http://broker-ingress.knative-eventing.svc.cluster.local/event-example/default 1m
|
||
</code></pre><p>If <code>READY</code> is <code>False</code>, wait a few moments and then run the command again.
|
||
If you continue to receive the <code>False</code> status, see the <a href="../debugging/">Debugging Guide</a> to troubleshoot the issue.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 id="creating-event-consumers">Creating event consumers</h2>
|
||
<p>In this step, you create two event consumers, <code>hello-display</code> and <code>goodbye-display</code>, to
|
||
demonstrate how you can configure your event producers to target a specific consumer.</p>
|
||
<ol>
|
||
<li>
|
||
<p>To deploy the <code>hello-display</code> consumer to your cluster, run the following
|
||
command:</p>
|
||
<pre><code>kubectl -n event-example apply -f - &lt;&lt; EOF
|
||
apiVersion: apps/v1
|
||
kind: Deployment
|
||
metadata:
|
||
name: hello-display
|
||
spec:
|
||
replicas: 1
|
||
selector:
|
||
matchLabels: &amp;labels
|
||
app: hello-display
|
||
template:
|
||
metadata:
|
||
labels: *labels
|
||
spec:
|
||
containers:
|
||
- name: event-display
|
||
image: gcr.io/knative-releases/knative.dev/eventing/cmd/event_display
|
||
|
||
---
|
||
|
||
kind: Service
|
||
apiVersion: v1
|
||
metadata:
|
||
name: hello-display
|
||
spec:
|
||
selector:
|
||
app: hello-display
|
||
ports:
|
||
- protocol: TCP
|
||
port: 80
|
||
targetPort: 8080
|
||
EOF
|
||
</code></pre></li>
|
||
<li>
|
||
<p>To deploy the <code>goodbye-display</code> consumer to your cluster, run the following
|
||
command:</p>
|
||
<pre><code>kubectl -n event-example apply -f - &lt;&lt; EOF
|
||
apiVersion: apps/v1
|
||
kind: Deployment
|
||
metadata:
|
||
name: goodbye-display
|
||
spec:
|
||
replicas: 1
|
||
selector:
|
||
matchLabels: &amp;labels
|
||
app: goodbye-display
|
||
template:
|
||
metadata:
|
||
labels: *labels
|
||
spec:
|
||
containers:
|
||
- name: event-display
|
||
# Source code: https://github.com/knative/eventing/tree/main/cmd/event_display
|
||
image: gcr.io/knative-releases/knative.dev/eventing/cmd/event_display
|
||
|
||
---
|
||
|
||
kind: Service
|
||
apiVersion: v1
|
||
metadata:
|
||
name: goodbye-display
|
||
spec:
|
||
selector:
|
||
app: goodbye-display
|
||
ports:
|
||
- protocol: TCP
|
||
port: 80
|
||
targetPort: 8080
|
||
EOF
|
||
</code></pre></li>
|
||
<li>
|
||
<p>Verify that the event consumers are working by entering the following command:</p>
|
||
<pre><code>kubectl -n event-example get deployments hello-display goodbye-display
|
||
</code></pre><p>This lists the <code>hello-display</code> and <code>goodbye-display</code> consumers that you
|
||
deployed:</p>
|
||
<pre><code>NAME READY UP-TO-DATE AVAILABLE AGE
|
||
hello-display 1/1 1 1 26s
|
||
goodbye-display 1/1 1 1 16s
|
||
</code></pre><p>The number of replicas in the <strong>READY</strong> column should match the number of replicas in the <strong>AVAILABLE</strong> column.
|
||
If the numbers do not match, see the <a href="../debugging/">Debugging Guide</a> to troubleshoot the issue.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 id="creating-triggers">Creating triggers</h2>
|
||
<p>A <a href="../broker/triggers">trigger</a> defines the events that each event consumer receives.
|
||
Brokers use triggers to forward events to the correct consumers.
|
||
Each trigger can specify a filter that enables selection of relevant events based on the Cloud Event context attributes.</p>
|
||
<ol>
|
||
<li>
|
||
<p>Create a trigger by entering the following command:</p>
|
||
<pre><code>kubectl -n event-example apply -f - &lt;&lt; EOF
|
||
apiVersion: eventing.knative.dev/v1
|
||
kind: Trigger
|
||
metadata:
|
||
name: hello-display
|
||
spec:
|
||
broker: default
|
||
filter:
|
||
attributes:
|
||
type: greeting
|
||
subscriber:
|
||
ref:
|
||
apiVersion: v1
|
||
kind: Service
|
||
name: hello-display
|
||
EOF
|
||
</code></pre><p>The command creates a trigger that sends all events of type <code>greeting</code> to
|
||
your event consumer named <code>hello-display</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p>To add a second trigger, enter the following command:</p>
|
||
<pre><code>kubectl -n event-example apply -f - &lt;&lt; EOF
|
||
apiVersion: eventing.knative.dev/v1
|
||
kind: Trigger
|
||
metadata:
|
||
name: goodbye-display
|
||
spec:
|
||
broker: default
|
||
filter:
|
||
attributes:
|
||
source: sendoff
|
||
subscriber:
|
||
ref:
|
||
apiVersion: v1
|
||
kind: Service
|
||
name: goodbye-display
|
||
EOF
|
||
</code></pre><p>The command creates a trigger that sends all events of source <code>sendoff</code> to
|
||
your event consumer named <code>goodbye-display</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p>Verify that the triggers are working correctly by running the following
|
||
command:</p>
|
||
<pre><code>kubectl -n event-example get triggers
|
||
</code></pre><p>This returns the <code>hello-display</code> and <code>goodbye-display</code> triggers that you
|
||
created:</p>
|
||
<pre><code>NAME READY REASON BROKER SUBSCRIBER_URI AGE
|
||
goodbye-display True default http://goodbye-display.event-example.svc.cluster.local/ 9s
|
||
hello-display True default http://hello-display.event-example.svc.cluster.local/ 16s
|
||
</code></pre><p>If the triggers are correctly configured, they will be ready and pointing to the correct broker (<code>default</code>) and <code>SUBSCRIBER_URI</code>.</p>
|
||
<p>The <code>SUBSCRIBER_URI</code> has a value similar to <code>triggerName.namespaceName.svc.cluster.local</code>.
|
||
The exact value depends on the broker implementation.
|
||
If this value looks incorrect, see the <a href="../debugging/">Debugging Guide</a> to troubleshoot the issue.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 id="creating-a-pod-as-an-event-producer">Creating a pod as an event producer</h2>
|
||
<p>This guide uses <code>curl</code> commands to manually send individual events as HTTP requests to the broker, and demonstrate how these events are received by the correct event consumer.</p>
|
||
<p>The broker can only be accessed from within the cluster where Knative Eventing is installed. You must create a pod within that cluster to act as an event producer that will execute the <code>curl</code> commands.</p>
|
||
<p>To create a pod, enter the following command:</p>
|
||
<pre><code>kubectl -n event-example apply -f - &lt;&lt; EOF
|
||
apiVersion: v1
|
||
kind: Pod
|
||
metadata:
|
||
labels:
|
||
run: curl
|
||
name: curl
|
||
spec:
|
||
containers:
|
||
# This could be any image that we can SSH into and has curl.
|
||
- image: radial/busyboxplus:curl
|
||
imagePullPolicy: IfNotPresent
|
||
name: curl
|
||
resources: {}
|
||
stdin: true
|
||
terminationMessagePath: /dev/termination-log
|
||
terminationMessagePolicy: File
|
||
tty: true
|
||
EOF
|
||
</code></pre><h2 id="sending-events-to-the-broker">Sending events to the broker</h2>
|
||
<ol>
|
||
<li>
|
||
<p>SSH into the pod by running the following command:</p>
|
||
<pre><code>kubectl -n event-example attach curl -it
|
||
</code></pre><p>You will see a prompt similar to the following:</p>
|
||
<pre><code>Defaulting container name to curl.
|
||
Use 'kubectl describe pod/ -n event-example' to see all of the containers in this pod.
|
||
If you don't see a command prompt, try pressing enter.
|
||
[ root@curl:/ ]$
|
||
</code></pre></li>
|
||
<li>
|
||
<p>Make a HTTP request to the broker. To show the various types of events you can send, you will make three requests:</p>
|
||
<ul>
|
||
<li>
|
||
<p>To make the first request, which creates an event that has the <code>type</code>
|
||
<code>greeting</code>, run the following in the SSH terminal:</p>
|
||
<pre><code>curl -v &quot;http://broker-ingress.knative-eventing.svc.cluster.local/event-example/default&quot; \
|
||
-X POST \
|
||
-H &quot;Ce-Id: say-hello&quot; \
|
||
-H &quot;Ce-Specversion: 1.0&quot; \
|
||
-H &quot;Ce-Type: greeting&quot; \
|
||
-H &quot;Ce-Source: not-sendoff&quot; \
|
||
-H &quot;Content-Type: application/json&quot; \
|
||
-d '{&quot;msg&quot;:&quot;Hello Knative!&quot;}'
|
||
</code></pre><p>When the broker receives your event, <code>hello-display</code> will activate and send
|
||
it to the event consumer of the same name.
|
||
If the event has been received, you will receive a <code>202 Accepted</code> response
|
||
similar to the one below:</p>
|
||
<pre><code>&lt; HTTP/1.1 202 Accepted
|
||
&lt; Content-Length: 0
|
||
&lt; Date: Mon, 12 Aug 2019 19:48:18 GMT
|
||
</code></pre></li>
|
||
<li>
|
||
<p>To make the second request, which creates an event that has the <code>source</code>
|
||
<code>sendoff</code>, run the following in the SSH terminal:</p>
|
||
<pre><code>curl -v &quot;http://broker-ingress.knative-eventing.svc.cluster.local/event-example/default&quot; \
|
||
-X POST \
|
||
-H &quot;Ce-Id: say-goodbye&quot; \
|
||
-H &quot;Ce-Specversion: 1.0&quot; \
|
||
-H &quot;Ce-Type: not-greeting&quot; \
|
||
-H &quot;Ce-Source: sendoff&quot; \
|
||
-H &quot;Content-Type: application/json&quot; \
|
||
-d '{&quot;msg&quot;:&quot;Goodbye Knative!&quot;}'
|
||
</code></pre><p>When the broker receives your event, <code>goodbye-display</code> will activate and
|
||
send the event to the event consumer of the same name.
|
||
If the event has been received, you will receive a <code>202 Accepted</code> response
|
||
similar to the one below:</p>
|
||
<pre><code>&lt; HTTP/1.1 202 Accepted
|
||
&lt; Content-Length: 0
|
||
&lt; Date: Mon, 12 Aug 2019 19:48:18 GMT
|
||
</code></pre></li>
|
||
<li>
|
||
<p>To make the third request, which creates an event that has the <code>type</code>
|
||
<code>greeting</code> and the<code>source</code> <code>sendoff</code>, run the following in the SSH terminal:</p>
|
||
<pre><code>curl -v &quot;http://broker-ingress.knative-eventing.svc.cluster.local/event-example/default&quot; \
|
||
-X POST \
|
||
-H &quot;Ce-Id: say-hello-goodbye&quot; \
|
||
-H &quot;Ce-Specversion: 1.0&quot; \
|
||
-H &quot;Ce-Type: greeting&quot; \
|
||
-H &quot;Ce-Source: sendoff&quot; \
|
||
-H &quot;Content-Type: application/json&quot; \
|
||
-d '{&quot;msg&quot;:&quot;Hello Knative! Goodbye Knative!&quot;}'
|
||
</code></pre><p>When the broker receives your event, <code>hello-display</code> and <code>goodbye-display</code>
|
||
will activate and send the event to the event consumers of the same name.
|
||
If the event has been received, you will receive a <code>202 Accepted</code> response
|
||
similar to the one below:</p>
|
||
<pre><code>&lt; HTTP/1.1 202 Accepted
|
||
&lt; Content-Length: 0
|
||
&lt; Date: Mon, 12 Aug 2019 19:48:18 GMT
|
||
</code></pre></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Exit SSH by typing <code>exit</code> into the command prompt.</p>
|
||
</li>
|
||
</ol>
|
||
<p>You have sent two events to the <code>hello-display</code> event consumer and two events to
|
||
the <code>goodbye-display</code> event consumer (note that <code>say-hello-goodbye</code> activates
|
||
the trigger conditions for <em>both</em> <code>hello-display</code> and <code>goodbye-display</code>). You
|
||
will verify that these events were received correctly in the next section.</p>
|
||
<h2 id="verifying-that-events-were-received">Verifying that events were received</h2>
|
||
<p>After you send the events, verify that the events were received by the correct subscribers.</p>
|
||
<ol>
|
||
<li>Look at the logs for the <code>hello-display</code> event consumer by entering the
|
||
following command:
|
||
<pre><code>kubectl -n event-example logs -l app=hello-display --tail=100
|
||
</code></pre><p>This returns the <code>Attributes</code> and <code>Data</code> of the events you sent to
|
||
<code>hello-display</code>:</p>
|
||
<pre><code>☁️ cloudevents.Event
|
||
Validation: valid
|
||
Context Attributes,
|
||
specversion: 1.0
|
||
type: greeting
|
||
source: not-sendoff
|
||
id: say-hello
|
||
time: 2019-05-20T17:59:43.81718488Z
|
||
contenttype: application/json
|
||
Extensions,
|
||
knativehistory: default-broker-srk54-channel-24gls.event-example.svc.cluster.local
|
||
Data,
|
||
{
|
||
&quot;msg&quot;: &quot;Hello Knative!&quot;
|
||
}
|
||
☁️ cloudevents.Event
|
||
Validation: valid
|
||
Context Attributes,
|
||
specversion: 1.0
|
||
type: greeting
|
||
source: sendoff
|
||
id: say-hello-goodbye
|
||
time: 2019-05-20T17:59:54.211866425Z
|
||
contenttype: application/json
|
||
Extensions,
|
||
knativehistory: default-broker-srk54-channel-24gls.event-example.svc.cluster.local
|
||
Data,
|
||
{
|
||
&quot;msg&quot;: &quot;Hello Knative! Goodbye Knative!&quot;
|
||
}
|
||
</code></pre></li>
|
||
<li>Look at the logs for the <code>goodbye-display</code> event consumer by entering the
|
||
following command:
|
||
<pre><code>kubectl -n event-example logs -l app=goodbye-display --tail=100
|
||
</code></pre><p>This returns the <code>Attributes</code> and <code>Data</code> of the events you sent to
|
||
<code>goodbye-display</code>:</p>
|
||
<pre><code>☁️ cloudevents.Event
|
||
Validation: valid
|
||
Context Attributes,
|
||
specversion: 1.0
|
||
type: not-greeting
|
||
source: sendoff
|
||
id: say-goodbye
|
||
time: 2019-05-20T17:59:49.044926148Z
|
||
contenttype: application/json
|
||
Extensions,
|
||
knativehistory: default-broker-srk54-channel-24gls.event-example.svc.cluster.local
|
||
Data,
|
||
{
|
||
&quot;msg&quot;: &quot;Goodbye Knative!&quot;
|
||
}
|
||
☁️ cloudevents.Event
|
||
Validation: valid
|
||
Context Attributes,
|
||
specversion: 1.0
|
||
type: greeting
|
||
source: sendoff
|
||
id: say-hello-goodbye
|
||
time: 2019-05-20T17:59:54.211866425Z
|
||
contenttype: application/json
|
||
Extensions,
|
||
knativehistory: default-broker-srk54-channel-24gls.event-example.svc.cluster.local
|
||
Data,
|
||
{
|
||
&quot;msg&quot;: &quot;Hello Knative! Goodbye Knative!&quot;
|
||
}
|
||
</code></pre></li>
|
||
</ol>
|
||
<h2 id="cleaning-up-example-resources">Cleaning up example resources</h2>
|
||
<p>You can delete the <code>event-example</code> namespace and its associated resources from your cluster if you do not plan to use it again in the future.</p>
|
||
<p>Delete the <code>event-example</code> namespace and all of its resources from your cluster by entering the following command:</p>
|
||
<pre><code>kubectl delete namespace event-example
|
||
</code></pre>
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Event sources</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/sources/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/sources/</guid>
|
||
<description>
|
||
|
||
|
||
<p>An event source is a Kubernetes custom resource (CR), created by a developer or cluster administrator, that acts as a link between an event producer and an event <em>sink</em>.
|
||
A sink can be a k8s service, including Knative Services, a Channel, or a Broker that receives events from an event source.</p>
|
||
<p>Event sources are created by instantiating a CR from a Source object.
|
||
The Source object defines the arguments and parameters needed to instantiate a CR.</p>
|
||
<p>All Sources are part of the <code>sources</code> category.</p>
|
||
|
||
|
||
|
||
|
||
|
||
<ul class="nav nav-tabs" id="list-event-sources" role="tablist">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="nav-item active">
|
||
<a class="nav-link active" id="list-event-sources-0-tab" data-toggle="tab" href="#list-event-sources-0" role="tab" aria-controls="list-event-sources-0" aria-selected="true">kubectl</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
<li class="nav-item ">
|
||
<a class="nav-link " id="list-event-sources-1-tab" data-toggle="tab" href="#list-event-sources-1" role="tab" aria-controls="list-event-sources-1" aria-selected="true">kn</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
<div class="tab-content" >
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="tab-pane fade show active" id="list-event-sources-0" role="tabpanel" aria-labelledby="list-event-sources-0-tab">
|
||
|
||
<p>You can list existing event sources on your cluster by entering the command:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl get sources
|
||
</code></pre></div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="tab-pane fade " id="list-event-sources-1" role="tabpanel" aria-labelledby="list-event-sources-1-tab">
|
||
|
||
<p>You can list existing event sources on your cluster by entering the kn command:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kn <span style="color:#204a87">source</span> list
|
||
</code></pre></div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<h2 id="knative-sources">Knative Sources</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>API Version</th>
|
||
<th>Maintainer</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><a href="./apiserversource">APIServerSource</a></td>
|
||
<td>v1</td>
|
||
<td>Knative</td>
|
||
<td>Brings Kubernetes API server events into Knative. The APIServerSource fires a new event each time a Kubernetes resource is created, updated or deleted.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/knative-sandbox/eventing-awssqs/tree/main/samples">AWS SQS</a></td>
|
||
<td>v1alpha1</td>
|
||
<td>Knative</td>
|
||
<td>Brings <a href="https://aws.amazon.com/sqs/">AWS Simple Queue Service</a> messages into Knative. The AwsSqsSource fires a new event each time an event is published on an <a href="https://aws.amazon.com/sqs/">AWS SQS topic</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="../samples/apache-camel-source">Apache Camel</a></td>
|
||
<td>v1alpha1</td>
|
||
<td>Knative</td>
|
||
<td>Enables use of <a href="https://github.com/apache/camel">Apache Camel</a> components for pushing events into Knative. A CamelSource is an event source that can represent any existing <a href="https://github.com/apache/camel/tree/master/components">Apache Camel component</a>, that provides a consumer side, and enables publishing events to an addressable endpoint. Each Camel endpoint has the form of a URI where the scheme is the ID of the component to use. CamelSource requires <a href="https://github.com/apache/camel-k#installation">Camel-K</a> to be installed into the current namespace. See the <a href="https://github.com/knative-sandbox/eventing-camel/tree/main/samples">CamelSource</a> example.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/knative-sandbox/eventing-couchdb/blob/main/source">Apache CouchDB</a></td>
|
||
<td>v1alpha1</td>
|
||
<td>Knative</td>
|
||
<td>Brings <a href="https://couchdb.apache.org/">Apache CouchDB</a> messages into Knative.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="../samples/kafka">Apache Kafka</a></td>
|
||
<td>v1beta1</td>
|
||
<td>Knative</td>
|
||
<td>Brings <a href="https://kafka.apache.org/">Apache Kafka</a> messages into Knative. The KafkaSource reads events from an Apache Kafka Cluster, and passes these events to a sink so that they can be consumed. See the <a href="https://github.com/knative-sandbox/eventing-kafka/blob/main/pkg/source">Kafka Source</a> example for more details.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="./containersource">Container Source</a></td>
|
||
<td>v1</td>
|
||
<td>Knative</td>
|
||
<td>The ContainerSource will instantiate container image(s) that can generate events until the ContainerSource is deleted. This may be used, for example, to poll an FTP server for new files or generate events at a set time interval. Given a <code>spec.template</code> with at least a container image specified, ContainerSource will keep a <code>Pod</code> running with the specified image(s). <code>K_SINK</code> (destination address) and <code>KE_CE_OVERRIDES</code> (JSON CloudEvents attributes) environment variables are injected into the running image(s). It is used by multiple other Sources as underlying infrastructure. Refer to the <a href="../samples/container-source">Container Source</a> example for more details.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="../samples/github-source">GitHub</a></td>
|
||
<td>v1alpha1</td>
|
||
<td>Knative</td>
|
||
<td>Registers for events of the specified types on the specified GitHub organization or repository, and brings those events into Knative. The GitHubSource fires a new event for selected <a href="https://developer.github.com/v3/activity/events/types/">GitHub event types</a>. See the <a href="../samples/github-source">GitHub Source</a> example for more details.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="../samples/gitlab-source">GitLab</a></td>
|
||
<td>v1alpha1</td>
|
||
<td>Knative</td>
|
||
<td>Registers for events of the specified types on the specified GitLab repository, and brings those events into Knative. The GitLabSource creates a webhooks for specified <a href="https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#events">event types</a>, listens for incoming events, and passes them to a consumer. See the <a href="../samples/gitlab-source">GitLab Source</a> example for more details.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/knative/eventing/tree/main/cmd/heartbeats">Heartbeats</a></td>
|
||
<td>N/A</td>
|
||
<td>Knative</td>
|
||
<td>Uses an in-memory timer to produce events at the specified interval.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="./pingsource">PingSource</a></td>
|
||
<td>v1beta2</td>
|
||
<td>Knative</td>
|
||
<td>Produces events with a fixed payload on a specified <a href="https://en.wikipedia.org/wiki/Cron">Cron</a> schedule. See the <a href="../samples/ping-source">Ping Source</a> example for more details.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/knative-sandbox/eventing-rabbitmq">RabbitMQ</a></td>
|
||
<td>Active development</td>
|
||
<td>None</td>
|
||
<td>Brings <a href="https://www.rabbitmq.com/">RabbitMQ</a> messages into Knative.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="./sinkbinding/">SinkBinding</a></td>
|
||
<td>v1</td>
|
||
<td>Knative</td>
|
||
<td>The SinkBinding can be used to author new event sources using any of the familiar compute abstractions that Kubernetes makes available (e.g. Deployment, Job, DaemonSet, StatefulSet), or Knative abstractions (e.g. Service, Configuration). SinkBinding provides a framework for injecting <code>K_SINK</code> (destination address) and <code>K_CE_OVERRIDES</code> (JSON cloudevents attributes) environment variables into any Kubernetes resource which has a <code>spec.template</code> that looks like a Pod (aka PodSpecable). See the <a href="../samples/container-source">SinkBinding</a> example for more details.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/knative/eventing/tree/main/cmd/websocketsource">WebSocket</a></td>
|
||
<td>N/A</td>
|
||
<td>Knative</td>
|
||
<td>Opens a WebSocket to the specified source and packages each received message as a Knative event.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="third-party-sources">Third-Party Sources</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>API Version</th>
|
||
<th>Maintainer</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><a href="https://github.com/Harwayne/auto-container-source">Auto Container Source</a></td>
|
||
<td>Proof of Concept</td>
|
||
<td>None</td>
|
||
<td>AutoContainerSource is a controller that allows the Source CRDs <em>without</em> needing a controller. It notices CRDs with a specific label and starts controlling resources of that type. It utilizes Container Source as underlying infrastructure.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/triggermesh/aws-event-sources/tree/master/cmd/awscloudwatchsource">Amazon CloudWatch</a></td>
|
||
<td>Supported</td>
|
||
<td>TriggerMesh</td>
|
||
<td>Collects metrics from <a href="https://aws.amazon.com/cloudwatch/">Amazon CloudWatch</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/triggermesh/aws-event-sources/tree/master/cmd/awscloudwatchlogssource">Amazon CloudWatch Logs</a></td>
|
||
<td>Supported</td>
|
||
<td>TriggerMesh</td>
|
||
<td>Subscribes to log events from an <a href="https://aws.amazon.com/cloudwatch/">Amazon CloudWatch Logs</a> stream.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/triggermesh/aws-event-sources/blob/master/cmd/awscodecommitsource/README.md">Amazon CodeCommit</a></td>
|
||
<td>Supported</td>
|
||
<td>TriggerMesh</td>
|
||
<td>Registers for events emitted by an <a href="https://aws.amazon.com/codecommit/">Amazon CodeCommit</a> source code repository.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/triggermesh/aws-event-sources/tree/master/cmd/awscognitoidentitysource/README.md">Amazon Cognito Identity</a></td>
|
||
<td>Supported</td>
|
||
<td>TriggerMesh</td>
|
||
<td>Registers for events from <a href="https://aws.amazon.com/cognito/">Amazon Cognito</a> identity pools.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/triggermesh/aws-event-sources/tree/master/cmd/awscognitouserpoolsource/README.md">Amazon Cognito User</a></td>
|
||
<td>Supported</td>
|
||
<td>TriggerMesh</td>
|
||
<td>Registers for events from <a href="https://aws.amazon.com/cognito/">Amazon Cognito</a> user pools.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/triggermesh/aws-event-sources/blob/master/cmd/awsdynamodbsource/README.md">Amazon DynamoDB</a></td>
|
||
<td>Supported</td>
|
||
<td>TriggerMesh</td>
|
||
<td>Reads records from an <a href="https://aws.amazon.com/dynamodb/">Amazon DynamoDB</a> stream.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/triggermesh/aws-event-sources/tree/master/cmd/awskinesissource/README.md">Amazon Kinesis</a></td>
|
||
<td>Supported</td>
|
||
<td>TriggerMesh</td>
|
||
<td>Reads records from an <a href="https://aws.amazon.com/kinesis/">Amazon Kinesis</a> stream.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/triggermesh/aws-event-sources/tree/master/cmd/awssnssource/README.md">Amazon SNS</a></td>
|
||
<td>Supported</td>
|
||
<td>TriggerMesh</td>
|
||
<td>Subscribes to messages from an <a href="https://aws.amazon.com/sns/">Amazon SNS</a> topic.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/triggermesh/aws-event-sources/tree/master/cmd/awssqssource/README.md">Amazon SQS</a></td>
|
||
<td>Supported</td>
|
||
<td>TriggerMesh</td>
|
||
<td>Consumes messages from an <a href="https://aws.amazon.com/sqs/">Amazon SQS</a> queue.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/nachocano/bitbucket-source">BitBucket</a></td>
|
||
<td>Proof of Concept</td>
|
||
<td>None</td>
|
||
<td>Registers for events of the specified types on the specified BitBucket organization/repository. Brings those events into Knative.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/google/knative-gcp/blob/main/docs/examples/cloudauditlogssource/README.md">CloudAuditLogsSource</a></td>
|
||
<td>v1</td>
|
||
<td>Google</td>
|
||
<td>Registers for events of the specified types on the specified <a href="https://cloud.google.com/logging/docs/audit/">Google Cloud Audit Logs</a>. Brings those events into Knative. Refer to the <a href="../samples/cloud-audit-logs-source">CloudAuditLogsSource</a> example for more details.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/google/knative-gcp/blob/main/docs/examples/cloudpubsubsource/README.md">CloudPubSubSource</a></td>
|
||
<td>v1</td>
|
||
<td>Google</td>
|
||
<td>Brings <a href="https://cloud.google.com/pubsub/">Cloud Pub/Sub</a> messages into Knative. The CloudPubSubSource fires a new event each time a message is published on a <a href="https://cloud.google.com/pubsub/">Google Cloud Platform PubSub topic</a>. See the <a href="../samples/cloud-pubsub-source">CloudPubSubSource</a> example for more details.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/google/knative-gcp/blob/main/docs/examples/cloudschedulersource/README.md">CloudSchedulerSource</a></td>
|
||
<td>v1</td>
|
||
<td>Google</td>
|
||
<td>Create, update, and delete <a href="https://cloud.google.com/scheduler/">Google Cloud Scheduler</a> Jobs. When those jobs are triggered, receive the event inside Knative. See the <a href="../samples/cloud-scheduler-source">CloudSchedulerSource</a> example for further details.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/google/knative-gcp/blob/main/docs/examples/cloudstoragesource/README.md">CloudStorageSource</a></td>
|
||
<td>v1</td>
|
||
<td>Google</td>
|
||
<td>Registers for events of the specified types on the specified <a href="https://cloud.google.com/storage/">Google Cloud Storage</a> bucket and optional object prefix. Brings those events into Knative. See the <a href="../samples/cloud-storage-source">CloudStorageSource</a> example.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/tom24d/eventing-dockerhub">DockerHubSource</a></td>
|
||
<td>v1alpha1</td>
|
||
<td>None</td>
|
||
<td>Retrieves events from <a href="https://docs.docker.com/docker-hub/webhooks/">Docker Hub Webhooks</a> and transforms them into CloudEvents for consumption in Knative.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/vaikas-google/ftp">FTP / SFTP</a></td>
|
||
<td>Proof of concept</td>
|
||
<td>None</td>
|
||
<td>Watches for files being uploaded into a FTP/SFTP and generates events for those.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/BrianMMcClain/github-issue-comment-source">GitHub Issue Comments</a></td>
|
||
<td>Proof of Concept</td>
|
||
<td>None</td>
|
||
<td>Polls a specific GitHub issue for new comments.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/Harwayne/auto-container-source/tree/master/heartbeat-source">Heartbeat</a></td>
|
||
<td>Proof of Concept</td>
|
||
<td>None</td>
|
||
<td>Uses an in-memory timer to produce events as the specified interval. Uses AutoContainerSource for underlying infrastructure.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://konnek.github.io/docs/#/">Konnek</a></td>
|
||
<td>Active Development</td>
|
||
<td>None</td>
|
||
<td>Retrieves events from cloud platforms (like AWS and GCP) and transforms them into CloudEvents for consumption in Knative.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/Harwayne/auto-container-source/tree/master/k8s-event-source">K8s</a></td>
|
||
<td>Proof of Concept</td>
|
||
<td>None</td>
|
||
<td>Brings Kubernetes cluster events into Knative. Uses AutoContainerSource for underlying infrastructure.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/knative-sandbox/eventing-redis/tree/main/source">RedisSource</a></td>
|
||
<td>v1alpha1</td>
|
||
<td>None</td>
|
||
<td>Brings Redis Stream into Knative.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/triggermesh/knative-sources">Slack</a></td>
|
||
<td>v1alpha1</td>
|
||
<td>TriggerMesh</td>
|
||
<td>Subscribes to events from Slack.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/vmware-tanzu/sources-for-knative/blob/main/README.md">VMware</a></td>
|
||
<td>Active Development</td>
|
||
<td>None</td>
|
||
<td>Brings <a href="https://www.vmware.com/products/vsphere.html">vSphere</a> events into Knative.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/triggermesh/knative-sources">Zendesk</a></td>
|
||
<td>v1alpha1</td>
|
||
<td>TriggerMesh</td>
|
||
<td>Subscribes to events from Zendesk.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="additional-resources">Additional resources</h2>
|
||
<ul>
|
||
<li>For information about creating your own Source type, see the <a href="../samples/writing-event-source">tutorial on writing a Source with a Receive Adapter</a>.</li>
|
||
<li>If your code needs to send events as part of its business logic and doesn&rsquo;t fit the model of a Source, consider <a href="https://knative.dev/docs/eventing/broker/">feeding events directly to a Broker</a>.</li>
|
||
<li>For more information about using <code>kn</code> Source related commands, see the <a href="https://github.com/knative/client/blob/main/docs/cmd/kn_source.md"><code>kn source</code> reference documentation</a>.</li>
|
||
</ul>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Event registry</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/event-registry/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/event-registry/</guid>
|
||
<description>
|
||
|
||
|
||
<h2 id="overview">Overview</h2>
|
||
<p>The event registry maintains a catalog of event types that can be consumed
|
||
from different brokers. It introduces the EventType custom resource in order to persist the event
|
||
type information in the cluster data store.</p>
|
||
<h2 id="before-you-begin">Before you begin</h2>
|
||
<ol>
|
||
<li>Read about the <a href="../broker/">broker</a> and <a href="../broker/triggers/">trigger</a> objects.</li>
|
||
<li>Be familiar with the
|
||
<a href="https://github.com/cloudevents/spec/blob/master/spec.md">CloudEvents spec</a>,
|
||
particularly the
|
||
<a href="https://github.com/cloudevents/spec/blob/master/spec.md#context-attributes">Context Attributes</a>
|
||
section.</li>
|
||
<li>Be familiar with <a href="../sources">event sources</a>.</li>
|
||
</ol>
|
||
<h2 id="discovering-events-with-the-registry">Discovering events with the registry</h2>
|
||
<p>Using the registry, you can discover different types of events that can be consumed by broker event meshes. The registry is designed for use with
|
||
the broker and trigger model, and aims to help you create triggers.</p>
|
||
<p>To see event types in the registry that are available to subscribe to, enter the following command:</p>
|
||
<pre><code>kubectl get eventtypes -n &lt;namespace&gt;
|
||
</code></pre><p>Below, we show an example output of executing the above command using the
|
||
<code>default</code> namespace in a testing cluster. We will address the question of how
|
||
this registry was populated in a later section.</p>
|
||
<pre><code>NAME TYPE SOURCE SCHEMA BROKER DESCRIPTION READY REASON
|
||
dev.knative.source.github.push-34cnb dev.knative.source.github.push https://github.com/knative/eventing default True
|
||
dev.knative.source.github.push-44svn dev.knative.source.github.push https://github.com/knative/serving default True
|
||
dev.knative.source.github.pullrequest-86jhv dev.knative.source.github.pull_request https://github.com/knative/eventing default True
|
||
dev.knative.source.github.pullrequest-97shf dev.knative.source.github.pull_request https://github.com/knative/serving default True
|
||
dev.knative.kafka.event-cjvcr dev.knative.kafka.event /apis/v1/namespaces/default/kafkasources/kafka-sample#news default True
|
||
dev.knative.kafka.event-tdt48 dev.knative.kafka.event /apis/v1/namespaces/default/kafkasources/kafka-sample#knative-demo default True
|
||
google.pubsub.topic.publish-hrxhh google.pubsub.topic.publish //pubsub.googleapis.com/knative/topics/testing dev False BrokerIsNotReady
|
||
</code></pre><p><strong>NOTE:</strong> This assumes that the event sources emitting the events reference a broker as their sink.</p>
|
||
<p>There are seven different EventType objects in the registry of the
|
||
<code>default</code> namespace.</p>
|
||
<p>Use the following command to see an example of what the YAML for an EventType object looks like:</p>
|
||
<pre><code>kubectl get eventtype dev.knative.source.github.push-34cnb -o yaml
|
||
</code></pre><p>Omitting irrelevant fields:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">eventing.knative.dev/v1beta1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">EventType</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">dev.knative.source.github.push-34cnb</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">namespace</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">labels</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">eventing.knative.dev/sourceName</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">github-sample</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">spec</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">type</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">dev.knative.source.github.push</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">source</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">https://github.com/knative/eventing</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">schema</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">description</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">broker</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">status</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">conditions</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#204a87;font-weight:bold">status</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;True&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">type</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">BrokerExists</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#204a87;font-weight:bold">status</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;True&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">type</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">BrokerReady</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#204a87;font-weight:bold">status</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;True&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">type</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Ready</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>From a consumer standpoint, the fields that matter the most are the <code>spec</code>
|
||
fields as well as the <code>status</code>.</p>
|
||
<p>The <code>name</code> is advisory (i.e., non-authoritative), and we typically generate it
|
||
(<code>generateName</code>) to avoid naming collisions (e.g., two EventTypes listening to
|
||
pull requests on two different Github repositories). As <code>name</code> nor
|
||
<code>generateName</code> are needed for consumers to create Triggers, we defer their
|
||
discussion for later on.</p>
|
||
<p>Regarding <code>status</code>, its main purpose it to tell consumers (or cluster operators)
|
||
whether the EventType is ready for consumption or not. That <em>readiness</em> is based
|
||
on the Broker being ready. We can see from the example output that the PubSub
|
||
EventType is not ready, as its <code>dev</code> Broker isn&rsquo;t.</p>
|
||
<p>Let&rsquo;s talk in more details about the <code>spec</code> fields:</p>
|
||
<ul>
|
||
<li>
|
||
<p><code>type</code>: is authoritative. This refers to the CloudEvent type as it enters into
|
||
the event mesh. It is mandatory. Event consumers can (and in most cases would)
|
||
create Triggers filtering on this attribute.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>source</code>: refers to the CloudEvent source as it enters into the event mesh. It
|
||
is mandatory. Event consumers can (and in most cases would) create Triggers
|
||
filtering on this attribute.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>schema</code>: is a valid URI with the EventType schema. It may be a JSON schema, a
|
||
protobuf schema, etc. It is optional.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>description</code>: is a string describing what the EventType is about. It is
|
||
optional.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>broker</code> refers to the Broker that can provide the EventType. It is mandatory.</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="subscribing-to-events">Subscribing to events</h2>
|
||
<p>Now that you know what events can be consumed from the Brokers' event meshes,
|
||
you can create Triggers to subscribe to particular events.</p>
|
||
<p>Here are a few example Triggers that subscribe to events using exact matching on
|
||
<code>type</code> and/or <code>source</code>, based on the above registry output:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Subscribes to GitHub <em>pushes</em> from any source.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">eventing.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Trigger</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">push-trigger</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">namespace</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">spec</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">broker</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">filter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">attributes</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">type</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">dev.knative.source.github.push</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">subscriber</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ref</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">serving.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Service</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">push-service</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>As per the registry output above, only two sources exist for that particular
|
||
type of event (<em>knative&rsquo;s eventing and serving</em> repositories). If later on
|
||
new sources are registered for GitHub pushes, this trigger will be able to
|
||
consume them.</p>
|
||
</li>
|
||
<li>
|
||
<p>Subscribes to GitHub <em>pull requests</em> from <em>knative&rsquo;s eventing</em> repository.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">eventing.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Trigger</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">gh-knative-eventing-pull-trigger</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">namespace</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">spec</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">broker</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">filter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">attributes</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">type</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">dev.knative.source.github.pull_request</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">source</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">https://github.com/knative/eventing</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">subscriber</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ref</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">serving.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Service</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">gh-knative-eventing-pull-service</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div></li>
|
||
<li>
|
||
<p>Subscribes to Kafka messages sent to the <em>knative-demo</em> topic</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">eventing.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Trigger</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">kafka-knative-demo-trigger</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">namespace</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">spec</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">broker</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">filter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">attributes</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">type</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">dev.knative.kafka.event</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">source</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">/apis/v1/namespaces/default/kafkasources/kafka-sample#knative-demo</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">subscriber</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ref</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">serving.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Service</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">kafka-knative-demo-service</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div></li>
|
||
<li>
|
||
<p>Subscribes to PubSub messages from GCP&rsquo;s <em>knative</em> project sent to the
|
||
<em>testing</em> topic</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">eventing.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Trigger</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">gcp-pubsub-knative-testing-trigger</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">namespace</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">spec</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">broker</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">dev</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">filter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">attributes</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">source</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">//pubsub.googleapis.com/knative/topics/testing</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">subscriber</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ref</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">serving.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Service</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">gcp-pubsub-knative-testing-service</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Note that events won&rsquo;t be able to be consumed by this Trigger&rsquo;s subscriber
|
||
until the Broker becomes ready.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 id="populating-the-registry">Populating the registry</h2>
|
||
<p>Now that we know how to discover events using the registry and how we can
|
||
leverage that information to subscribe to events of interest, let&rsquo;s move on to
|
||
the next topic: How do we actually populate the registry in the first place?</p>
|
||
<ul>
|
||
<li>
|
||
<p>Manual Registration</p>
|
||
<p>In order to populate the registry, a cluster configurator can manually
|
||
register the EventTypes. This means that the configurator can simply apply
|
||
EventTypes yaml files, just as with any other Kubernetes resource:</p>
|
||
<p><code>kubectl apply -f &lt;event_type.yaml&gt;</code></p>
|
||
</li>
|
||
<li>
|
||
<p>Automatic Registration</p>
|
||
<p>As Manual Registration might be tedious and error-prone, we also support
|
||
automatic registration of EventTypes. The creation of the EventTypes is done
|
||
upon instantiation of an Event Source. We currently support automatic
|
||
registration of EventTypes for the following Event Sources:</p>
|
||
<ul>
|
||
<li>CronJobSource</li>
|
||
<li>ApiServerSource</li>
|
||
<li>GithubSource</li>
|
||
<li>GcpPubSubSource</li>
|
||
<li>KafkaSource</li>
|
||
<li>AwsSqsSource</li>
|
||
</ul>
|
||
<p>Let&rsquo;s look at an example, in particular, the KafkaSource sample we used to
|
||
populate the registry in our testing cluster. Below is what the yaml looks
|
||
like.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">sources.knative.dev/v1beta1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">KafkaSource</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">kafka-sample</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">namespace</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">spec</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">bootstrapServers</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">my-cluster-kafka-bootstrap.kafka:9092</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">topics</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">knative-demo</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">news</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">sink</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">eventing.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Broker</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>If you are interested in more information regarding configuration options of a
|
||
KafkaSource, please refer to the
|
||
<a href="../samples/kafka/">KafKaSource sample</a>.</p>
|
||
<p>For this discussion, the relevant information from the yaml above are the
|
||
<code>sink</code> and the <code>topics</code>. We observe that the <code>sink</code> is of kind <code>Broker</code>. We
|
||
currently only support automatic creation of EventTypes for Sources instances
|
||
that point to Brokers. Regarding <code>topics</code>, this is what we use to generate the
|
||
EventTypes <code>source</code> field, which is equal to the CloudEvent source attribute.</p>
|
||
<p>When you <code>kubectl apply</code> this yaml, the KafkaSource <code>kafka-source-sample</code> will
|
||
be instantiated, and two EventTypes will be added to the registry (as there
|
||
are two topics). You can see that in the registry example output from the
|
||
previous sections.</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="next-steps">Next steps</h2>
|
||
<ol>
|
||
<li><a href="../../install/">Installing Knative</a>.</li>
|
||
<li><a href="../samples/">Knative code samples</a> is a useful resource to better understand
|
||
some of the Event Sources (remember to point them to a Broker if you want
|
||
automatic registration of EventTypes in the registry).</li>
|
||
</ol>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Eventing Flows</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/flows/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/flows/</guid>
|
||
<description>
|
||
|
||
|
||
<p>Knative Eventing provides a collection of <a href="https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/">custom resource definitions (CRDs)</a> that you can use to define event flows:</p>
|
||
<ul>
|
||
<li><a href="./sequence">Sequence</a> is for defining an in-order list of functions.</li>
|
||
<li><a href="./parallel">Parallel</a> is for defining a list of branches, each receiving the same CloudEvent.</li>
|
||
</ul>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Channels</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/channels/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/channels/</guid>
|
||
<description>
|
||
|
||
|
||
<p>An event might be relevant to many consumers. One way to handle this is to directly tie each consumer
|
||
to the producer that creates the event, making a fan-out pattern.</p>
|
||
<p>This fan-out pattern, however, introduces complex problems for the application architecture, such as
|
||
retries, timeouts, and persistence. Instead of burdening the producer with these problems, you can
|
||
use channels.</p>
|
||
<p>A channel is a Kubernetes <a href="https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/">custom resource</a> that defines a single event forwarding and persistence layer.</p>
|
||
<p>Channels function as event delivery mechanisms that can fan out received events, through
|
||
subscriptions, to multiple destinations, referred to as sinks. Examples of sinks include brokers and
|
||
Knative services.</p>
|
||
<p><img src="images/channel-workflow.png" width="80%"><br></p>
|
||
<p>There are several kinds of channels, but they all make it possible to deliver events to all relevant
|
||
consumers and, importantly, make the events persist.</p>
|
||
<p>When you create a channel, you can choose which kind of channel is most appropriate for your use
|
||
case. For development use cases, an in-memory channel might suffice, but for production persistence,
|
||
you might need retry and replay capabilities.</p>
|
||
<h2 id="next-steps">Next steps</h2>
|
||
<ul>
|
||
<li>Learn about <a href="channel-types-defaults">default available channel types</a></li>
|
||
<li>Create a <a href="./create-default-channel">channel</a></li>
|
||
<li>Create a <a href="./subscriptions">subscription</a></li>
|
||
</ul>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Knative Eventing Sugar Controller</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/sugar/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/sugar/</guid>
|
||
<description>
|
||
|
||
|
||
<p>Knative Eventing Sugar Controller will react to special labels and annotations
|
||
to produce or control eventing resources in a cluster or namespace. This allows
|
||
cluster operators and developers to focus on creating fewer resources, and the
|
||
underlying eventing infrastructure is created on-demand, and cleaned up when no
|
||
longer needed.</p>
|
||
<h2 id="installing">Installing</h2>
|
||
<p>The following command installs the Eventing Sugar Controller:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl apply --filename https://github.com/knative/eventing/releases/download/v0.23.0/eventing-sugar-controller.yaml
|
||
</code></pre></div><h2 id="automatic-broker-creation">Automatic Broker Creation</h2>
|
||
<p>One way to create a Broker is to manually apply a resource to a cluster using
|
||
the default settings:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl create -f - <span style="color:#4e9a06">&lt;&lt;EOF
|
||
</span><span style="color:#4e9a06">apiVersion: eventing.knative.dev/v1
|
||
</span><span style="color:#4e9a06">kind: Broker
|
||
</span><span style="color:#4e9a06">metadata:
|
||
</span><span style="color:#4e9a06"> name: default
|
||
</span><span style="color:#4e9a06"> namespace: default
|
||
</span><span style="color:#4e9a06">EOF</span>
|
||
</code></pre></div><p>There might be cases where automated Broker creation is desirable, such as on
|
||
namespace creation, or on Trigger creation. The Sugar controller enables those
|
||
use-cases:</p>
|
||
<ul>
|
||
<li>When a Namespace is labeled with <code>eventing.knative.dev/injection=enabled</code>, the
|
||
sugar controller will create a default Broker named &ldquo;default&rdquo; in that
|
||
namespace.</li>
|
||
<li>When a Trigger is annotated with <code>eventing.knative.dev/injection=enabled</code>, the
|
||
controller will create a Broker named by that Trigger in the Trigger&rsquo;s
|
||
Namespace.</li>
|
||
</ul>
|
||
<p>When a Broker is deleted and the above labels or annotations are in-use, the
|
||
Sugar Controller will automatically recreate a default Broker.</p>
|
||
<h3 id="namespace-examples">Namespace Examples</h3>
|
||
<p>Creating a &ldquo;default&rdquo; Broker when creating a Namespace:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl apply -f - <span style="color:#4e9a06">&lt;&lt;EOF
|
||
</span><span style="color:#4e9a06">apiVersion: v1
|
||
</span><span style="color:#4e9a06">kind: Namespace
|
||
</span><span style="color:#4e9a06">metadata:
|
||
</span><span style="color:#4e9a06"> name: example
|
||
</span><span style="color:#4e9a06"> labels:
|
||
</span><span style="color:#4e9a06"> eventing.knative.dev/injection: enabled
|
||
</span><span style="color:#4e9a06">EOF</span>
|
||
</code></pre></div><p>To automatically create a Broker after a namespace exists, label the Namespace:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl label namespace default eventing.knative.dev/injection<span style="color:#ce5c00;font-weight:bold">=</span>enabled
|
||
</code></pre></div><p>If the Broker named &ldquo;default&rdquo; already exists in the Namespace, the Sugar
|
||
Controller will do nothing.</p>
|
||
<h3 id="trigger-examples">Trigger Examples</h3>
|
||
<p>Create a Broker named by a Trigger (<code>spec.broker</code>) in the Trigger&rsquo;s Namespace:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl apply -f - <span style="color:#4e9a06">&lt;&lt; EOF
|
||
</span><span style="color:#4e9a06">apiVersion: eventing.knative.dev/v1
|
||
</span><span style="color:#4e9a06">kind: Trigger
|
||
</span><span style="color:#4e9a06">metadata:
|
||
</span><span style="color:#4e9a06"> name: hello-sugar
|
||
</span><span style="color:#4e9a06"> namespace: hello
|
||
</span><span style="color:#4e9a06"> annotations:
|
||
</span><span style="color:#4e9a06"> eventing.knative.dev/injection: enabled
|
||
</span><span style="color:#4e9a06">spec:
|
||
</span><span style="color:#4e9a06"> broker: sugar
|
||
</span><span style="color:#4e9a06"> subscriber:
|
||
</span><span style="color:#4e9a06"> ref:
|
||
</span><span style="color:#4e9a06"> apiVersion: v1
|
||
</span><span style="color:#4e9a06"> kind: Service
|
||
</span><span style="color:#4e9a06"> name: event-display
|
||
</span><span style="color:#4e9a06">EOF</span>
|
||
</code></pre></div><blockquote>
|
||
<p><em>Note</em>: If the named Broker already exists, the Sugar controller will do
|
||
nothing, and the Trigger will not own the existing Broker.</p>
|
||
</blockquote>
|
||
<p>This will make a Broker called &ldquo;sugar&rdquo; in the Namespace &ldquo;hello&rdquo;, and attempt to
|
||
send events to the &ldquo;event-display&rdquo; service.</p>
|
||
<p>If the Broker of the given name already exists in the Namespace, the Sugar
|
||
Controller will do nothing.</p>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Event delivery</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/event-delivery/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/event-delivery/</guid>
|
||
<description>
|
||
|
||
|
||
<p>You can configure event delivery parameters for Knative Eventing components that are applied in cases where an event fails to be delivered</p>
|
||
<h2 id="configuring-subscription-event-delivery">Configuring subscription event delivery</h2>
|
||
<p>You can configure how events are delivered for each subscription by adding a <code>delivery</code> spec to the <code>Subscription</code> object, as shown in the following example:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">messaging.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Subscription</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">example-subscription</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">namespace</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">example-namespace</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">spec</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">delivery</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">deadLetterSink</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ref</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">serving.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Service</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">example-sink</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">backoffDelay</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">&lt;duration&gt;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">backoffPolicy</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">&lt;policy-type&gt;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">retry</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">&lt;integer&gt;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>Where</p>
|
||
<ul>
|
||
<li>The <code>deadLetterSink</code> spec contains configuration settings to enable using a dead letter sink. This tells the subscription what happens to events that cannot be delivered to the subscriber. When this is configured, events that fail to be delivered are sent to the dead letter sink destination. The destination can be a Knative service or a URI. In the example, the destination is a <code>Service</code> object, or Knative service, named <code>example-sink</code>.</li>
|
||
<li>The <code>backoffDelay</code> delivery parameter specifies the time delay before an event delivery retry is attempted after a failure. The duration of the <code>backoffDelay</code> parameter is specified using the ISO 8601 format. For example, <code>PT1S</code> specifies a 1 second delay.</li>
|
||
<li>The <code>backoffPolicy</code> delivery parameter can be used to specify the retry back off policy. The policy can be specified as either <code>linear</code> or <code>exponential</code>. When using the <code>linear</code> back off policy, the back off delay is the time interval specified between retries. When using the <code>exponential</code> back off policy, the back off delay is equal to <code>backoffDelay*2^&lt;numberOfRetries&gt;</code>.</li>
|
||
<li><code>retry</code> specifies the number of times that event delivery is retried before the event is sent to the dead letter sink.</li>
|
||
</ul>
|
||
<h2 id="broker-event-delivery">Broker event delivery</h2>
|
||
<p>See the <a href="../broker/broker-event-delivery">broker</a> documentation.</p>
|
||
<h2 id="channel-event-delivery">Channel event delivery</h2>
|
||
<p>Failed events may, depending on the specific Channel implementation in use, be
|
||
enhanced with extension attributes prior to forwarding to the<code>deadLetterSink</code>.
|
||
These extension attributes are as follows:</p>
|
||
<ul>
|
||
<li>
|
||
<p><strong>knativeerrorcode</strong></p>
|
||
<ul>
|
||
<li><strong>Type:</strong> Int</li>
|
||
<li><strong>Description:</strong> The HTTP Response <strong>StatusCode</strong> from the final event
|
||
dispatch attempt.</li>
|
||
<li><strong>Constraints:</strong> Should always be present as every HTTP Response contains
|
||
a <strong>StatusCode</strong>.</li>
|
||
<li><strong>Examples:</strong>
|
||
<ul>
|
||
<li>&ldquo;500&rdquo;</li>
|
||
<li>&hellip;any HTTP StatusCode&hellip;</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><strong>knativeerrordata</strong></p>
|
||
<ul>
|
||
<li><strong>Type:</strong> String</li>
|
||
<li><strong>Description:</strong> The HTTP Response <strong>Body</strong> from the final event dispatch
|
||
attempt.</li>
|
||
<li><strong>Constraints:</strong> Will be empty if the HTTP Response <strong>Body</strong> was empty,
|
||
and might be truncated if the length is excessive.</li>
|
||
<li><strong>Examples:</strong>
|
||
<ul>
|
||
<li>&lsquo;Internal Server Error: Failed to process event.&rsquo;</li>
|
||
<li>&lsquo;{&ldquo;key&rdquo;: &ldquo;value&rdquo;}&rsquo;</li>
|
||
<li>&hellip;any HTTP Response Body&hellip;</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3 id="channel-support">Channel Support</h3>
|
||
<p>The table below summarizes what delivery parameters are supported for each channel implementation.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Channel Type</th>
|
||
<th>Supported Delivery Parameters</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>GCP PubSub</td>
|
||
<td>none</td>
|
||
</tr>
|
||
<tr>
|
||
<td>In-Memory</td>
|
||
<td><code>deadLetterSink</code>, <code>retry</code>, <code>backoffPolicy</code>, <code>backoffDelay</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Kafka</td>
|
||
<td><code>deadLetterSink</code>, <code>retry</code>, <code>backoffPolicy</code>, <code>backoffDelay</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Natss</td>
|
||
<td>none</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Brokers</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/broker/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/broker/</guid>
|
||
<description>
|
||
|
||
|
||
<p>Brokers are Kubernetes <a href="https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/">custom resources</a> that define an event mesh for collecting a pool of <a href="https://cloudevents.io/">CloudEvents</a>. Brokers provide a discoverable endpoint, <code>status.address</code>, for event ingress, and triggers for event delivery. Event producers can send events to a broker by POSTing the event to the <code>status.address.url</code> of the broker.</p>
|
||
<p>Event delivery mechanics are an implementation detail that depend on the configured <a href="./configmaps/broker-configmaps/#broker-class-options">broker class</a>. Using brokers and triggers abstracts the details of event routing from the event producer and event consumer.</p>
|
||
<img src="images/broker-workflow.svg" width="70%">
|
||
<p>After an event has entered a broker, it can be forwarded to subscribers by using triggers. Triggers allow events to be filtered by attributes, so that events with particular attributes can be sent to subscribers that have registered interest in events with those attributes.</p>
|
||
<p>A subscriber can be any URL or <em>Addressable</em> resource. Subscribers can also reply to an active request from the broker, and can respond with a new CloudEvent that will be sent back into the broker.</p>
|
||
<p>For most use cases, a single broker per namespace is sufficient, but
|
||
there are several use cases where multiple brokers can simplify
|
||
architecture. For example, separate brokers for events containing Personally
|
||
Identifiable Information (PII) and non-PII events can simplify audit and access
|
||
control rules.</p>
|
||
<h2 id="broker-types">Broker types</h2>
|
||
<p>The following broker types are available for use with Knative Eventing.</p>
|
||
<h3 id="multi-tenant-channel-based-broker">Multi-tenant channel-based broker</h3>
|
||
<p>Knative Eventing provides a multi-tenant (MT) channel-based broker implementation that uses channels for event routing.</p>
|
||
<p>Before you can use the MT channel-based broker, you must install a <a href="../channels/channel-types-defaults">channel implementation</a>.</p>
|
||
<h3 id="alternative-broker-implementations">Alternative broker implementations</h3>
|
||
<p>In the Knative Eventing ecosystem, alternative broker implementations are welcome as long as they respect the <a href="https://github.com/knative/specs/blob/main/specs/eventing/broker.md">broker specifications</a>.</p>
|
||
<p>The following is a list of brokers provided by the community or vendors:</p>
|
||
<h4 id="gcp-broker">GCP broker</h4>
|
||
<p>The GCP broker is optimized for running in GCP. For more details, refer to the <a href="https://github.com/google/knative-gcp/blob/master/docs/install/install-gcp-broker.md">documentation</a>.</p>
|
||
<h4 id="apache-kafka-broker">Apache Kafka broker</h4>
|
||
<p>For information about the Apache Kafka broker, see <a href="./kafka-broker">link</a>.</p>
|
||
<h2 id="next-steps">Next steps</h2>
|
||
<ul>
|
||
<li>Create a <a href="./create-mtbroker">MT channel-based broker</a>.</li>
|
||
<li>Configure <a href="./configmaps/broker-configmaps">default broker ConfigMap settings</a>.</li>
|
||
<li>View the <a href="https://github.com/knative/specs/blob/main/specs/eventing/broker.md">broker specifications</a>.</li>
|
||
</ul>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Sink</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/sink/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/sink/</guid>
|
||
<description>
|
||
|
||
|
||
<p>A sink is an Addressable resource that acts as a link
|
||
between the Eventing mesh and an entity or system.</p>
|
||
<p>We can connect any source to a sink, such as <code>PingSource</code> and <code>KafkaSink</code> objects:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">sources.knative.dev/v1beta1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">PingSource</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">test-ping-source</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">spec</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">schedule</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;*/1 * * * *&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">jsonData</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;{&#34;message&#34;: &#34;Hello world!&#34;}&#39;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">sink</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ref</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">eventing.knative.dev/v1alpha1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">KafkaSink</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">my-kafka-sink</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><p>We can connect a <code>Trigger</code> object to a sink, so that we can filter events, before sending them to a sink:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">eventing.knative.dev/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Trigger</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">my-service-trigger</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">spec</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">broker</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">filter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">attributes</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">type</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">dev.knative.foo.bar</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">myextension</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">my-extension-value</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">subscriber</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ref</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">eventing.knative.dev/v1alpha1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">KafkaSink</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">my-kafka-sink</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h2 id="setting-up-a-custom-resource-to-be-used-as-a-sink">Setting up a Custom Resource to be used as a sink</h2>
|
||
<p>To allow a Custom Resource to act as a sink for events, there are two things needed:</p>
|
||
<h4 id="1-make-the-resource-addressable">1. Make the resource Addressable</h4>
|
||
<p>To make a Custom Resource Addressable, it needs to contain a <code>status.address.url</code>. More information about <a href="https://github.com/knative/specs/blob/main/specs/eventing/interfaces.md#addressable">Addressable resources</a>.</p>
|
||
<h4 id="2-create-an-addressable-resolver-clusterrole">2. Create an addressable-resolver ClusterRole</h4>
|
||
<p>An addressable-resolver ClusterRole is needed in order to obtain the necessary RBAC rules for the sink to receive events.</p>
|
||
<p>For example, we can create a <code>kafkasinks-addressable-resolver</code> ClusterRole to allow <code>get</code>, <code>list</code>, and <code>watch</code> access to <code>kafkasinks</code> and <code>kafkasinks/status</code></p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">ClusterRole</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">rbac.authorization.k8s.io/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">kafkasinks-addressable-resolver</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">labels</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">kafka.eventing.knative.dev/release</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">devel</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">duck.knative.dev/addressable</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;true&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#8f5902;font-style:italic"># Do not use this role directly. These rules will be added to the &#34;addressable-resolver&#34; role.</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">rules</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#204a87;font-weight:bold">apiGroups</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">eventing.knative.dev</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">resources</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">kafkasinks</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">kafkasinks/status</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">verbs</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">get</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">list</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">watch</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h2 id="knative-sinks">Knative Sinks</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Maintainer</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><a href="./kafka-sink">KafkaSink</a></td>
|
||
<td>Knative</td>
|
||
<td>Send events to a Kafka topic</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://github.com/knative-sandbox/eventing-redis/tree/main/sink">RedisSink</a></td>
|
||
<td>Knative</td>
|
||
<td>Send events to a Redis Stream</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Debugging Knative Eventing</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/debugging/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/debugging/</guid>
|
||
<description>
|
||
|
||
|
||
<p>This is an evolving document on how to debug a non-working Knative Eventing
|
||
setup.</p>
|
||
<h2 id="audience">Audience</h2>
|
||
<p>This document is intended for people that are familiar with the object model of
|
||
<a href="../">Knative Eventing</a>. You don&rsquo;t need to be an expert, but do need to
|
||
know roughly how things fit together.</p>
|
||
<h2 id="prerequisites">Prerequisites</h2>
|
||
<ol>
|
||
<li>Setup <a href="../">Knative Eventing and an Eventing-contrib resource</a>.</li>
|
||
</ol>
|
||
<h2 id="example">Example</h2>
|
||
<p>This guide uses an example consisting of an event source that sends events to a
|
||
function.</p>
|
||
<p><img src="ExampleModel.png" alt="src -> chan -> sub -> svc -> fn"></p>
|
||
<p>See <a href="example.yaml">example.yaml</a> for the entire YAML. For any commands in this
|
||
guide to work, you must apply <a href="example.yaml">example.yaml</a>:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl apply --filename example.yaml
|
||
</code></pre></div><h2 id="triggering-events">Triggering Events</h2>
|
||
<p>Knative events will occur whenever a Kubernetes
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#event-v1-core"><code>Event</code></a>
|
||
occurs in the <code>knative-debug</code> namespace. We can cause this to occur with the
|
||
following commands:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug run to-be-deleted --image<span style="color:#ce5c00;font-weight:bold">=</span>image-that-doesnt-exist --restart<span style="color:#ce5c00;font-weight:bold">=</span>Never
|
||
<span style="color:#8f5902;font-style:italic"># 5 seconds is arbitrary. We want K8s to notice that the Pod needs to be scheduled and generate at least one event.</span>
|
||
sleep <span style="color:#0000cf;font-weight:bold">5</span>
|
||
kubectl --namespace knative-debug delete pod to-be-deleted
|
||
</code></pre></div><p>Then we can see the Kubernetes <code>Event</code>s (note that these are not Knative
|
||
events!):</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get events
|
||
</code></pre></div><p>This should produce output along the lines of:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">LAST SEEN FIRST SEEN COUNT NAME KIND SUBOBJECT TYPE REASON SOURCE MESSAGE
|
||
20s 20s <span style="color:#0000cf;font-weight:bold">1</span> to-be-deleted.157aadb9f376fc4e Pod Normal Scheduled default-scheduler Successfully assigned knative-debug/to-be-deleted to gke-kn24-default-pool-c12ac83b-pjf2
|
||
</code></pre></div><h2 id="where-are-my-events">Where are my events?</h2>
|
||
<p>You&rsquo;ve applied <a href="example.yaml">example.yaml</a> and you are inspecting <code>fn</code>&rsquo;s logs:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug logs -l <span style="color:#000">app</span><span style="color:#ce5c00;font-weight:bold">=</span>fn -c user-container
|
||
</code></pre></div><p>But you don&rsquo;t see any events arrive. Where is the problem?</p>
|
||
<h3 id="control-plane">Control Plane</h3>
|
||
<p>We will first check the control plane, to ensure everything should be working
|
||
properly.</p>
|
||
<h4 id="resources">Resources</h4>
|
||
<p>The first thing to check are all the created resources, do their statuses
|
||
contain <code>ready</code> true?</p>
|
||
<p>We will attempt to determine why from the most basic pieces out:</p>
|
||
<ol>
|
||
<li><code>fn</code> - The <code>Deployment</code> has no dependencies inside Knative.</li>
|
||
<li><code>svc</code> - The <code>Service</code> has no dependencies inside Knative.</li>
|
||
<li><code>chan</code> - The <code>Channel</code> depends on its backing <code>channel implementation</code> and
|
||
somewhat depends on <code>sub</code>.</li>
|
||
<li><code>src</code> - The <code>Source</code> depends on <code>chan</code>.</li>
|
||
<li><code>sub</code> - The <code>Subscription</code> depends on both <code>chan</code> and <code>svc</code>.</li>
|
||
</ol>
|
||
<h5 id="fn"><code>fn</code></h5>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get deployment fn -o <span style="color:#000">jsonpath</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#39;{.status.availableReplicas}&#39;</span>
|
||
</code></pre></div><p>We want to see <code>1</code>. If you don&rsquo;t, then you need to debug the <code>Deployment</code>. Is
|
||
there anything obviously wrong mentioned in the <code>status</code>?</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get deployment fn --output yaml
|
||
</code></pre></div><p>If it is not obvious what is wrong, then you need to debug the <code>Deployment</code>,
|
||
which is out of scope of this document.</p>
|
||
<p>Verify that the <code>Pod</code> is <code>Ready</code>:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get pod -l <span style="color:#000">app</span><span style="color:#ce5c00;font-weight:bold">=</span>fn -o <span style="color:#000">jsonpath</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#39;{.items[*].status.conditions[?(@.type == &#34;Ready&#34;)].status}&#39;</span>
|
||
</code></pre></div><p>This should return <code>True</code>. If it doesn&rsquo;t, then try to debug the <code>Deployment</code>
|
||
using the
|
||
<a href="https://kubernetes.io/docs/tasks/debug-application-cluster/debug-application-introspection/">Kubernetes Application Debugging</a>
|
||
guide.</p>
|
||
<h5 id="svc"><code>svc</code></h5>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get service svc
|
||
</code></pre></div><p>We just want to ensure this exists and has the correct name. If it doesn&rsquo;t
|
||
exist, then you probably need to re-apply <a href="example.yaml">example.yaml</a>.</p>
|
||
<p>Verify it points at the expected pod.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell"><span style="color:#000">svcLabels</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#204a87;font-weight:bold">$(</span>kubectl --namespace knative-debug get service svc -o go-template<span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#39;{{range $k, $v := .spec.selector}}{{ $k }}={{ $v }},{{ end }}&#39;</span> <span style="color:#000;font-weight:bold">|</span> sed <span style="color:#4e9a06">&#39;s/.$//&#39;</span> <span style="color:#204a87;font-weight:bold">)</span>
|
||
kubectl --namespace knative-debug get pods -l <span style="color:#000">$svcLabels</span>
|
||
</code></pre></div><p>This should return a single Pod, which if you inspect is the one generated by
|
||
<code>fn</code>.</p>
|
||
<h5 id="chan"><code>chan</code></h5>
|
||
<p><code>chan</code> uses the
|
||
<a href="https://github.com/knative/eventing/tree/release-0.23/config/channels/in-memory-channel"><code>in-memory-channel</code></a>.
|
||
This is a very basic channel and has few
|
||
failure modes that will be exhibited in <code>chan</code>&rsquo;s <code>status</code>.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get channel.messaging.knative.dev chan -o <span style="color:#000">jsonpath</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#39;{.status.conditions[?(@.type == &#34;Ready&#34;)].status}&#39;</span>
|
||
</code></pre></div><p>This should return <code>True</code>. If it doesn&rsquo;t, get the full resource:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get channel.messaging.knative.dev chan --output yaml
|
||
</code></pre></div><p>If <code>status</code> is completely missing, it implies that something is wrong with the
|
||
<code>in-memory-channel</code> controller. See <a href="#channel-controller">Channel Controller</a>.</p>
|
||
<p>Next verify that <code>chan</code> is addressable:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get channel.messaging.knative.dev chan -o <span style="color:#000">jsonpath</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#39;{.status.address.hostname}&#39;</span>
|
||
</code></pre></div><p>This should return a URI, likely ending in &lsquo;.cluster.local&rsquo;. If it doesn&rsquo;t, then
|
||
it implies that something went wrong during reconciliation. See
|
||
<a href="#channel-controller">Channel Controller</a>.</p>
|
||
<p>We will verify that the two resources that the <code>chan</code> creates exist and are
|
||
<code>Ready</code>.</p>
|
||
<h6 id="service"><code>Service</code></h6>
|
||
<p><code>chan</code> creates a K8s <code>Service</code>.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get service -l messaging.knative.dev/role<span style="color:#ce5c00;font-weight:bold">=</span>in-memory-channel
|
||
</code></pre></div><p>It&rsquo;s spec is completely unimportant, as Istio will ignore it. It just needs to
|
||
exist so that <code>src</code> can send events to it. If it doesn&rsquo;t exist, it implies that
|
||
something went wrong during <code>chan</code> reconciliation. See
|
||
<a href="#channel-controller">Channel Controller</a>.</p>
|
||
<h5 id="src"><code>src</code></h5>
|
||
<p><code>src</code> is a <a href="../sources/apiserversource"><code>ApiServerSource</code></a>.</p>
|
||
<p>First we will verify that <code>src</code> is writing to <code>chan</code>.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get apiserversource src -o <span style="color:#000">jsonpath</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#39;{.spec.sink}&#39;</span>
|
||
</code></pre></div><p>Which should return
|
||
<code>map[apiVersion:messaging.knative.dev/v1 kind:Channel name:chan]</code>. If it
|
||
doesn&rsquo;t, then <code>src</code> was setup incorrectly and its <code>spec</code> needs to be fixed.
|
||
Fixing should be as simple as updating its <code>spec</code> to have the correct <code>sink</code>
|
||
(see <a href="example.yaml">example.yaml</a>).</p>
|
||
<p>Now that we know <code>src</code> is sending to <code>chan</code>, let&rsquo;s verify that it is <code>Ready</code>.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get apiserversource src -o <span style="color:#000">jsonpath</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#39;{.status.conditions[?(.type == &#34;Ready&#34;)].status}&#39;</span>
|
||
</code></pre></div><h4 id="sub"><code>sub</code></h4>
|
||
<p><code>sub</code> is a <code>Subscription</code> from <code>chan</code> to <code>fn</code>.</p>
|
||
<p>Verify that <code>sub</code> is <code>Ready</code>:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get subscription sub -o <span style="color:#000">jsonpath</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#39;{.status.conditions[?(.type == &#34;Ready&#34;)].status}&#39;</span>
|
||
</code></pre></div><p>This should return <code>True</code>. If it doesn&rsquo;t then, look at all the status entries.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get subscription sub --output yaml
|
||
</code></pre></div><h4 id="controllers">Controllers</h4>
|
||
<p>Each of the resources has a Controller that is watching it. As of today, they
|
||
tend to do a poor job of writing failure status messages and events, so we need
|
||
to look at the Controller&rsquo;s logs.</p>
|
||
<h5 id="deployment-controller">Deployment Controller</h5>
|
||
<p>The Kubernetes Deployment Controller, controlling <code>fn</code>, is out of scope for this
|
||
document.</p>
|
||
<h5 id="service-controller">Service Controller</h5>
|
||
<p>The Kubernetes Service Controller, controlling <code>svc</code>, is out of scope for this
|
||
document.</p>
|
||
<h5 id="channel-controller">Channel Controller</h5>
|
||
<p>There is not a single <code>Channel</code> Controller. Instead, there is one
|
||
Controller for each Channel CRD. <code>chan</code> uses the
|
||
<code>InMemoryChannel</code> <code>Channel CRD</code>, whose Controller is:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-eventing get pod -l messaging.knative.dev/channel<span style="color:#ce5c00;font-weight:bold">=</span>in-memory-channel,messaging.knative.dev/role<span style="color:#ce5c00;font-weight:bold">=</span>controller --output yaml
|
||
</code></pre></div><p>See its logs with:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-eventing logs -l messaging.knative.dev/channel<span style="color:#ce5c00;font-weight:bold">=</span>in-memory-channel,messaging.knative.dev/role<span style="color:#ce5c00;font-weight:bold">=</span>controller
|
||
</code></pre></div><p>Pay particular attention to any lines that have a logging level of <code>warning</code> or
|
||
<code>error</code>.</p>
|
||
<h5 id="source-controller">Source Controller</h5>
|
||
<p>Each Source will have its own Controller. <code>src</code> is a <code>ApiServerSource</code>, so
|
||
its Controller is:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-eventing get pod -l <span style="color:#000">app</span><span style="color:#ce5c00;font-weight:bold">=</span>sources-controller
|
||
</code></pre></div><p>This is actually a single binary that runs multiple Source Controllers,
|
||
importantly including <a href="#apiserversource-controller">ApiServerSource Controller</a>.</p>
|
||
<h6 id="apiserversource-controller">ApiServerSource Controller</h6>
|
||
<p>The <code>ApiServerSource</code> Controller is run in the same binary as some other Source
|
||
Controllers from Eventing. It is:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug get pod -l eventing.knative.dev/sourceName<span style="color:#ce5c00;font-weight:bold">=</span>src,eventing.knative.dev/source<span style="color:#ce5c00;font-weight:bold">=</span>apiserver-source-controller
|
||
</code></pre></div><p>View its logs with:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-debug logs -l eventing.knative.dev/sourceName<span style="color:#ce5c00;font-weight:bold">=</span>src,eventing.knative.dev/source<span style="color:#ce5c00;font-weight:bold">=</span>apiserver-source-controller
|
||
</code></pre></div><p>Pay particular attention to any lines that have a logging level of <code>warning</code> or
|
||
<code>error</code>.</p>
|
||
<h5 id="subscription-controller">Subscription Controller</h5>
|
||
<p>The <code>Subscription</code> Controller controls <code>sub</code>. It attempts to resolve the
|
||
addresses that a <code>Channel</code> should send events to, and once resolved, inject
|
||
those into the <code>Channel</code>&rsquo;s <code>spec.subscribable</code>.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-eventing get pod -l <span style="color:#000">app</span><span style="color:#ce5c00;font-weight:bold">=</span>eventing-controller
|
||
</code></pre></div><p>View its logs with:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-eventing logs -l <span style="color:#000">app</span><span style="color:#ce5c00;font-weight:bold">=</span>eventing-controller
|
||
</code></pre></div><p>Pay particular attention to any lines that have a logging level of <code>warning</code> or
|
||
<code>error</code>.</p>
|
||
<h3 id="data-plane">Data Plane</h3>
|
||
<p>The entire <a href="#control-plane">Control Plane</a> looks healthy, but we&rsquo;re still not
|
||
getting any events. Now we need to investigate the data plane.</p>
|
||
<p>The Knative event takes the following path:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Event is generated by <code>src</code>.</p>
|
||
<ul>
|
||
<li>In this case, it is caused by having a Kubernetes <code>Event</code> trigger it, but
|
||
as far as Knative is concerned, the <code>Source</code> is generating the event denovo
|
||
(from nothing).</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><code>src</code> is POSTing the event to <code>chan</code>&rsquo;s address,
|
||
<code>http://chan-kn-channel.knative-debug.svc.cluster.local</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p>The Channel Dispatcher receives the request and introspects the Host header
|
||
to determine which <code>Channel</code> it corresponds to. It sees that it corresponds
|
||
to <code>knative-debug/chan</code> so forwards the request to the subscribers defined in
|
||
<code>sub</code>, in particular <code>svc</code>, which is backed by <code>fn</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>fn</code> receives the request and logs it.</p>
|
||
</li>
|
||
</ol>
|
||
<p>We will investigate components in the order in which events should travel.</p>
|
||
<h4 id="channel-dispatcher">Channel Dispatcher</h4>
|
||
<p>The Channel Dispatcher is the component that receives POSTs pushing events into
|
||
<code>Channel</code>s and then POSTs to subscribers of those <code>Channel</code>s when an event is
|
||
received. For the <code>in-memory-channel</code> used in this example, there is a single
|
||
binary that handles both the receiving and dispatching sides for all
|
||
<code>in-memory-channel</code> <code>Channel</code>s.</p>
|
||
<p>First we will inspect the Dispatcher&rsquo;s logs to see if it is anything obvious:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl --namespace knative-eventing logs -l messaging.knative.dev/channel<span style="color:#ce5c00;font-weight:bold">=</span>in-memory-channel,messaging.knative.dev/role<span style="color:#ce5c00;font-weight:bold">=</span>dispatcher -c dispatcher
|
||
</code></pre></div><p>Ideally we will see lines like:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell"><span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;level&#34;</span>:<span style="color:#4e9a06">&#34;info&#34;</span>,<span style="color:#4e9a06">&#34;ts&#34;</span>:<span style="color:#4e9a06">&#34;2019-08-16T13:50:55.424Z&#34;</span>,<span style="color:#4e9a06">&#34;logger&#34;</span>:<span style="color:#4e9a06">&#34;inmemorychannel-dispatcher.in-memory-channel-dispatcher&#34;</span>,<span style="color:#4e9a06">&#34;caller&#34;</span>:<span style="color:#4e9a06">&#34;provisioners/message_receiver.go:147&#34;</span>,<span style="color:#4e9a06">&#34;msg&#34;</span>:<span style="color:#4e9a06">&#34;Request mapped to channel: knative-debug/chan-kn-channel&#34;</span>,<span style="color:#4e9a06">&#34;knative.dev/controller&#34;</span>:<span style="color:#4e9a06">&#34;in-memory-channel-dispatcher&#34;</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
||
<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;level&#34;</span>:<span style="color:#4e9a06">&#34;info&#34;</span>,<span style="color:#4e9a06">&#34;ts&#34;</span>:<span style="color:#4e9a06">&#34;2019-08-16T13:50:55.425Z&#34;</span>,<span style="color:#4e9a06">&#34;logger&#34;</span>:<span style="color:#4e9a06">&#34;inmemorychannel-dispatcher.in-memory-channel-dispatcher&#34;</span>,<span style="color:#4e9a06">&#34;caller&#34;</span>:<span style="color:#4e9a06">&#34;provisioners/message_dispatcher.go:112&#34;</span>,<span style="color:#4e9a06">&#34;msg&#34;</span>:<span style="color:#4e9a06">&#34;Dispatching message to http://svc.knative-debug.svc.cluster.local/&#34;</span>,<span style="color:#4e9a06">&#34;knative.dev/controller&#34;</span>:<span style="color:#4e9a06">&#34;in-memory-channel-dispatcher&#34;</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
||
<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;level&#34;</span>:<span style="color:#4e9a06">&#34;info&#34;</span>,<span style="color:#4e9a06">&#34;ts&#34;</span>:<span style="color:#4e9a06">&#34;2019-08-16T13:50:55.981Z&#34;</span>,<span style="color:#4e9a06">&#34;logger&#34;</span>:<span style="color:#4e9a06">&#34;inmemorychannel-dispatcher.in-memory-channel-dispatcher&#34;</span>,<span style="color:#4e9a06">&#34;caller&#34;</span>:<span style="color:#4e9a06">&#34;provisioners/message_receiver.go:140&#34;</span>,<span style="color:#4e9a06">&#34;msg&#34;</span>:<span style="color:#4e9a06">&#34;Received request for chan-kn-channel.knative-debug.svc.cluster.local&#34;</span>,<span style="color:#4e9a06">&#34;knative.dev/controller&#34;</span>:<span style="color:#4e9a06">&#34;in-memory-channel-dispatcher&#34;</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
||
</code></pre></div><p>Which shows that the request is being received and then sent to <code>svc</code>, which is
|
||
returning a 2XX response code (likely 200, 202, or 204).</p>
|
||
<p>However if we see something like:</p>
|
||
<!--
|
||
NOTE: This error has been produced by settings spec.ports[0].port to 8081
|
||
kubectl patch -n knative-debug svc svc -p '{"spec":{"ports": [{"port": 8081, "targetPort":8080}]}}' --type='merge'
|
||
-->
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell"><span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;level&#34;</span>:<span style="color:#4e9a06">&#34;info&#34;</span>,<span style="color:#4e9a06">&#34;ts&#34;</span>:<span style="color:#4e9a06">&#34;2019-08-16T16:10:16.859Z&#34;</span>,<span style="color:#4e9a06">&#34;logger&#34;</span>:<span style="color:#4e9a06">&#34;inmemorychannel-dispatcher.in-memory-channel-dispatcher&#34;</span>,<span style="color:#4e9a06">&#34;caller&#34;</span>:<span style="color:#4e9a06">&#34;provisioners/message_receiver.go:140&#34;</span>,<span style="color:#4e9a06">&#34;msg&#34;</span>:<span style="color:#4e9a06">&#34;Received request for chan-kn-channel.knative-debug.svc.cluster.local&#34;</span>,<span style="color:#4e9a06">&#34;knative.dev/controller&#34;</span>:<span style="color:#4e9a06">&#34;in-memory-channel-dispatcher&#34;</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
||
<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;level&#34;</span>:<span style="color:#4e9a06">&#34;info&#34;</span>,<span style="color:#4e9a06">&#34;ts&#34;</span>:<span style="color:#4e9a06">&#34;2019-08-16T16:10:16.859Z&#34;</span>,<span style="color:#4e9a06">&#34;logger&#34;</span>:<span style="color:#4e9a06">&#34;inmemorychannel-dispatcher.in-memory-channel-dispatcher&#34;</span>,<span style="color:#4e9a06">&#34;caller&#34;</span>:<span style="color:#4e9a06">&#34;provisioners/message_receiver.go:147&#34;</span>,<span style="color:#4e9a06">&#34;msg&#34;</span>:<span style="color:#4e9a06">&#34;Request mapped to channel: knative-debug/chan-kn-channel&#34;</span>,<span style="color:#4e9a06">&#34;knative.dev/controller&#34;</span>:<span style="color:#4e9a06">&#34;in-memory-channel-dispatcher&#34;</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
||
<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;level&#34;</span>:<span style="color:#4e9a06">&#34;info&#34;</span>,<span style="color:#4e9a06">&#34;ts&#34;</span>:<span style="color:#4e9a06">&#34;2019-08-16T16:10:16.859Z&#34;</span>,<span style="color:#4e9a06">&#34;logger&#34;</span>:<span style="color:#4e9a06">&#34;inmemorychannel-dispatcher.in-memory-channel-dispatcher&#34;</span>,<span style="color:#4e9a06">&#34;caller&#34;</span>:<span style="color:#4e9a06">&#34;provisioners/message_dispatcher.go:112&#34;</span>,<span style="color:#4e9a06">&#34;msg&#34;</span>:<span style="color:#4e9a06">&#34;Dispatching message to http://svc.knative-debug.svc.cluster.local/&#34;</span>,<span style="color:#4e9a06">&#34;knative.dev/controller&#34;</span>:<span style="color:#4e9a06">&#34;in-memory-channel-dispatcher&#34;</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
||
<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;level&#34;</span>:<span style="color:#4e9a06">&#34;error&#34;</span>,<span style="color:#4e9a06">&#34;ts&#34;</span>:<span style="color:#4e9a06">&#34;2019-08-16T16:10:38.169Z&#34;</span>,<span style="color:#4e9a06">&#34;logger&#34;</span>:<span style="color:#4e9a06">&#34;inmemorychannel-dispatcher.in-memory-channel-dispatcher&#34;</span>,<span style="color:#4e9a06">&#34;caller&#34;</span>:<span style="color:#4e9a06">&#34;fanout/fanout_handler.go:121&#34;</span>,<span style="color:#4e9a06">&#34;msg&#34;</span>:<span style="color:#4e9a06">&#34;Fanout had an error&#34;</span>,<span style="color:#4e9a06">&#34;knative.dev/controller&#34;</span>:<span style="color:#4e9a06">&#34;in-memory-channel-dispatcher&#34;</span>,<span style="color:#4e9a06">&#34;error&#34;</span>:<span style="color:#4e9a06">&#34;Unable to complete request Post http://svc.knative-debug.svc.cluster.local/: dial tcp 10.4.44.156:80: i/o timeout&#34;</span>,<span style="color:#4e9a06">&#34;stacktrace&#34;</span>:<span style="color:#4e9a06">&#34;knative.dev/eventing/pkg/provisioners/fanout.(*Handler).dispatch\n\t/Users/xxxxxx/go/src/knative.dev/eventing/pkg/provisioners/fanout/fanout_handler.go:121\nknative.dev/eventing/pkg/provisioners/fanout.createReceiverFunction.func1.1\n\t/Users/i512777/go/src/knative.dev/eventing/pkg/provisioners/fanout/fanout_handler.go:95&#34;</span><span style="color:#ce5c00;font-weight:bold">}</span>
|
||
</code></pre></div><p>Then we know there was a problem posting to
|
||
<code>http://svc.knative-debug.svc.cluster.local/</code>.</p>
|
||
<p>TODO Finish this section. Especially after the Channel Dispatcher emits K8s
|
||
events about failures.</p>
|
||
<h4 id="fn-1"><code>fn</code></h4>
|
||
<p>TODO Fill in this section.</p>
|
||
<h1 id="todo-finish-the-guide">TODO Finish the guide.</h1>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Accessing CloudEvent traces</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/accessing-traces/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/accessing-traces/</guid>
|
||
<description>
|
||
|
||
|
||
<p>Depending on the request tracing tool that you have installed on your Knative
|
||
Eventing cluster, see the corresponding section for details about how to
|
||
visualize and trace your requests.</p>
|
||
<h2 id="before-you-begin">Before you begin</h2>
|
||
<p>You must have a Knative cluster running with the Eventing component installed. <a href="../../install/">Learn more</a></p>
|
||
<h2 id="configuring-tracing">Configuring tracing</h2>
|
||
<p>With the exception of importers, the Knative Eventing tracing is configured through the
|
||
<code>config-tracing</code> ConfigMap in the <code>knative-eventing</code> namespace.</p>
|
||
<p>Most importers do <em>not</em> use the ConfigMap and instead, use a static 1% sampling rate.</p>
|
||
<p>You can use the <code>config-tracing</code> ConfigMap to configure the following Eventing components:</p>
|
||
<ul>
|
||
<li>Brokers</li>
|
||
<li>Triggers</li>
|
||
<li>InMemoryChannel</li>
|
||
<li>ApiServerSource</li>
|
||
<li>PingSource</li>
|
||
<li>GitlabSource</li>
|
||
<li>KafkaSource</li>
|
||
<li>PrometheusSource</li>
|
||
</ul>
|
||
<p><strong>Example:</strong></p>
|
||
<p>The following example <code>config-tracing</code> ConfigMap samples 10% of all CloudEvents:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">ConfigMap</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">config-tracing</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">namespace</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">knative-eventing</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">data</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">backend</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;zipkin&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">zipkin-endpoint</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;http://zipkin.istio-system.svc.cluster.local:9411/api/v2/spans&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">sample-rate</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;0.1&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span></code></pre></div><h3 id="configuration-options">Configuration options</h3>
|
||
<p>You can configure your <code>config-tracing</code> with following options:</p>
|
||
<ul>
|
||
<li>
|
||
<p><code>backend</code>: Valid values are <code>zipkin</code>, <code>stackdriver</code>, or <code>none</code>. The default is <code>none</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>zipkin-endpoint</code>: Specifies the URL to the zipkin collector where you want to send the traces.
|
||
Must be set if backend is set to <code>zipkin</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>stackdriver-project-id</code>: Specifies the GCP project ID into which the Stackdriver traces are written.
|
||
You must specify the <code>backend</code> as <code>stackdriver</code>. If <code>backend</code>is unspecified, the GCP project ID is read
|
||
from GCP metadata when running on GCP.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>sample-rate</code>: Specifies the sampling rate. Valid values are decimals from <code>0</code> to <code>1</code>
|
||
(interpreted as a float64), which indicate the probability that any given request is sampled.
|
||
An example value is <code>0.5</code>, which gives each request a 50% sampling probablity.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>debug</code>: Enables debugging. Valid values are <code>true</code> or <code>false</code>. Defaults to <code>false</code> when not specified.
|
||
Set to <code>true</code> to enable debug mode, which forces the <code>sample-rate</code> to <code>1.0</code> and sends all spans to
|
||
the server.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id="viewing-your-config-tracing-configmap">Viewing your <code>config-tracing</code> ConfigMap</h3>
|
||
<p>To view your current configuration:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl -n knative-eventing get configmap config-tracing -oyaml
|
||
</code></pre></div><h3 id="editing-and-deploying-your-config-tracing-configmap">Editing and deploying your <code>config-tracing</code> ConfigMap</h3>
|
||
<p>To edit and then immediately deploy changes to your ConfigMap, run the following command:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">kubectl -n knative-eventing edit configmap config-tracing
|
||
</code></pre></div><h2 id="accessing-traces-in-eventing">Accessing traces in Eventing</h2>
|
||
<p>To access the traces, you use either the Zipkin or Jaeger tool. Details about using these tools to access
|
||
traces are provided in the Knative Serving observability section:</p>
|
||
<ul>
|
||
<li><a href="../../serving/accessing-traces#zipkin">Zipkin</a></li>
|
||
<li><a href="../../serving/accessing-traces#jaeger">Jaeger</a></li>
|
||
</ul>
|
||
<h3 id="example">Example</h3>
|
||
<p>The following demonstrates how to trace requests in Knative Eventing with Zipkin, using the
|
||
<a href="https://github.com/knative/eventing/blob/main/test/conformance/broker_tracing_test.go"><code>TestBrokerTracing</code></a>
|
||
End-to-End test.</p>
|
||
<p>For this example, assume the following details:</p>
|
||
<ul>
|
||
<li>Everything happens in the <code>includes-incoming-trace-id-2qszn</code> namespace.</li>
|
||
<li>The Broker is named <code>br</code>.</li>
|
||
<li>There are two Triggers that are associated with the Broker:
|
||
<ul>
|
||
<li><code>transformer</code> - Filters to only allow events whose type is <code>transformer</code>.
|
||
Sends the event to the Kubernetes Service <code>transformer</code>, which will reply with an
|
||
identical event, except the replied event&rsquo;s type will be <code>logger</code>.</li>
|
||
<li><code>logger</code> - Filters to only allow events whose type is <code>logger</code>. Sends the event to
|
||
the Kubernetes Service <code>logger</code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li>An event is sent to the Broker with the type <code>transformer</code>, by the Pod named <code>sender</code>.</li>
|
||
</ul>
|
||
<p>Given the above, the expected path and behavior of an event is as follows:</p>
|
||
<ol>
|
||
<li><code>sender</code> Pod sends the request to the Broker.</li>
|
||
<li>Go to the Broker&rsquo;s ingress Pod.</li>
|
||
<li>Go to the <code>imc-dispatcher</code> Channel (imc stands for InMemoryChannel).</li>
|
||
<li>Go to both Triggers.
|
||
<ol>
|
||
<li>Go to the Broker&rsquo;s filter Pod for the Trigger <code>logger</code>. The Trigger&rsquo;s filter ignores this event.</li>
|
||
<li>Go to the Broker&rsquo;s filter Pod for the Trigger <code>transformer</code>. The filter does pass, so it goes to the Kubernetes Service pointed at, also named <code>transformer</code>.
|
||
<ol>
|
||
<li><code>transformer</code> Pod replies with the modified event.</li>
|
||
<li>Go to an InMemory dispatcher.</li>
|
||
<li>Go to the Broker&rsquo;s ingress Pod.</li>
|
||
<li>Go to the InMemory dispatcher.</li>
|
||
<li>Go to both Triggers.
|
||
<ol>
|
||
<li>Go to the Broker&rsquo;s filter Pod for the Trigger <code>transformer</code>. The Trigger&rsquo;s filter ignores the event.</li>
|
||
<li>Go to the Broker&rsquo;s filter Pod for the Trigger <code>logger</code>. The filter passes.
|
||
<ol>
|
||
<li>Go to the <code>logger</code> Pod. There is no reply.</li>
|
||
</ol>
|
||
</li>
|
||
</ol>
|
||
</li>
|
||
</ol>
|
||
</li>
|
||
</ol>
|
||
</li>
|
||
</ol>
|
||
<p>This is a screenshot of the trace view in Zipkin. All the red letters have been added to the screenshot and correspond to the expectations earlier in this section:</p>
|
||
<p><img src="../images/AnnotatedTrace.png" alt="Annotated Trace"></p>
|
||
<p>This is the same screenshot without the annotations.</p>
|
||
<p><img src="../images/RawTrace.png" alt="Raw Trace"></p>
|
||
<p>If you are interested, here is the <a href="../data/ee46c4c6be1df717b3b82f55b531912f.json">raw JSON</a> of the trace.</p>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Metrics API</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/metrics/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/metrics/</guid>
|
||
<description>
|
||
|
||
|
||
<br>
|
||
<p><strong>NOTE:</strong> The metrics API may change in the future, this serves as a snapshot of the current metrics.</p>
|
||
<h2 id="admin">Admin</h2>
|
||
<p>Administrators can monitor Eventing based on the metrics exposed by each Eventing component.
|
||
Metrics are listed next.</p>
|
||
<h3 id="broker---ingress">Broker - Ingress</h3>
|
||
<p>Use the following metrics to debug how broker ingress performs and what events are dispacthed via the ingress component.
|
||
By aggregating the metrics over the http code, events can be separated into two classes, successful (2xx) and failed events (5xx).</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:left">Metric Name</th>
|
||
<th style="text-align:left">Description</th>
|
||
<th style="text-align:left">Type</th>
|
||
<th style="text-align:left">Tags</th>
|
||
<th style="text-align:left">Unit</th>
|
||
<th style="text-align:left">Status</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:left">event_count</td>
|
||
<td style="text-align:left">Number of events received by a Broker</td>
|
||
<td style="text-align:left">Counter</td>
|
||
<td style="text-align:left">broker_name<br>event_type<br>namespace_name<br>response_code<br>response_code_class<br>unique_name</td>
|
||
<td style="text-align:left">Dimensionless</td>
|
||
<td style="text-align:left">Stable</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">event_dispatch_latencies</td>
|
||
<td style="text-align:left">The time spent dispatching an event to a Channel</td>
|
||
<td style="text-align:left">Histogram</td>
|
||
<td style="text-align:left">broker_name<br>event_type<br>namespace_name<br>response_code<br>response_code_class<br>unique_name</td>
|
||
<td style="text-align:left">Milliseconds</td>
|
||
<td style="text-align:left">Stable</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="broker---filter">Broker - Filter</h3>
|
||
<p>Use the following metrics to debug how broker filter performs and what events are dispatched via the filter component.
|
||
Also user can measure the latency of the actual filtering action on an event.
|
||
By aggregating the metrics over the http code, events can be separated into two classes, successful (2xx) and failed events (5xx).</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:left">Metric Name</th>
|
||
<th style="text-align:left">Description</th>
|
||
<th style="text-align:left">Type</th>
|
||
<th style="text-align:left">Tags</th>
|
||
<th style="text-align:left">Unit</th>
|
||
<th style="text-align:left">Status</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:left">event_count</td>
|
||
<td style="text-align:left">Number of events received by a Broker</td>
|
||
<td style="text-align:left">Counter</td>
|
||
<td style="text-align:left">broker_name<br>container_name=<br>filter_type<br>namespace_name<br>response_code<br>response_code_class<br>trigger_name<br>unique_name</td>
|
||
<td style="text-align:left">Dimensionless</td>
|
||
<td style="text-align:left">Stable</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">event_dispatch_latencies</td>
|
||
<td style="text-align:left">The time spent dispatching an event to a Channel</td>
|
||
<td style="text-align:left">Histogram</td>
|
||
<td style="text-align:left">broker_name<br>container_name<br>filter_type<br>namespace_name<br>response_code<br>response_code_class<br>trigger_name<br>unique_name</td>
|
||
<td style="text-align:left">Milliseconds</td>
|
||
<td style="text-align:left">Stable</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">event_processing_latencies</td>
|
||
<td style="text-align:left">The time spent processing an event before it is dispatched to a Trigger subscriber</td>
|
||
<td style="text-align:left">Histogram</td>
|
||
<td style="text-align:left">broker_name<br>container_name<br>filter_type<br>namespace_name<br>trigger_name<br>unique_name</td>
|
||
<td style="text-align:left">Milliseconds</td>
|
||
<td style="text-align:left">Stable</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="in-memory-dispatcher">In-memory Dispatcher</h3>
|
||
<p>In-memory channel can be evaluated via the following metrics.
|
||
By aggregating the metrics over the http code, events can be separated into two classes, successful (2xx) and failed events (5xx).</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:left">Metric Name</th>
|
||
<th style="text-align:left">Description</th>
|
||
<th style="text-align:left">Type</th>
|
||
<th style="text-align:left">Tags</th>
|
||
<th style="text-align:left">Unit</th>
|
||
<th style="text-align:left">Status</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:left">event_count</td>
|
||
<td style="text-align:left">Number of events dispatched by the in-memory channel</td>
|
||
<td style="text-align:left">Counter</td>
|
||
<td style="text-align:left">container_name<br>event_type=<br>namespace_name=<br>response_code<br>response_code_class<br>unique_name</td>
|
||
<td style="text-align:left">Dimensionless</td>
|
||
<td style="text-align:left">Stable</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">event_dispatch_latencies</td>
|
||
<td style="text-align:left">The time spent dispatching an event from a in-memory Channel</td>
|
||
<td style="text-align:left">Histogram</td>
|
||
<td style="text-align:left">container_name<br>event_type<br>namespace_name=<br>response_code<br>response_code_class<br>unique_name</td>
|
||
<td style="text-align:left">Milliseconds</td>
|
||
<td style="text-align:left">Stable</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p><strong>NOTE:</strong> A number of metrics eg. controller, Go runtime and others are omitted here as they are common across most components. For more about these metrics check the <a href="../../serving/metrics#controller">Serving metrics API section</a>.</p>
|
||
<h3 id="eventing-sources">Eventing sources</h3>
|
||
<p>Eventing sources are created by users who own the related system, so they can trigger applications with events.
|
||
Every source exposes by default a number of metrics to help user monitor events dispatched. Use the following metrics
|
||
to verify that events have been delivered from the source side, thus verifying that the source and any connection with the source work as expected.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:left">Metric Name</th>
|
||
<th style="text-align:left">Description</th>
|
||
<th style="text-align:left">Type</th>
|
||
<th style="text-align:left">Tags</th>
|
||
<th style="text-align:left">Unit</th>
|
||
<th style="text-align:left">Status</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:left">event_count</td>
|
||
<td style="text-align:left">Number of events sent by the source</td>
|
||
<td style="text-align:left">Counter</td>
|
||
<td style="text-align:left">event_source<br>event_type<br>name<br>namespace_name<br>resource_group<br>response_code<br>response_code_class<br>response_error<br>response_timeout</td>
|
||
<td style="text-align:left">Dimensionless</td>
|
||
<td style="text-align:left">Stable</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">retry_event_count</td>
|
||
<td style="text-align:left">Number of events sent by the source in retries</td>
|
||
<td style="text-align:left">Counter</td>
|
||
<td style="text-align:left">event_source<br>event_type<br>name<br>namespace_name<br>resource_group<br>response_code<br>response_code_class<br>response_error<br>response_timeout</td>
|
||
<td style="text-align:left">Dimensionless</td>
|
||
<td style="text-align:left">Stable</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.23-Docs: Knative Eventing code samples</title>
|
||
<link>https://knative.dev/v0.23-docs/eventing/samples/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.23-docs/eventing/samples/</guid>
|
||
<description>
|
||
|
||
|
||
<p>Use the following code samples to help you understand the various use cases for
|
||
Knative Eventing and Event Sources.
|
||
<a href="../">Learn more about Knative Eventing and Eventing Sources</a>.</p>
|
||
<p><a href="../../samples"><strong>See all Knative code samples</strong></a></p>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
</channel>
|
||
</rss>
|