This is an automated email from the ASF dual-hosted git repository.
dhanak pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-kie-kogito-docs.git
The following commit(s) were added to refs/heads/main by this push:
new fd1cb5fd8 doc for knative eventing in operator (#570)
fd1cb5fd8 is described below
commit fd1cb5fd8d321e2302aca56c87f64863956ce890
Author: richard wang <[email protected]>
AuthorDate: Thu Mar 14 10:23:27 2024 -0400
doc for knative eventing in operator (#570)
* doc for knative eventing in operator
* Incorporating @kaldesai review
Co-authored-by: Kalyani Desai <[email protected]>
---------
Co-authored-by: Ricardo Zanini
<[email protected]>
Co-authored-by: Kalyani Desai <[email protected]>
---
serverlessworkflow/modules/ROOT/nav.adoc | 1 +
.../configuring-knative-eventing-resources.adoc | 59 ++++++++++++++++++++++
2 files changed, 60 insertions(+)
diff --git a/serverlessworkflow/modules/ROOT/nav.adoc
b/serverlessworkflow/modules/ROOT/nav.adoc
index 8e254442f..160b63617 100644
--- a/serverlessworkflow/modules/ROOT/nav.adoc
+++ b/serverlessworkflow/modules/ROOT/nav.adoc
@@ -74,6 +74,7 @@
*** xref:cloud/operator/building-custom-images.adoc[Building Custom Images]
*** xref:cloud/operator/customize-podspec.adoc[Custom Workflow PodSpec]
*** xref:cloud/operator/service-discovery.adoc[Service Discovery]
+*** xref:cloud/operator/configuring-knative-eventing-resources.adoc[Knative
Eventing]
*** xref:cloud/operator/known-issues.adoc[Roadmap and Known Issues]
* Integrations
** xref:integrations/core-concepts.adoc[]
diff --git
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/configuring-knative-eventing-resources.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/configuring-knative-eventing-resources.adoc
new file mode 100644
index 000000000..696554c44
--- /dev/null
+++
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/configuring-knative-eventing-resources.adoc
@@ -0,0 +1,59 @@
+= Knative Eventing
+:compat-mode!:
+// Metadata:
+:description: Configuration of knatve eventing deployed by the operator
+:keywords: kogito, sonataflow, workflow, serverless, operator, kubernetes,
knative, knative-eventing, events
+
+This document describes how you can configure the workflows to let operator
create the knative eventing resources on Kubernetes.
+
+{operator_name} can analyze the event definitions from the `spec.flow` and
create `SinkBinding`/`Trigger` based on the type of the event. Then the
workflow service can utilize them for event communications. The same purpose of
this feature in quarkus extension can be found
xref:use-cases/advanced-developer-use-cases/event-orchestration/consume-produce-events-with-knative-eventing.adoc#ref-example-sw-event-definition-knative[here].
+
+== Prerequisite
+1. Knative is installed on the cluster and Knative Eventing is initiated with
a `KnativeEventing` CR.
+2. A broker named `default` is created. Currently all Triggers created by the
{operator_name} will read events from `default`
+
+== Configuring the workflow
+
+For the operator to create the `SinkBinding` resources, the workflow must
provide the sink information in `spec.sink`.
+
+.Example of a workflow with events
+[source,yaml,subs="attributes+"]
+--
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlow
+metadata:
+...
+spec:
+ sink:
+ ref: <1>
+ name: default
+ namespace: greeting
+ apiVersion: eventing.knative.dev/v1
+ kind: Broker
+ flow:
+ events: <2>
+ - name: requestQuote
+ type: kogito.sw.request.quote
+ kind: produced
+ - name: aggregatedQuotesResponse,
+ type: kogito.loanbroker.aggregated.quotes.response,
+ kind: consumed,
+ source: /kogito/serverless/loanbroker/aggregator
+...
+--
+<1> `spec.sink.ref` defines the sink that all created sinkBinding will use as
the destination sink for producing events
+<2> `spec.flow.events` lists all the events referenced in the workflow. Events
with `produced` kind will trigger the creation of `SinkBindings` by the
{operator_name}, while those labeled as `consumed` will lead to the generation
of `Triggers`.
+
+[NOTE]
+====
+Knative resources are not watched by the operator, indicating they will not
undergo automatic reconciliation. This grants users the freedom to make updates
at their preference.
+====
+
+== Additional resources
+
+* https://knative.dev/docs/eventing/[Knative Eventing official site]
+*
xref:use-cases/advanced-developer-use-cases/event-orchestration/consume-produce-events-with-knative-eventing.adoc[quarkus
extension for knative eventing]
+*
xref:job-services/core-concepts.adoc#knative-eventing-supporting-resources[knative
eventing for Job service]
+* xref:data-index/data-index-core-concepts.adoc#_knative_eventing[knative
eventing for data index]
+
+include::../../../pages/_common-content/report-issue.adoc[]
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
