Skip to content

Commit 91ed50c

Browse files
authored
Merge pull request #51031 from abrennan89/SRVKE-1276
[SRVKE-1276]: Add trigger event delivery order docs
2 parents b06f10e + c39b359 commit 91ed50c

File tree

3 files changed

+53
-0
lines changed

3 files changed

+53
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * /serverless/develop/serverless-triggers.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="trigger-event-delivery-config_{context}"]
7+
= Configuring event delivery ordering for triggers
8+
9+
If you are using a Kafka broker, you can configure the delivery order of events from triggers to event sinks.
10+
11+
.Prerequisites
12+
13+
* The {ServerlessOperatorName}, Knative Eventing, and Knative Kafka are installed on your {product-title} cluster.
14+
* Kafka broker is enabled for use on your cluster, and you have created a Kafka broker.
15+
* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
16+
* You have installed the OpenShift (`oc`) CLI.
17+
18+
.Procedure
19+
20+
. Create or modify a `Trigger` object and set the `kafka.eventing.knative.dev/delivery.order` annotation:
21+
+
22+
[source,yaml]
23+
----
24+
apiVersion: eventing.knative.dev/v1
25+
kind: Trigger
26+
metadata:
27+
name: <trigger_name>
28+
annotations:
29+
kafka.eventing.knative.dev/delivery.order: ordered
30+
...
31+
----
32+
+
33+
The supported consumer delivery guarantees are:
34+
+
35+
`unordered`:: An unordered consumer is a non-blocking consumer that delivers messages unordered, while preserving proper offset management.
36+
+
37+
`ordered`:: An ordered consumer is a per-partition blocking consumer that waits for a successful response from the CloudEvent subscriber before it delivers the next message of the partition.
38+
+
39+
The default ordering guarantee is `unordered`.
40+
41+
. Apply the `Trigger` object:
42+
+
43+
[source,terminal]
44+
----
45+
$ oc apply -f <filename>
46+
----

serverless/develop/serverless-event-delivery.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,6 @@ include::modules/serverless-event-delivery-parameters.adoc[leveloffset=+1]
1616

1717
// configuring parameters examples
1818
include::modules/serverless-configuring-event-delivery-examples.adoc[leveloffset=+1]
19+
20+
// event delivery ordering
21+
include::modules/trigger-event-delivery-config.adoc[leveloffset=+1]

serverless/develop/serverless-triggers.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ toc::[]
88

99
include::snippets/serverless-brokers-intro.adoc[]
1010

11+
If you are using a Kafka broker, you can configure the delivery order of events from triggers to event sinks. See xref:../../serverless/develop/serverless-triggers.adoc#trigger-event-delivery-config_serverless-triggers[Configuring event delivery ordering for triggers].
12+
1113
// ODC
1214
include::modules/serverless-create-trigger-odc.adoc[leveloffset=+1]
1315
// kn trigger
@@ -17,6 +19,8 @@ include::modules/kn-trigger-describe.adoc[leveloffset=+1]
1719
include::modules/kn-trigger-filtering.adoc[leveloffset=+1]
1820
include::modules/kn-trigger-update.adoc[leveloffset=+1]
1921
include::modules/delete-kn-trigger.adoc[leveloffset=+1]
22+
// event delivery config
23+
include::modules/trigger-event-delivery-config.adoc[leveloffset=+1]
2024

2125
[id="next-steps_serverless-triggers"]
2226
== Next steps

0 commit comments

Comments
 (0)