ricardozanini commented on code in PR #519:
URL:
https://github.com/apache/incubator-kie-kogito-docs/pull/519#discussion_r1412024638
##########
serverlessworkflow/modules/ROOT/pages/data-index/data-index-usecase-multi.adoc:
##########
@@ -0,0 +1,221 @@
+= Deploying Data Index and multiple {product_name} application on Minikube
+:compat-mode!:
+// Metadata:
+:description: Deploying Multiple {product_name} pushing to single Data Index
on Minikube
+:keywords: kogito, workflow, quarkus, serverless, kubectl, minikube, operator,
dataindex
+:table-caption: Data Set
+// envs for common content
+:kubectl_prereq: command-line tool is installed. Otherwise, Minikube handles
it.
+//Common constants
+:data_index_ref: Data Index
+
+
+This document describes how to deploy a multiple {product_name} workflow
applications and the {data_index_ref} service using a local Kubernetes cluster,
such as link:{minikube_url}[Minikube], using the
link:{kogito_serverless_operator_url}[{operator_name}].
+
+For more information about Minikube and related system requirements, see
link:{minikube_url}/docs/start/[Getting started with Minikube] documentation.
+
+This use case is intended to represent an installation with:
+
+* A singleton Data Index Service with PostgreSQL persistence
+* The `greeting` workflow (no persistence), that is configured to register
events to the Data Index Service.
+* The `helloworld` workflow (no persistence), that is configured to register
events to the Data Index Service.
+* Both workflows are configured to register the process events on the
{data_index_ref} Service.
+
+You can directly access the UseCase2 example application we are going to
follow at link:{flow_examples_operator_url}[{product_name} Use Cases
repository].
Review Comment:
```suggestion
```
##########
serverlessworkflow/modules/ROOT/pages/data-index/data-index-quarkus-extension.adoc:
##########
@@ -103,6 +133,63 @@ When adding the addon to the workflow, you need to disable
it by setting `quarku
For more information, see `application.properties` file of
link:{kogito_sw_timeouts_showcase_embedded_example_application_properties_url}[`serverless-timeouts_showcase_embedded`]
example application.
--
+
+[#kogito-addons-quarkus-dataindex-persistence-extension]
+== Adding {data_index_ref} persistence extension to a workflow application
+
+You can add the {data_index_ref} persistence quarkus extension as an addon:
+
+.Prerequisites
+* Your workflow is running and has persistence enabled
+* {data_index_ref} is using the same datasource to store indexed data
++
+For more information about creating a workflow, see
{getting_started_create_first_workflow_guide}[Creating your first workflow].
You also can find more details about enabling persistence in
{persistence_with_postgresql_guide}[Running a workflow using PostgreSQL]
+
+.Procedure
+. Add the `kogito-addons-quarkus-data-index-persistence` extension to your
Quarkus Workflow Project using any of the following alternatives:
++
+--
+
+[tabs]
+====
+Manually::
Review Comment:
```suggestion
Manually to the POM.xml::
```
##########
serverlessworkflow/modules/ROOT/pages/data-index/data-index-usecase-singleton.adoc:
##########
@@ -0,0 +1,206 @@
+= Deploying Data Index and {product_name} application on Minikube
Review Comment:
This comment is for the future, after merging this and refactor to
incorporate Data Index on Operator guide.
##########
serverlessworkflow/modules/ROOT/pages/data-index/data-index-usecase-multi.adoc:
##########
@@ -0,0 +1,221 @@
+= Deploying Data Index and multiple {product_name} application on Minikube
+:compat-mode!:
+// Metadata:
+:description: Deploying Multiple {product_name} pushing to single Data Index
on Minikube
+:keywords: kogito, workflow, quarkus, serverless, kubectl, minikube, operator,
dataindex
+:table-caption: Data Set
+// envs for common content
+:kubectl_prereq: command-line tool is installed. Otherwise, Minikube handles
it.
+//Common constants
+:data_index_ref: Data Index
+
+
+This document describes how to deploy a multiple {product_name} workflow
applications and the {data_index_ref} service using a local Kubernetes cluster,
such as link:{minikube_url}[Minikube], using the
link:{kogito_serverless_operator_url}[{operator_name}].
+
+For more information about Minikube and related system requirements, see
link:{minikube_url}/docs/start/[Getting started with Minikube] documentation.
+
+This use case is intended to represent an installation with:
+
+* A singleton Data Index Service with PostgreSQL persistence
+* The `greeting` workflow (no persistence), that is configured to register
events to the Data Index Service.
+* The `helloworld` workflow (no persistence), that is configured to register
events to the Data Index Service.
+* Both workflows are configured to register the process events on the
{data_index_ref} Service.
+
+You can directly access the UseCase2 example application we are going to
follow at link:{flow_examples_operator_url}[{product_name} Use Cases
repository].
+
+// shared pre req
+include::common/_prerequisites.adoc[]
+
+You can check the Minikube installation by entering the following commands in
a command terminal:
+
+.Verify Minikube version
+[source,shell]
+----
+minikube version
+----
+
+.Verify `kubectl` CLI version
+[source,shell]
+----
+kubectl version
+----
+
+[NOTE]
+====
+If `kubectl` is not installed, then Minikube handles it when you execute the
following command:
+
+.`kubectl` is available using Minikube
+[source,shell]
+----
+alias kubectl="minikube kubectl --"
+----
+====
+
+.Procedure
+. After cloning the link:{flow_examples_operator_url}[SonataFlow Use Cases
repository]. Open a terminal and run the following commands
+. Create the namespace:
Review Comment:
We can add the files to the guide inline directly instead. @kaldesai can we
have an official OpenShift Serverless Logic examples/code repository?
##########
serverlessworkflow/modules/ROOT/pages/data-index/data-index-quarkus-extension.adoc:
##########
@@ -39,12 +41,19 @@ These extensions are distributed as addons ready to work
with different types of
* kogito-addons-quarkus-data-index-infinispan
* kogito-addons-quarkus-data-index-mongodb
+With the same purpose, the Quarkus {data_index_ref} persistence extension can
be added to any workflow application and incorporates the {data_index_ref}
persistence functionality into the same application without needing an external
{data_index_ref} service to do that indexation.
+These extensions are distributed as addons ready to work with different types
of persistence:
+
+* kogito-addons-quarkus-data-index-persistence-postgresql
+* kogito-addons-quarkus-data-index-persistence-infinispan
+* kogito-addons-quarkus-data-index-persistence-mongodb
Review Comment:
Can we add a little description of each?
##########
serverlessworkflow/modules/ROOT/pages/data-index/data-index-quarkus-extension.adoc:
##########
@@ -67,21 +79,39 @@ You can add the {data_index_ref} quarkus extension as an
addon:
.Prerequisites
* Your workflow is running and has persistence enabled.
+* {data_index_ref} is using the same datasource to store indexed data
+
For more information about creating a workflow, see
{getting_started_create_first_workflow_guide}[Creating your first workflow].
You also can find more details about enabling persistence in
{persistence_with_postgresql_guide}[Running a workflow using PostgreSQL]
.Procedure
-. Add the required {data_index_ref} addon dependencies to the `pom.xml` file
of your workflow:
+. Add the `kogito-addons-quarkus-data-index` extension to your Quarkus
Workflow Project using any of the following alternatives:
+
--
-.Add {data_index_ref} Addon dependencies to `pom.xml` file
+
+[tabs]
+====
+Manually::
Review Comment:
```suggestion
Manually to the POM.xml::
```
--
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]
