From 84940cb4d418f7037c05faeb0941fc9efa55d209 Mon Sep 17 00:00:00 2001 From: Tommy Hughes IV Date: Mon, 11 Mar 2024 09:17:09 -0500 Subject: [PATCH] [KOGITO-9974] cluster-wide supporting services (#571) * [KOGITO-9974] cluster-wide supporting services Signed-off-by: Tommy Hughes * Update serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc Co-authored-by: Ricardo Zanini <1538000+ricardozanini@users.noreply.github.com> --------- Signed-off-by: Tommy Hughes Co-authored-by: Ricardo Zanini <1538000+ricardozanini@users.noreply.github.com> --- .../cloud/operator/supporting-services.adoc | 32 +++++++++++++++++-- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc index bc288e071..de33f3862 100644 --- a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc +++ b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc @@ -2,11 +2,11 @@ :compat-mode!: // Metadata: :description: Deploy Supporting Services with {operator_name} -:keywords: kogito, sonataflow, workflow, serverless, operator, kubernetes, openshift, containers, data, index, job, service +:keywords: kogito, sonataflow, workflow, serverless, operator, kubernetes, openshift, containers, data, index, job, service, cluster, wide, scoped, cluster-wide, cluster-scoped // links :kogito_serverless_operator_url: https://github.com/apache/incubator-kie-kogito-serverless-operator/ -By default, workflows use an embedded version of xref:data-index/data-index-core-concepts.adoc[Data Index]. This document describes how to deploy supporting services, like Data Index, on a cluster using the link:{kogito_serverless_operator_url}[{operator_name}]. +By default, workflows use an embedded version of xref:../../data-index/data-index-core-concepts.adoc[Data Index]. This document describes how to deploy supporting services, like Data Index, on a cluster using the link:{kogito_serverless_operator_url}[{operator_name}]. [IMPORTANT] ==== @@ -98,9 +98,35 @@ spec: <4> Number of Data Index pods, defaults to `1` <5> Custom Data Index container image name +[#cluster-wide-services] +== Cluster-Wide Supporting Services + +The `SonataFlowClusterPlatform` CR is optionally used to specify a cluster-wide set of supporting services for workflow consumption. This is done by referencing an existing, namespaced `SonataFlowPlatform` resource. + +Following is a basic configuration. It will allow workflows cluster-wide to leverage whatever supporting services are configured in the chosen "central" namespace. + +.Example of a basic SonataFlowClusterPlatform CR +[source,yaml,subs="attributes+"] +---- +apiVersion: sonataflow.org/v1alpha08 +kind: SonataFlowClusterPlatform +metadata: + name: cluster-platform +spec: + platformRef: + name: sonataflow-platform + namespace: +---- + +[NOTE] +==== +These cluster-wide services can be overridden in any namespace, by configuring that namespace's `SonataFlowPlatform.spec.services`. +==== + == Additional resources -* xref:data-index/data-index-service.adoc[] +* xref:../../data-index/data-index-service.adoc[] +* xref:cloud/operator/enabling-jobs-service.adoc[] * xref:cloud/operator/known-issues.adoc[] include::../../../pages/_common-content/report-issue.adoc[]