ricardozanini commented on code in PR #570:
URL:
https://github.com/apache/incubator-kie-kogito-docs/pull/570#discussion_r1520137208
##########
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.
+
+Sonataflow can analyze the event definitions from `spec.flow` and create
`SinkBinding`/`Trigger` based the type of the event. Then the workflow service
can utilize them for event communications. The 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.
Review Comment:
```suggestion
1. Knative is installed on the cluster and Knative Eventing is initiated
with a `KnativeEventing` CR.
```
##########
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.
+
+Sonataflow can analyze the event definitions from `spec.flow` and create
`SinkBinding`/`Trigger` based the type of the event. Then the workflow service
can utilize them for event communications. The 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
Sonataflow operator will read events from `default`
Review Comment:
```suggestion
2. a broker named `default` is created. Currently all Triggers created by
the {operator_name} will read events from `default`
```
##########
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.
+
+Sonataflow can analyze the event definitions from `spec.flow` and create
`SinkBinding`/`Trigger` based the type of the event. Then the workflow service
can utilize them for event communications. The 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]
Review Comment:
```suggestion
{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 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].
```
##########
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.
+
+Sonataflow can analyze the event definitions from `spec.flow` and create
`SinkBinding`/`Trigger` based the type of the event. Then the workflow service
can utilize them for event communications. The 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
Sonataflow operator will read events from `default`
+
+== Configuring the workflow
+
+In order for operator to create the `SinkBinding` resources, the workflow must
provide the sink information in `spec.sink`.
+
+.Example of a workflow with events
+[source,yaml]
+--
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlow
+metadata:
+...
+spec:
+ sink:
+ ref:
+ name: default
+ namespace: greeting
+ apiVersion: eventing.knative.dev/v1
+ kind: Broker
+ flow:
+ events:
Review Comment:
```suggestion
events: <2>
```
##########
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.
+
+Sonataflow can analyze the event definitions from `spec.flow` and create
`SinkBinding`/`Trigger` based the type of the event. Then the workflow service
can utilize them for event communications. The 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
Sonataflow operator will read events from `default`
+
+== Configuring the workflow
+
+In order for operator to create the `SinkBinding` resources, the workflow must
provide the sink information in `spec.sink`.
Review Comment:
```suggestion
For the operator to create the `SinkBinding` resources, the workflow must
provide the sink information in `spec.sink`.
```
##########
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.
+
+Sonataflow can analyze the event definitions from `spec.flow` and create
`SinkBinding`/`Trigger` based the type of the event. Then the workflow service
can utilize them for event communications. The 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
Sonataflow operator will read events from `default`
+
+== Configuring the workflow
+
+In order for operator to create the `SinkBinding` resources, the workflow must
provide the sink information in `spec.sink`.
+
+.Example of a workflow with events
+[source,yaml]
+--
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlow
+metadata:
+...
+spec:
+ sink:
+ ref:
+ name: default
+ namespace: greeting
+ apiVersion: eventing.knative.dev/v1
+ kind: Broker
+ flow:
+ events:
+ - name: requestQuote
+ type: kogito.sw.request.quote
+ kind: produced
+ - name: aggregatedQuotesResponse,
+ type: kogito.loanbroker.aggregated.quotes.response,
+ kind: consumed,
+ source: /kogito/serverless/loanbroker/aggregator
+...
+--
+* `spec.sink.ref` defines the sink that all created sinkBinding will use as
the destination sink for producing events
+* `spec.flow.events` lists all the events referenced in the workflow. Events
with `produced` kind will trigger the creation of `SinkBindings` by the
Sonataflow operator, while those labeled as `consumed` will lead to the
generation of `Triggers`.
Review Comment:
```suggestion
<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`.
```
##########
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.
+
+Sonataflow can analyze the event definitions from `spec.flow` and create
`SinkBinding`/`Trigger` based the type of the event. Then the workflow service
can utilize them for event communications. The 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
Sonataflow operator will read events from `default`
+
+== Configuring the workflow
+
+In order for operator to create the `SinkBinding` resources, the workflow must
provide the sink information in `spec.sink`.
+
+.Example of a workflow with events
+[source,yaml]
+--
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlow
+metadata:
+...
+spec:
+ sink:
+ ref:
Review Comment:
```suggestion
ref: <1>
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
