This is an automated email from the ASF dual-hosted git repository.
ricardozanini 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 b5d54a14f KOGITO-9923 Data Index service deployment (#518)
b5d54a14f is described below
commit b5d54a14f2c1d39139147d1bdb5716288f49a15e
Author: Tommy Hughes IV <[email protected]>
AuthorDate: Mon Feb 19 09:22:44 2024 -0600
KOGITO-9923 Data Index service deployment (#518)
---
serverlessworkflow/modules/ROOT/nav.adoc | 1 +
.../modules/ROOT/pages/cloud/index.adoc | 8 ++
.../pages/cloud/operator/supporting-services.adoc | 106 +++++++++++++++++++++
3 files changed, 115 insertions(+)
diff --git a/serverlessworkflow/modules/ROOT/nav.adoc
b/serverlessworkflow/modules/ROOT/nav.adoc
index d020166e1..37c110c81 100644
--- a/serverlessworkflow/modules/ROOT/nav.adoc
+++ b/serverlessworkflow/modules/ROOT/nav.adoc
@@ -88,6 +88,7 @@
*** xref:cloud/operator/referencing-resource-files.adoc[Referencing Workflow
Resources]
*** xref:cloud/operator/configuring-workflows.adoc[Configuration]
*** xref:cloud/operator/build-and-deploy-workflows.adoc[Building and Deploying
Workflow Images]
+*** xref:cloud/operator/supporting-services.adoc[Deploy Supporting Services]
*** xref:cloud/operator/workflow-status-conditions.adoc[Custom Resource Status]
*** xref:cloud/operator/building-custom-images.adoc[Building Custom Images]
*** xref:cloud/operator/known-issues.adoc[Roadmap and Known Issues]
diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/index.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/index.adoc
index 95a21f96f..1b7322c34 100644
--- a/serverlessworkflow/modules/ROOT/pages/cloud/index.adoc
+++ b/serverlessworkflow/modules/ROOT/pages/cloud/index.adoc
@@ -69,6 +69,14 @@ xref:cloud/operator/build-and-deploy-workflows.adoc[]
Learn how to build and deploy workflow services with {operator_name}
--
+[.card]
+--
+[.card-title]
+xref:cloud/operator/supporting-services.adoc[]
+[.card-description]
+Learn how to deploy supporting services with {operator_name}
+--
+
[.card]
--
[.card-title]
diff --git
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc
new file mode 100644
index 000000000..bc288e071
--- /dev/null
+++
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc
@@ -0,0 +1,106 @@
+= Supporting Services
+:compat-mode!:
+// Metadata:
+:description: Deploy Supporting Services with {operator_name}
+:keywords: kogito, sonataflow, workflow, serverless, operator, kubernetes,
openshift, containers, data, index, job, service
+// 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}].
+
+[IMPORTANT]
+====
+{operator_name} is under active development with features yet to be
implemented. Please see xref:cloud/operator/known-issues.adoc[].
+====
+
+.Prerequisites
+* The {operator_name} installed. See
xref:cloud/operator/install-serverless-operator.adoc[] guide
+* A postgresql database, if persistence is required
+
+[#deploy-supporting-services]
+== Deploy supporting services
+
+=== Data Index
+
+You can deploy Data Index via `SonataFlowPlatform` configuration. The operator
will then configure all new workflows, with the "prod" profile, to use that
Data Index.
+
+Following is a basic configuration. It will deploy an ephemeral Data Index to
the same namespace as the `SonataFlowPlatform`.
+
+.Example of a SonataFlowPlatform instance with an ephemeral Data Index
deployment
+[source,yaml,subs="attributes+"]
+----
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: sonataflow-platform
+spec:
+ services:
+ dataIndex: {}
+----
+
+If you require Data Index persistence, this can be done with a `postgresql`
database.
+
+Following is a services configuration with the persistence option enabled.
You'll first need to create a secret with your database credentials.
+
+.Create a Secret for datasource authentication.
+[source,bash,subs="attributes+"]
+----
+kubectl create secret generic <creds-secret>
--from-literal=POSTGRESQL_USER=<user>
--from-literal=POSTGRESQL_PASSWORD=<password> -n workflows
+----
+
+.Example of a SonataFlowPlatform instance with a Data Index deployment
persisted to a postgresql database
+[source,yaml,subs="attributes+"]
+----
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: sonataflow-platform
+spec:
+ services:
+ dataIndex:
+ persistence:
+ postgresql:
+ secretRef:
+ name: <creds-secret> <1>
+ serviceRef:
+ name: <postgresql-service> <2>
+----
+
+<1> Name of your postgresql credentials secret
+<2> Name of your postgresql k8s service
+
+.Example of a SonataFlowPlatform instance with a persisted Data Index
deployment and custom pod configuration
+[source,yaml,subs="attributes+"]
+----
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: sonataflow-platform
+spec:
+ services:
+ dataIndex:
+ enabled: false <1>
+ persistence:
+ postgresql:
+ secretRef:
+ name: <creds-secret>
+ userKey: <secret-user-key> <2>
+ jdbcUrl:
"jdbc:postgresql://host:port/database?currentSchema=data-index-service" <3>
+ podTemplate:
+ replicas: 1 <4>
+ container:
+ image: <image:tag> <5>
+----
+
+<1> Determines whether "prod" profile workflows should be configured to use
this service, defaults to `true`
+<2> Secret key of your postgresql credentials user, defaults to
`POSTGRESQL_USER`
+<3> PostgreSql JDBC URL
+<4> Number of Data Index pods, defaults to `1`
+<5> Custom Data Index container image name
+
+== Additional resources
+
+* xref:data-index/data-index-service.adoc[]
+* xref:cloud/operator/known-issues.adoc[]
+
+include::../../../pages/_common-content/report-issue.adoc[]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
