kaldesai commented on code in PR #685:
URL:
https://github.com/apache/incubator-kie-kogito-docs/pull/685#discussion_r1829480890
##########
serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc:
##########
@@ -180,6 +180,241 @@ When you use the common PostgreSQL configuration, the
database schema for each s
For example, `sonataflow-platform-example-data-index-service`.
====
+== Configuring the Supporting Services Eventing System
+
+In general, the following events are produced in a {product_name} installation:
+
+* Workflow outgoing and incoming business events.
+* {product_name} system events sent from the workflow to the Data Index and
Job Service respectively.
+* {product_name} system events sent from the Jobs Service to the Data Index
Service.
+
+The {operator_name} is designed to use the link:{knative_eventing_url}[Knative
Eventing] system to resolve all the event communication between these services.
+
+[NOTE]
+====
+In a regular {product_name} installation, the preferred method is to use the
<<platform-scoped-eventing-system-configuration, Platform scoped Eventing
System Configuration>>, while the
<<service-scoped-eventing-system-configuration, Service scoped Eventing System
configuration>> is reserved only for advanced use cases.
+====
+
+[#platform-scoped-eventing-system-configuration]
+=== Platform scoped Eventing System Configuration
+
+To configure a platform scoped eventing system, you must use the field
`spec.eventing.broker.ref` in the `SonataFlowPlatform` CR to refer a Knative
Eventing Broker.
+
+This information signals the {operator_name} to automatically link the
supporting services to `produce` and `consume` the events by using that Broker.
+
+Additionally, workflows deployed in that namespace, that don't provide a
custom eventing system configuration, will be linked to that Broker.
+// TODO, uncomment when the workflows section is in.
+// For more information about configuring the workflow eventing system,
xref:cloud/operator/configuring-workflow-eventing-system.adoc[see].
+
+The following `SonataFlowPlatform` CR fragment shows an example of such
configuration:
+
+.Platform scoped eventing system configuration example
+[source,yam]
+----
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: sonataflow-platform-example
+ namespace: example-namespace
+spec:
+ eventing:
+ broker:
+ ref:
+ name: example-broker <1>
+ namespace: example-broker-namespace <2>
+ apiVersion: eventing.knative.dev/v1
+ kind: Broker
+----
+
+<1> Name of the Knative Eventing Broker.
+<2> Optional: Defines the namespace of the Knative Eventing Broker. Defaults
to the SonataFlowPlatform namespace. In general, we recommend to create the
Knative Eventing Broker in the same namespace as the SonataFlowPlatform.
+
+[NOTE]
+====
+In production environments, you must use a production-ready broker, like the
link:{knative_eventing_kafka_broker_url}[Knative Kafka Broker].
+====
+
+[#service-scoped-eventing-system-configuration]
+=== Service scoped Eventing System configuration
+
+A service scoped eventing system configuration provides the ability to do a
fine-grained configuration of the eventing system for the
<<data-index-eventing-system-configuration, Data Index>> or the
<<jos-service-eventing-system-configuration, Jobs Service>>.
+
+[NOTE]
+====
+In a regular {product_name} installation, the preferred method is to use a
<<platform-scoped-eventing-system-configuration, Platform scoped Eventing
System Configuration>>, while the service scoped configuration is reserved only
for advanced use cases.
+====
+
+[#data-index-eventing-system-configuration]
+=== Data Index Eventing System configuration
+
+To configure a service scoped eventing system for the Data Index, you must use
the field `spec.services.dataIndex.source.ref` in the `SonataFlowPlatform` CR
to refer a specific Knative Eventing Broker.
+
+This information signals the {operator_name} to automatically link the Data
Index to `consume` the {product_name} system events from that Broker.
+
+.Data Index service scoped eventing system configuration example
+[source,yam]
+----
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: sonataflow-platform-example
+spec:
+ services:
+ dataIndex:
+ source:
+ ref:
+ name: data-index-source-example-broker <1>
+ namespace: data-index-source-example-broker-namespace <2>
+ apiVersion: eventing.knative.dev/v1
+ kind: Broker
+----
+
+<1> Name of the Knative Eventing Broker to `consume` events from.
+<2> Optional: Defines the namespace of the Knative Eventing Broker. Defaults
to the SonataFlowPlatform namespace. In general, we recommend to create the
Knative Eventing Broker in the same namespace as the SonataFlowPlatform.
+
+[NOTE]
+====
+In production environments, you must use a production-ready broker, like the
link:{knative_eventing_kafka_broker_url}[Knative Kafka Broker].
+====
+
+[#jos-service-eventing-system-configuration]
+=== Jobs Service Eventing System configuration
+
+To configure a service scoped eventing system for the Jobs Service, you must
use the fields `spec.services.jobService.source.ref` and
`spec.services.jobService.sink.ref` in the `SonataFlowPlatform` CR.
+
+This information signals the {operator_name} to automatically link the Jobs
Service to `consume` and `produce` the {product_name} system events from that
configurations respectively.
+
+.Jobs Service scoped eventing system configuration example
+[source,yam]
+----
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: sonataflow-platform-example
+spec:
+ services:
+ jobService:
+ source:
+ ref:
+ name: jobs-service-source-example-broker <1>
+ namespace: jobs-service-source-example-broker-namespace <2>
+ apiVersion: eventing.knative.dev/v1
+ kind: Broker
+ sink:
+ ref:
+ name: jobs-service-sink-example-broker <3>
+ namespace: jobs-service-sink-example-broker-namespace <4>
+ apiVersion: eventing.knative.dev/v1
+ kind: Broker
+----
+
+<1> Name of the Knative Eventing Broker to `consume` events from.
+<2> Optional: Defines the namespace of the Knative Eventing Broker. Defaults
to the SonataFlowPlatform namespace. In general, we recommend to create the
Knative Eventing Broker in the same namespace as the SonataFlowPlatform.
+<3> Name of the Knative Eventing Broker to `produce` events on.
+<4> Optional: Defines the namespace of the Knative Eventing Broker. Defaults
to the SonataFlowPlatform namespace. In general, we recommend to create the
Knative Eventing Broker in the same namespace as the SonataFlowPlatform.
+
+[NOTE]
+====
+In production environments, you must use production-ready brokers, like the
link:{knative_eventing_kafka_broker_url}[Knative Kafka Broker].
+====
+
+[#cluster-scoped-eventing-system-configuration]
+=== Cluster scoped Eventing System configuration
+
+When you use a <<cluster-scoped-deployment>> deployment, the supporting
services are automatically linked to the `Broker` configured in the
`SonataFlowPlatform` CR referred by the `SonataFlowClusterPlatform` CR.
+
+=== Eventing System configuration precedence rules
+
+To configure the eventing system for a supporting service, the {operator_name}
use the following precedence rules:
+
+* If the supporting service has a configured eventing system, by using any of
the <<data-index-eventing-system-configuration>> or
<<jos-service-eventing-system-configuration>> respectively, that configuration
apply.
+
+* If the `SonataFlowPlatform` CR enclosing the supporting service, is
configured with a <<platform-scoped-eventing-system-configuration>>, that
configuration apply.
+
+* If the current cluster, is configured with a
<<cluster-scoped-eventing-system-configuration>>, that configuration apply.
+
+* If none of the previous configurations exists, the supporting service is
configured to produce direct Http calls to deliver events.
Review Comment:
```suggestion
* If none of the previous configurations exists, the supporting service is
configured to produce direct HTTP calls to deliver events.
```
--
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]
