KOGITO-8674: Update release notes for Kogito 1.35 (#4465)
* KOGITO-8674: Update release notes for Kogito 1.35
* Update doc-content/kogito-docs/src/main/asciidoc/configuration/chap-kogito-configuring.adoc
Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com>
---------
Co-authored-by: Kalyani Desai <43639538+kaldesai@users.noreply.github.com>
diff --git a/doc-content/kogito-docs/src/main/asciidoc/configuration/chap-kogito-configuring.adoc b/doc-content/kogito-docs/src/main/asciidoc/configuration/chap-kogito-configuring.adoc
index ef4f71b..8fc73c1 100644
--- a/doc-content/kogito-docs/src/main/asciidoc/configuration/chap-kogito-configuring.adoc
+++ b/doc-content/kogito-docs/src/main/asciidoc/configuration/chap-kogito-configuring.adoc
@@ -1602,6 +1602,8 @@
JDBC allows {PRODUCT} to persist data using different relational databases. We recommend using https://www.postgresql.org/[PostgreSQL].
The complete list of supported databases is dependent on the target runtime you use, for instance, Quarkus supports the following https://quarkus.io/guides/datasource#jdbc-datasource[JDBC datasources].
+{PRODUCT} provides two ways to manage the database schema, either via manually applying the provided DDL https://repository.jboss.org/org/kie/kogito/kogito-ddl/{COMMUNITY_VERSION_FINAL}/[kogito-ddl-{COMMUNITY_VERSION_FINAL}-db-scripts.zip], or via https://flywaydb.org/[Flyway] integration. The service does not create a schema by default.
+
Please check examples below on how to enable different databases using JDBC data sources.
//==== Enabling PostgreSQL persistence using reactive driver for {PRODUCT} services
@@ -1750,10 +1752,12 @@
[source]
------
kogito.persistence.type=jdbc
-quarkus.datasource.db-kind=postgresql
quarkus.datasource.username=kogito-user
quarkus.datasource.password=kogito-pass
quarkus.datasource.jdbc.url=jdbc:postgresql://localhost:5432/kogito
+# Below properties are required to create database schema with Flyway at startup.
+quarkus.flyway.migrate-at-start=true
+quarkus.datasource.db-kind=postgresql
------
.On Spring Boot
@@ -1763,6 +1767,9 @@
spring.datasource.username=kogito-user
spring.datasource.password=kogito-pass
spring.datasource.url=jdbc:postgresql://localhost:5432/kogito
+# Below properties are required to create database schema with Flyway at startup.
+spring.flyway.enabled=true
+spring.flyway.locations=classpath:db/{vendor}
------
--
@@ -1827,10 +1834,12 @@
[source]
------
kogito.persistence.type=jdbc
-quarkus.datasource.db-kind=oracle
quarkus.datasource.username=kogito
quarkus.datasource.password=kogito
quarkus.datasource.jdbc.url=jdbc:oracle://oracle:1521/kogito
+# Below properties are required to create database schema with Flyway at startup.
+quarkus.flyway.migrate-at-start=true
+quarkus.datasource.db-kind=oracle
------
.On Spring Boot
@@ -1840,6 +1849,9 @@
spring.datasource.username=kogito
spring.datasource.password=kogito
spring.datasource.url=jdbc:oracle://oracle:1521/kogito
+# Below properties are required to create database schema with Flyway at startup.
+spring.flyway.enabled=true
+spring.flyway.locations=classpath:db/{vendor}
------
--
@@ -2988,6 +3000,10 @@
NOTE: Data Index Service with Oracle does not support indexing domain-specific data. The GraphQL schema only exposes queries for `ProcessInstances`, `UserTaskInstances`, and `Jobs`.
+==== Oracle database setup for the {PRODUCT} Data Index Service
+
+{PRODUCT} provides two ways to manage the database schema, either via manually applying the provided DDL https://repository.jboss.org/org/kie/kogito/kogito-ddl/{COMMUNITY_VERSION_FINAL}/[kogito-ddl-{COMMUNITY_VERSION_FINAL}-db-scripts.zip], or via https://flywaydb.org/[Flyway] integration. This integration is done via Quarkus Flyway and the following https://quarkus.io/guides/flyway[guide] can give extra details about how to use it. In a nutshell, to create the required tables for Data Index on an empty database, you must add the `quarkus.flyway.migrate-at-start=true` property.
+
[id="con-data-index-dev-service_{context}"]
=== Quarkus Dev Service for {PRODUCT} Data Index Service
diff --git a/doc-content/kogito-docs/src/main/asciidoc/release-notes/ReleaseNotesKogito.1.35.0.Final/ReleaseNotesKogito.1.35.0.Final.adoc b/doc-content/kogito-docs/src/main/asciidoc/release-notes/ReleaseNotesKogito.1.35.0.Final/ReleaseNotesKogito.1.35.0.Final.adoc
new file mode 100644
index 0000000..7ecde49
--- /dev/null
+++ b/doc-content/kogito-docs/src/main/asciidoc/release-notes/ReleaseNotesKogito.1.35.0.Final/ReleaseNotesKogito.1.35.0.Final.adoc
@@ -0,0 +1,44 @@
+// IMPORTANT: For 1.10 and later, save each version release notes as its own module file in the release-notes folder that this `ReleaseNotesKogito<version>.adoc` file is in, and then include each version release notes file in the chap-kogito-release-notes.adoc after Additional resources of {PRODUCT} deployment on {OPENSHIFT} section, in the following format:
+//include::ReleaseNotesKogito.<version>/ReleaseNotesKogito.<version>.adoc[leveloffset=+1]
+
+[id="ref-kogito-rn-new-features-1.35_{context}"]
+= New features in {PRODUCT} 1.35
+
+[role="_abstract"]
+The following sections describe some of the new features or enhancements in {PRODUCT} 1.35.
+
+== {PRODUCT} runtimes
+
+=== {PRODUCT} Serverless Workflow
+
+https://kiegroup.github.io/kogito-docs/serverlessworkflow/1.35.0.Final/release_notes.html[New features on 1.35].
+
+=== {PRODUCT} JDBC addon integration with Flyway
+
+Starting from this release, the following addons ( `kogito-addons-quarkus-persistence-jdbc` and `kogito-addons-springboot-persistence-jdbc` ) are now integrated with https://flywaydb.org/[Flyway] for database schema management.
+This also means that `kogito.persistence.auto.ddl` property is no longer used. Below is a migration reference for each plugin:
+
+==== kogito-addons-quarkus-persistence-jdbc
+
+This integration is done via Quarkus Flyway and the following https://quarkus.io/guides/flyway[guide] can give extra details about how to use it. In order to achieve the same behavior as `kogito.persistence.auto.ddl=true`, you must add the following properties:
+
+- `quarkus.flyway.migrate-at-start=true`
+- `quarkus.datasource.db-kind=postgresql`
+
+NOTE: Flyway integration uses a regular JDBC connection. Depending on your settings it is likely to need to include more JDBC-related properties such as username, password, etc, as shown in https://quarkus.io/guides/flyway#developing-with-flyway[Developing with Flyway].
+
+
+==== kogito-addons-springboot-persistence-jdbc
+
+Spring Boot comes with out-of-the-box https://documentation.red-gate.com/fd/community-plugins-and-integrations-spring-boot-184127423.html#:~:text=integration%20for%20Flyway[integration for Flyway]. Hence, {PRODUCT} JDBC add-on exposes full compatibility with the settings available. In order to achieve the same behavior as `kogito.persistence.auto.ddl=true`, you must add the following properties:
+
+- `spring.flyway.enabled=true`
+- `spring.flyway.locations=classpath:db/{vendor}`
+
+NOTE: Flyway integration uses a regular JDBC connection. Depending on your settings it is likely to need to include more JDBC-related properties such as username, password, etc. For the complete set of properties, visit https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties.data-migration[SpringBoot Data Migration properties].
+
+== {PRODUCT} supporting services
+
+=== Data Index Oracle integration with Flyway
+
+To create the database for running Data Index Oracle, it is now possible to use https://flywaydb.org/[Flyway]. This is an alternative to manually applying DDL scripts. This integration is done via Quarkus Flyway and the following https://quarkus.io/guides/flyway[guide] can give extra details about how to use it. In a nutshell, to create the required tables for Data Index on an empty database, you must add the `quarkus.flyway.migrate-at-start=true` property. For more details, visit https://quarkus.io/guides/flyway#quarkus-flyway_quarkus.flyway.migrate-at-start[quarkus.flyway.migrate-at-start].
diff --git a/doc-content/kogito-docs/src/main/asciidoc/release-notes/chap-kogito-release-notes.adoc b/doc-content/kogito-docs/src/main/asciidoc/release-notes/chap-kogito-release-notes.adoc
index 9c2ed90..fa0d830 100644
--- a/doc-content/kogito-docs/src/main/asciidoc/release-notes/chap-kogito-release-notes.adoc
+++ b/doc-content/kogito-docs/src/main/asciidoc/release-notes/chap-kogito-release-notes.adoc
@@ -92,6 +92,8 @@
* {URL_DEPLOYING_ON_OPENSHIFT}#chap-kogito-deploying-on-openshift[_{DEPLOYING_ON_OPENSHIFT}_]
//New features section
+include::ReleaseNotesKogito.1.35.0.Final/ReleaseNotesKogito.1.35.0.Final.adoc[leveloffset=+1]
+
include::ReleaseNotesKogito.1.34.0.Final/ReleaseNotesKogito.1.34.0.Final.adoc[leveloffset=+1]
include::ReleaseNotesKogito.1.33.0.Final/ReleaseNotesKogito.1.33.0.Final.adoc[leveloffset=+1]
