From a6c5132b801f61600f251c01adde0bd91c466656 Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Mon, 4 Nov 2024 10:46:35 +0100 Subject: [PATCH 01/23] kie-kogito-docs-664: Create a guide for the SonataFlow Operator driven Supporting Services Knative Eventing system configuration --- .../cloud/operator/supporting-services.adoc | 235 ++++++++++++++++++ 1 file changed, 235 insertions(+) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 67675ad4f..8940e404b 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/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 <>, while the <> 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 <> or the <>. + +[NOTE] +==== +In a regular {product_name} installation, the preferred method is to use a <>, 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 <> 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 <> or <> respectively, that configuration apply. + +* If the `SonataFlowPlatform` CR enclosing the supporting service, is configured with a <>, that configuration apply. + +* If the current cluster, is configured with a <>, that configuration apply. + +* If none of the previous configurations exists, the supporting service is configured to produce direct Http calls to deliver events. + +=== Eventing System linking objects + +The linking of the supporting services with the Eventing System is produced by using Knative Eventing SinkBindings and Triggers. +These objects are automatically created by the {operator_name}, and facilitate the events production and consumption from the supporting services. + +The example below shows the Knative Native eventing objects created for the following `SonataFlowPlatform` CR. + +.SonataFlowPlatform eventing system configuration example +[source,yaml] +---- +apiVersion: sonataflow.org/v1alpha08 +kind: SonataFlowPlatform +metadata: + name: sonataflow-platform-example + namespace: example-namespace +spec: + eventing: + broker: + ref: + name: example-broker <1> + apiVersion: eventing.knative.dev/v1 + kind: Broker + services: + dataIndex: <2> + enabled: true + jobService: <3> + enabled: true +---- + +<1> Platform Broker configuration used by the Data Index, Jobs Service, and the workflows if not overridden. +<2> Data Index ephemeral deployment. +<3> Jobs Service ephemeral deployment. + +.Knative Kafka Broker example used by the SonataFlowPlatform +[source,yaml] +---- +apiVersion: eventing.knative.dev/v1 +kind: Broker +metadata: + annotations: + eventing.knative.dev/broker.class: Kafka <1> + name: example-broker + namespace: example-namespace +spec: + config: + apiVersion: v1 + kind: ConfigMap + name: kafka-broker-config + namespace: knative-eventing +---- + +<1> Use the Kafka class to create a Kafka Knative Broker + +.Knative Eventing Triggers created for the Data Index and Jobs Service events consumption +[source,bash] +---- +kn trigger list -n example-namespace + +NAME BROKER SINK AGE CONDITIONS READY REASON +data-index-jobs-fbf285df-c0a4-4545-b77a-c232ec2890e2 example-broker service:sonataflow-platform-example-data-index-service 106s 7 OK / 7 True +data-index-process-definition-e48b4e4bf73e22b90ecf7e093ff6b1eaf example-broker service:sonataflow-platform-example-data-index-service 106s 7 OK / 7 True +data-index-process-error-fbf285df-c0a4-4545-b77a-c232ec2890e2 example-broker service:sonataflow-platform-example-data-index-service 106s 7 OK / 7 True +data-index-process-node-fbf285df-c0a4-4545-b77a-c232ec2890e2 example-broker service:sonataflow-platform-example-data-index-service 106s 7 OK / 7 True +data-index-process-sla-fbf285df-c0a4-4545-b77a-c232ec2890e2 example-broker service:sonataflow-platform-example-data-index-service 106s 7 OK / 7 True +data-index-process-state-fbf285df-c0a4-4545-b77a-c232ec2890e2 example-broker service:sonataflow-platform-example-data-index-service 106s 7 OK / 7 True +data-index-process-variable-ac727d6051750888dedb72f697737c0dfbf example-broker service:sonataflow-platform-example-data-index-service 106s 7 OK / 7 True + +jobs-service-create-job-fbf285df-c0a4-4545-b77a-c232ec2890e2 example-broker service:sonataflow-platform-example-jobs-service 106s 7 OK / 7 True +jobs-service-delete-job-fbf285df-c0a4-4545-b77a-c232ec2890e2 example-broker service:sonataflow-platform-example-jobs-service 106s 7 OK / 7 True +---- + +.Knative Eventing SinkBinding created for the Jobs Service events production +[source,bash] +---- +kn source list -n example-namespace + +NAME TYPE RESOURCE SINK READY +sonataflow-platform-example-jobs-service-sb SinkBinding sinkbindings.sources.knative.dev broker:example-broker True +---- + == Advanced Supporting Services Configurations To configure the advanced options for any of the supporting services you must use the `podTemplate` field respectively, for example `dataIndex.podTemplate`: From 8160cbe3db1bcff0975d28c07aa246fa2d4ebba0 Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:08:34 +0100 Subject: [PATCH 02/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 8940e404b..cb4bbbfe4 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -180,7 +180,7 @@ 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 +== Configuring the supporting services Eventing system In general, the following events are produced in a {product_name} installation: From 8b9ed745cb43eb012b96d8c19081a741b8d58b0c Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:08:52 +0100 Subject: [PATCH 03/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index cb4bbbfe4..4c3f56e66 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -196,7 +196,7 @@ In a regular {product_name} installation, the preferred method is to use the <

Date: Tue, 5 Nov 2024 19:09:19 +0100 Subject: [PATCH 04/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 4c3f56e66..29be38f85 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -198,7 +198,7 @@ In a regular {product_name} installation, the preferred method is to use the <

Date: Tue, 5 Nov 2024 19:09:42 +0100 Subject: [PATCH 05/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 29be38f85..91ef0ac0e 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -227,7 +227,7 @@ spec: ---- <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. +<2> Optional: Defines the namespace of the Knative Eventing Broker. Defaults to the SonataFlowPlatform namespace. In general, we recommend creating the Knative Eventing Broker in the same namespace as the SonataFlowPlatform. [NOTE] ==== From 3c4d27fa6bf222e9db9c42fa8aaccf3cb7d63620 Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:10:07 +0100 Subject: [PATCH 06/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 91ef0ac0e..40139b0dc 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -235,7 +235,7 @@ In production environments, you must use a production-ready broker, like the lin ==== [#service-scoped-eventing-system-configuration] -=== 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 <> or the <>. From 24078b15355f78a790dc41196a75700fcee0c03f Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:11:14 +0100 Subject: [PATCH 07/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 40139b0dc..d64a25183 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -241,7 +241,7 @@ A service scoped eventing system configuration provides the ability to do a fine [NOTE] ==== -In a regular {product_name} installation, the preferred method is to use a <>, while the service scoped configuration is reserved only for advanced use cases. +In a regular {product_name} installation, the preferred method is to use a <>, while the service-scoped configuration is reserved only for advanced use cases. ==== [#data-index-eventing-system-configuration] From 6caf5a45f81a99e72cc83f9ef7b08180a7897a8f Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:12:06 +0100 Subject: [PATCH 08/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index d64a25183..5503eb718 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -245,7 +245,7 @@ In a regular {product_name} installation, the preferred method is to use a < Date: Tue, 5 Nov 2024 19:14:44 +0100 Subject: [PATCH 09/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 5503eb718..327a4b76d 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -247,7 +247,7 @@ In a regular {product_name} installation, the preferred method is to use a < Date: Tue, 5 Nov 2024 19:15:01 +0100 Subject: [PATCH 10/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 327a4b76d..e42cfe99c 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -278,7 +278,7 @@ In production environments, you must use a production-ready broker, like the lin ==== [#jos-service-eventing-system-configuration] -=== Jobs 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. From eb7b63a8bf43fc0fadc80cd71e9ab3b5290e5584 Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:15:15 +0100 Subject: [PATCH 11/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index e42cfe99c..902e30813 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -280,7 +280,7 @@ In production environments, you must use a production-ready broker, like the lin [#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. +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. From ee2bb867de2043a6fc8ee2a7285acb325e5f724b Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:15:48 +0100 Subject: [PATCH 12/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 902e30813..06519488c 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -270,7 +270,7 @@ spec: ---- <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. +<2> Optional: Defines the namespace of the Knative Eventing Broker. Defaults to the SonataFlowPlatform namespace. In general, we recommend creating the Knative Eventing Broker in the same namespace as the SonataFlowPlatform. [NOTE] ==== From 59c07f20e7b40002f789994d7b617ce366bf7534 Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:16:14 +0100 Subject: [PATCH 13/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 06519488c..2c84be6af 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -282,7 +282,7 @@ In production environments, you must use a production-ready broker, like the lin 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. +This information signals the {operator_name} to automatically link the Jobs Service to `consume` and `produce` the {product_name} system events from that configuration respectively. .Jobs Service scoped eventing system configuration example [source,yam] From 6160c42bb00a8cdf8f04857c32fe546510a914ca Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:16:29 +0100 Subject: [PATCH 14/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 2c84be6af..87ea7e99e 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -309,7 +309,7 @@ spec: ---- <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. +<2> Optional: Defines the namespace of the Knative Eventing Broker. Defaults to the SonataFlowPlatform namespace. In general, we recommend creating 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. From 164b375d8bc0e3a9860680324eb71eb2ebf0cd80 Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:16:39 +0100 Subject: [PATCH 15/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 87ea7e99e..7c242d98c 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -311,7 +311,7 @@ spec: <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 creating 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. +<4> Optional: Defines the namespace of the Knative Eventing Broker. Defaults to the SonataFlowPlatform namespace. In general, we recommend creating the Knative Eventing Broker in the same namespace as the SonataFlowPlatform. [NOTE] ==== From 6438bcab4b2a3cb83218592d13ff0c7e60b88e56 Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:16:48 +0100 Subject: [PATCH 16/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 7c242d98c..f796187eb 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -319,7 +319,7 @@ In production environments, you must use production-ready brokers, like the link ==== [#cluster-scoped-eventing-system-configuration] -=== Cluster scoped Eventing System configuration +=== Cluster-scoped Eventing system configuration When you use a <> deployment, the supporting services are automatically linked to the `Broker` configured in the `SonataFlowPlatform` CR referred by the `SonataFlowClusterPlatform` CR. From ef22ceec1656443e14ee8e38c39f3ddf6c4f6c15 Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:17:21 +0100 Subject: [PATCH 17/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index f796187eb..624c54c4d 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -321,7 +321,7 @@ In production environments, you must use production-ready brokers, like the link [#cluster-scoped-eventing-system-configuration] === Cluster-scoped Eventing system configuration -When you use a <> deployment, the supporting services are automatically linked to the `Broker` configured in the `SonataFlowPlatform` CR referred by the `SonataFlowClusterPlatform` CR. +When you use a <> deployment, the supporting services are automatically linked to the `Broker` configured in the `SonataFlowPlatform` CR referred to by the `SonataFlowClusterPlatform` CR. === Eventing System configuration precedence rules From 5df4016f1422fc7c9b6511c7ad1468a33c5931a1 Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:17:34 +0100 Subject: [PATCH 18/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 624c54c4d..aaa12ba96 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -323,7 +323,7 @@ In production environments, you must use production-ready brokers, like the link When you use a <> deployment, the supporting services are automatically linked to the `Broker` configured in the `SonataFlowPlatform` CR referred to by the `SonataFlowClusterPlatform` CR. -=== Eventing System configuration precedence rules +=== Eventing system configuration precedence rules To configure the eventing system for a supporting service, the {operator_name} use the following precedence rules: From 448eac9a863a23b1c159e8e453f7388483d6d717 Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:17:48 +0100 Subject: [PATCH 19/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index aaa12ba96..27475aa33 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -327,7 +327,7 @@ When you use a <> deployment, the supporting services 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 <> or <> respectively, that configuration apply. +* If the supporting service has a configured eventing system, by using any of the <> or <> respectively, that configuration applies. * If the `SonataFlowPlatform` CR enclosing the supporting service, is configured with a <>, that configuration apply. From f62fde9b382582c584f0ed94a2bd59498b644917 Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:18:00 +0100 Subject: [PATCH 20/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 27475aa33..757841032 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -329,7 +329,7 @@ To configure the eventing system for a supporting service, the {operator_name} u * If the supporting service has a configured eventing system, by using any of the <> or <> respectively, that configuration applies. -* If the `SonataFlowPlatform` CR enclosing the supporting service, is configured with a <>, that configuration apply. +* If the `SonataFlowPlatform` CR enclosing the supporting service, is configured with a <>, that configuration applies. * If the current cluster, is configured with a <>, that configuration apply. From 2ce09923c8b5fbe72b8324e3fe5682a03bee959b Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:18:10 +0100 Subject: [PATCH 21/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 757841032..774b79dcf 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -333,7 +333,7 @@ To configure the eventing system for a supporting service, the {operator_name} u * If the current cluster, is configured with a <>, that configuration apply. -* If none of the previous configurations exists, the supporting service is configured to produce direct Http calls to deliver events. +* If none of the previous configurations exists, the supporting service is configured to produce direct HTTP calls to deliver events. === Eventing System linking objects From 11038593a7d73bca20e3fa3eae72efaafcac2c7b Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:18:30 +0100 Subject: [PATCH 22/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 774b79dcf..9f13cf705 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -340,7 +340,7 @@ To configure the eventing system for a supporting service, the {operator_name} u The linking of the supporting services with the Eventing System is produced by using Knative Eventing SinkBindings and Triggers. These objects are automatically created by the {operator_name}, and facilitate the events production and consumption from the supporting services. -The example below shows the Knative Native eventing objects created for the following `SonataFlowPlatform` CR. +The following example shows the Knative Native eventing objects created for the `SonataFlowPlatform` CR: .SonataFlowPlatform eventing system configuration example [source,yaml] From fe57416d61b7bc4a4bd54e72299a02a94c20d5ad Mon Sep 17 00:00:00 2001 From: Walter Medvedeo Date: Tue, 5 Nov 2024 19:18:53 +0100 Subject: [PATCH 23/23] Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com> --- .../modules/ROOT/pages/cloud/operator/supporting-services.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index 9f13cf705..747bc3e92 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -237,7 +237,7 @@ In production environments, you must use a production-ready broker, like the lin [#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 <> or the <>. +A service scoped eventing system configuration provides the ability to do a fine-grained configuration of the Eventing system for the <> or the <>. [NOTE] ====