Skip to content

Commit

Permalink
Issue-598 Holistic review of non-quarkus data index chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
gmunozfe committed Apr 2, 2024
1 parent cae59fa commit f70c2e4
Show file tree
Hide file tree
Showing 14 changed files with 59 additions and 59 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The indexing functionality in the {data_index_ref} service is provided by choosi
* link:{mongo_url}[MongoDB]
====

The {data_index_ref} Service has been thought of as an application to store and query the existing workflow data. The data comes contained in events. The service allows multiple connection options as described in the <<data-index-service-communication, {data_index_ref} service communication configuration>> section.
The {data_index_ref} Service has been thought of as an application to store and query the existing workflow data. The data comes within events. The service allows multiple connection options as described in the <<data-index-service-communication, {data_index_ref} service communication configuration>> section.

[#data-index-deployments]
== {data_index_ref} scenarios
Expand All @@ -67,11 +67,11 @@ This type of deployment requires to choose the right image depending on the pers
[#data-index-dev-service]
=== {data_index_ref} service as Quarkus Development service
It also can be deployed, transparently as a *Quarkus Development Service* when the Quarkus Dev mode is used in the {product_name} application.
When you use the {product_name} Process Quarkus extension, a temporary {data_index_ref} Service is automatically provisioned while the Quarkus application is running in development mode and the Dev Service is set up for immediate use.
When the {product_name} Process Quarkus extension is utilized, a temporary {data_index_ref} Service is automatically provisioned while the Quarkus application runs in development mode. The Quarkus Dev Service is immediately available for use.

image::data-index/data-index-dev-service.png[Image of data-index deployment an Quarkus Dev Service]

More details are provided in the xref:data-index/data-index-service.adoc#data-index-dev-service-details[{data_index_ref} as a Quarkus Development service] section.
More details are provided in the xref:use-cases/advanced-developer-use-cases/data-index/data-index-as-quarkus-dev-service.adoc[{data_index_ref} as a Quarkus Development service] section.

The {product_name} Process Quarkus extension sets up your Quarkus application to automatically replicate any {product_name} messaging events related to {workflow_instances} or jobs into the provisioned Data Index instance.

Expand All @@ -96,15 +96,15 @@ More details are available in the xref:use-cases/advanced-developer-use-cases/da

In order to store the indexed data, {data_index_ref} needs some specific tables to be created. {data_index_ref} is ready to use link:{flyway_quarkus_url}[Quarkus flyway] for that purpose.

It's necessary to activate the migrate-at-start option to migrate the {data_index_ref} schema automatically.
Activating the 'migrate-at-start' option enables automatic migration of the {data_index_ref} schema.

For more details about Flyway migrations, see xref:use-cases/advanced-developer-use-cases/persistence/postgresql-flyway-migration.adoc[] section.

[#data-index-graphql]
== {data_index_ref} GraphQL endpoint

{data_index_ref} provides GraphQL endpoint that allows users to interact with the stored data.
For more information about GraphQL see {graphql_url}[GraphQL]
For more information about GraphQL see {graphql_url}[GraphQL documentation]

[#data-index-ext-queries]
=== GraphQL queries for {workflow_instances} and jobs
Expand Down Expand Up @@ -445,12 +445,12 @@ mutation{

[NOTE]
====
To enable described management operations on workflow instances, make sure your project is configured to have the `kogito-addons-quarkus-process-management` dependency on its `pom.xml` file to have this management operations enabled, like:
To enable described management operations on workflow instances, make sure your project is configured to have the `kie-addons-quarkus-process-management` dependency on its `pom.xml` file to have this management operations enabled, like:
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-process-management</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-process-management</artifactId>
</dependency>
----
====
Expand All @@ -471,12 +471,12 @@ Retrieves the {workflow_instance} source file. When the `source` field of a {wor

[NOTE]
====
The workflow instance source field only will be available when `kogito-addons-quarkus-source-files` dependency is added on {product_name} runtime service `pom.xml` file.
The workflow instance source field only will be available when `kie-addons-quarkus-source-files` dependency is added on {product_name} runtime service `pom.xml` file.
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-source-files</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-source-files</artifactId>
</dependency>
----
====
Expand Down Expand Up @@ -522,7 +522,7 @@ image::data-index/data-index-graphql-ui.png[Image of data-index GraphQL UI]

When the {data_index_ref} is deployed as a standalone service, this UI will be available at `/graphiql/` endpoint (i.e: at http://localhost:8180/graphiql/)

To have the GraphQL UI available when the {data_index_ref} extension is deployed the property `quarkus.kogito.data-index.graphql.ui.always-include` needs to be enabled.
To enable the GraphQL UI when deploying the {data_index_ref} extension, the property `quarkus.kogito.data-index.graphql.ui.always-include` must be enabled.

It will be accessible at: <quarkus.http.root-path><quarkus.http.non-application-root-path>/graphql-ui/ (i.e: http://localhost:8080/q/graphql-ui/)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ For this purpose, it is important to make sure the following addons are included
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-events-process</artifactId> <1>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-events-process</artifactId> <1>
</dependency>
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-process-management</artifactId> <2>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-process-management</artifactId> <2>
</dependency>
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,19 @@ Executing the previous command adds the following dependency to `pom.xml` file o
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-quarkus-serverless-workflow-devui</artifactId>
<groupId>org.apache.kie.sonataflow</groupId>
<artifactId>sonataflow-quarkus-devui</artifactId>
</dependency>
----
--

. Enter the following command to add the `kogito-addons-quarkus-source-files` extension that provides the source code to generate the Serverless Workflow diagram in the consoles:
. Enter the following command to add the `kie-addons-quarkus-source-files` extension that provides the source code to generate the Serverless Workflow diagram in the consoles:
+
--
.Install Kogito source files add-on extension
[source,shell]
----
quarkus ext add org.kie.kogito:kogito-addons-quarkus-source-files
quarkus ext add org.kie.kogito:kie-addons-quarkus-source-files
----

Executing the previous command adds the following dependency to `pom.xml` file of your project:
Expand All @@ -55,8 +55,8 @@ Executing the previous command adds the following dependency to `pom.xml` file o
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-source-files</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-source-files</artifactId>
</dependency>
----
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,16 @@ The Workflow Details page consists of the following panels:
Serverless Workflow Diagram panel::
+
--
The Serverless Workflow Diagram panel enables you to explore the workflow diagram and execution path of the workflow instance. The workflow diagram and execution path are displayed by consuming the source which is exposed through the `kogito-addons-quarkus-source-files`.
The Serverless Workflow Diagram panel enables you to explore the workflow diagram and execution path of the workflow instance. The workflow diagram and execution path are displayed by consuming the source which is exposed through the `kie-addons-quarkus-source-files`.

To add the source files add-on configuration, add the following dependency to `pom.xml` file of your project:

.source-files add-on dependency in `pom.xml` file
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-source-files</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-source-files</artifactId>
</dependency>
----

Expand Down Expand Up @@ -130,13 +130,13 @@ image::testing-and-troubleshooting/quarkus-dev-ui-extension/kogito-swf-tools-wor

[NOTE]
====
To enable the actions kebab, make sure your project is configured to have the `kogito-addons-quarkus-process-management`
To enable the actions kebab, make sure your project is configured to have the `kie-addons-quarkus-process-management`
dependency on its `pom.xml` file, like:
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-process-management</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-process-management</artifactId>
</dependency>
----
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Manually to the POM.xml::
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<groupId>org.kie</groupId>
<artifactId>kogito-addons-quarkus-data-index-postgresql</artifactId>
</dependency>
----
Expand Down Expand Up @@ -155,7 +155,7 @@ Manually to the POM.xml::
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<groupId>org.kie</groupId>
<artifactId>kogito-addons-quarkus-data-index-persistence-postgresql</artifactId>
</dependency>
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ pom.xml::
[source,xml,subs="attributes+"]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-knative-eventing</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-knative-eventing</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
Expand All @@ -35,13 +35,13 @@ Gradle::
[source,shell,subs="attributes+"]
----
quarkus-kubernetes 'io.quarkus:{quarkus-k8s-plugin}:{quarkus_version}'
quarkus-kubernetes 'org.kie.kogito:kogito-addons-quarkus-knative-eventing:{page-component-version}'
quarkus-kubernetes 'org.kie:kie-addons-quarkus-knative-eventing:{page-component-version}'
----
Quarkus CLI::
+
[source,shell,subs="attributes+"]
----
quarkus ext add org.kie.kogito:kogito-addons-quarkus-knative-eventing quarkus-openshift{page-component-version}'
quarkus ext add org.kie:kie-addons-quarkus-knative-eventing quarkus-openshift{page-component-version}'
----
====
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,21 @@ Apache Maven::
+
[source,shell]
----
mvn quarkus:add-extension -Dextensions="kogito-addons-quarkus-knative-eventing"
mvn quarkus:add-extension -Dextensions="kie-addons-quarkus-knative-eventing"
----
Quarkus CLI::
+
[source,shell]
----
quarkus extension add kogito-addons-quarkus-knative-eventing
quarkus extension add kie-addons-quarkus-knative-eventing
----
Manually::
+
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-knative-eventing</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-knative-eventing</artifactId>
</dependency>
----
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ include::../deployments/common/_prerequisites.adoc[]
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<groupId>org.kie</groupId>
<artifactId>kogito-addons-quarkus-knative-serving</artifactId>
</dependency>
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ You can enable the metrics in your workflow application.
For more information about creating a workflow, see xref:use-cases/advanced-developer-use-cases/getting-started/create-your-first-workflow-service.adoc[Creating your first workflow service].

.Procedure
. To add the metrics to your workflow application, add the `org.kie.kogito:kogito-addons-quarkus-monitoring-prometheus` dependency to the `pom.xml` file of your project:
. To add the metrics to your workflow application, add the `org.kie:kie-addons-quarkus-monitoring-prometheus` dependency to the `pom.xml` file of your project:
+
--
.Dependency to be added to the `pom.xml` file to enable metrics
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-monitoring-prometheus</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-monitoring-prometheus</artifactId>
</dependency>
----
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ You can build dashboards to monitor the data of your workflows using metrics.
For more information about creating a workflow, see xref:use-cases/advanced-developer-use-cases/getting-started/create-your-first-workflow-service.adoc[Creating your first workflow service].

.Procedure
. To enable metrics for your workflows application add `org.kie.kogito:kogito-addons-quarkus-monitoring-prometheus` dependency in `pom.xml` file of your application:
. To enable metrics for your workflows application add `org.kie:kie-addons-quarkus-monitoring-prometheus` dependency in `pom.xml` file of your application:
+
--
.Add metrics dependency to `pom.xml` file
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-monitoring-prometheus</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-monitoring-prometheus</artifactId>
</dependency>
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Manually::
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<groupId>org.kie</groupId>
<artifactId>kogito-addons-quarkus-jobs-knative-eventing</artifactId>
</dependency>
----
Expand Down Expand Up @@ -115,7 +115,7 @@ Manually::
<artifactId>quarkus-smallrye-reactive-messaging-kafka</artifactId>
</dependency>
<dependency>
<groupId>org.kie.kogito</groupId>
<groupId>org.kie</groupId>
<artifactId>kogito-addons-quarkus-jobs-messaging</artifactId>
</dependency>
----
Expand Down Expand Up @@ -162,7 +162,7 @@ Manually::
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<groupId>org.kie</groupId>
<artifactId>kogito-addons-quarkus-jobs-management</artifactId>
</dependency>
----
Expand Down Expand Up @@ -212,7 +212,7 @@ Manually::
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<groupId>org.kie</groupId>
<artifactId>kogito-addons-quarkus-jobs-service-embedded</artifactId>
</dependency>
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ Ensure that the `pom.xml` file of your workflow application contains the require
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-persistence-jdbc</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-persistence-jdbc</artifactId>
</dependency>
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ This document relies on running PostgreSQL as a Docker service, however, if you
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-persistence-jdbc</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-persistence-jdbc</artifactId>
</dependency>
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -295,11 +295,11 @@ When activated, it leverages the Kubernetes Java API for service discovery, maki
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-kubernetes</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-kubernetes</artifactId>
</dependency>
<dependency>
<groupId>org.kie.kogito</groupId>
<groupId>org.kie</groupId>
<artifactId>kogito-addons-quarkus-fabric8-kubernetes-service-catalog</artifactId>
</dependency>
----
Expand All @@ -312,11 +312,11 @@ This implementation retrieves information from the application's configuration,
[source,xml]
----
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>kogito-addons-quarkus-kubernetes</artifactId>
<groupId>org.kie</groupId>
<artifactId>kie-addons-quarkus-kubernetes</artifactId>
</dependency>
<dependency>
<groupId>org.kie.kogito</groupId>
<groupId>org.kie</groupId>
<artifactId>kogito-addons-quarkus-microprofile-config-service-catalog</artifactId>
</dependency>
----
Expand Down

0 comments on commit f70c2e4

Please sign in to comment.