This is an automated email from the ASF dual-hosted git repository.
dhanak 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 52ccf2d45 kie-kogito-docs#695: Holistic review of serverless-workflow
documenta… (#696)
52ccf2d45 is described below
commit 52ccf2d4591106b88d1051f646b88776ebf047fc
Author: Dominik Hanák <[email protected]>
AuthorDate: Fri Jan 17 15:39:48 2025 +0100
kie-kogito-docs#695: Holistic review of serverless-workflow documenta…
(#696)
* kie-kogito-docs#695: Holistic review of serverless-workflow documentation
Q1/2025
* Fix typo in install-kn-workflow-cli.adoc
* Fix missing attributes in antora.yaml
* Update data-index-service.adoc referencing old images
* Fix unterminated open block
* Update
serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc
Co-authored-by: Gonzalo Muñoz <[email protected]>
* Update
serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc
Co-authored-by: Ricardo Zanini
<[email protected]>
* Update
serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc
Co-authored-by: Gonzalo Muñoz <[email protected]>
* Update serverlessworkflow/antora.yml
---------
Co-authored-by: Gonzalo Muñoz <[email protected]>
Co-authored-by: Ricardo Zanini
<[email protected]>
---
serverlessworkflow/antora.yml | 30 ++--
serverlessworkflow/modules/ROOT/nav.adoc | 5 +-
.../modules/ROOT/pages/cloud/index.adoc | 8 +
.../cloud/operator/build-and-deploy-workflows.adoc | 12 +-
.../pages/cloud/operator/customize-podspec.adoc | 2 +-
.../cloud/operator/enabling-jobs-service.adoc | 169 +++++++++++++++++++++
.../pages/cloud/operator/global-configuration.adoc | 4 +-
.../cloud/operator/install-kn-workflow-cli.adoc | 51 +++++++
.../operator/install-serverless-operator.adoc | 26 ++--
.../ROOT/pages/core/configuration-properties.adoc | 2 +-
.../pages/core/handling-events-on-workflows.adoc | 2 -
.../ROOT/pages/data-index/data-index-service.adoc | 9 +-
...st-workflow-service-with-kn-cli-and-vscode.adoc | 2 +
.../modules/ROOT/pages/migration-guide/index.adoc | 5 -
.../operator/to-1.43.0-migration-guide.adoc | 103 -------------
15 files changed, 278 insertions(+), 152 deletions(-)
diff --git a/serverlessworkflow/antora.yml b/serverlessworkflow/antora.yml
index 090b78b87..d9f1738ee 100644
--- a/serverlessworkflow/antora.yml
+++ b/serverlessworkflow/antora.yml
@@ -33,7 +33,9 @@ asciidoc:
product_name: SonataFlow
operator_name: SonataFlow Operator
operator_installation_namespace: sonataflow-operator-system
+ sonataflow_vscode_extension_name: KIE Serverless Workflow Editor
operator_controller_config: sonataflow-operator-controllers-config
+ operator_controller_manager_deployment_name:
sonataflow-operator-controller-manager
quarkus_platform: io.quarkus.platform
kogito_sw_ga: kogito-quarkus-serverless-workflow
data_index_ref: Data Index
@@ -43,16 +45,19 @@ asciidoc:
operator_openshift_catalog: sonataflow-operator
operator_k8s_keyword: sonataflow
operator_k8s_subscription: my-sonataflow-operator
- kogito_devservices_imagename:
quay.io/kiegroup/kogito-data-index-ephemeral-nightly
- sonataflow_devmode_imagename: quay.io/kiegroup/kogito-swf-devmode-nightly
- sonataflow_builder_imagename: quay.io/kiegroup/kogito-swf-builder-nightly
+ container_image_registry_base: docker.io
+ sonataflow_operator_imagename:
docker.io/apache/incubator-kie-sonataflow-operator
+ sonataflow_devmode_imagename:
docker.io/apache/incubator-kie-sonataflow-devmode
+ sonataflow_builder_imagename:
docker.io/apache/incubator-kie-sonataflow-builder
+ sonataflow_builder_configmap_name: sonataflow-operator-builder-config
+ sonataflow_dataindex_postgresql_imagename:
docker.io/apache/incubator-kie-kogito-data-index-postgresql
+ sonataflow_dataindex_ephemeral_imagename:
docker.io/apache/incubator-kie-kogito-data-index-ephemeral
sonataflow_devmode_devui_url:
/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/
serverless_logic_web_tools_name: Serverless Logic Web Tools
serverless_workflow_vscode_extension_name: KIE Serverless Workflow Editor
kie_kogito_examples_repo_name: incubator-kie-kogito-examples
# Jobs service image and links
- jobs_service_image_allinone_url:
https://hub.docker.com/r/apache/incubator-kie-kogito-jobs-service-allinone
jobs_service_image_allinone:
docker.io/apache/incubator-kie-kogito-jobs-service-allinone
jobs_service_image_ephemeral:
docker.io/apache/incubator-kie-kogito-jobs-ephemeral
jobs_service_image_ephemeral_name:
incubator-kie-kogito-jobs-service-ephemeral
@@ -77,12 +82,15 @@ asciidoc:
docker_min_version: 20.10.7
docker_compose_min_version: 1.27.2
kubernetes_version: 1.26
- openshift_version_min: 4.12
- openshift_version_max: 4.15
- knative_version: 1.13
- knative_serving_version: 1.13
- knative_eventing_version: 1.13
+ openshift_version_min: 4.13
+ openshift_version_max: 4.17
+ knative_version: 1.15
+ knative_serving_version: 1.15
+ knative_eventing_version: 1.15
+ apache_kie_latest_version: 10.0.0
kogito_version: 999-SNAPSHOT
+ product_version_short: 10.0
+ product_version_long: 10.0.0
# only used in downstream
operator_version: main
@@ -99,7 +107,10 @@ asciidoc:
#
# URLs
#
+ images_distributions_url:
https://kie.apache.org/docs/start/download#container-images
+ apple_support_url:
https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unknown-developer-mh40616/mac
kogito_examples_repository_url:
https://github.com/apache/incubator-kie-kogito-examples
+ kogito_operator_repository_rawcontent_url:
https://raw.githubusercontent.com/apache/incubator-kie-kogito-serverless-operator
kogito_sw_examples_url:
https://github.com/apache/incubator-kie-kogito-examples/tree/main/serverless-workflow-examples
kogito_sw_operator_examples_url:
https://github.com/apache/incubator-kie-kogito-examples/tree/main/serverless-operator-examples
kogito_examples_url:
https://github.com/apache/incubator-kie-kogito-examples.git
@@ -116,6 +127,7 @@ asciidoc:
open_api_spec_url: https://spec.openapis.org/oas/v3.1.0.html
open_api_swagger_spec_url: https://swagger.io/docs/specification
quarkus_openapi_gen_url:
https://github.com/quarkiverse/quarkus-openapi-generator
+ kn_workflow_plugin_releases_url:
https://kie.apache.org/docs/start/download#sonataflow-knative-plugin
kie_tools_releases_page_url:
https://github.com/apache/incubator-kie-tools/releases
quarkus_guides_base_url: https://quarkus.io/guides
quarkus_guides_kafka_url: https://quarkus.io/guides/kafka
diff --git a/serverlessworkflow/modules/ROOT/nav.adoc
b/serverlessworkflow/modules/ROOT/nav.adoc
index 68e118c32..95f7d9983 100644
--- a/serverlessworkflow/modules/ROOT/nav.adoc
+++ b/serverlessworkflow/modules/ROOT/nav.adoc
@@ -83,7 +83,7 @@
*** xref:cloud/operator/service-discovery.adoc[Service Discovery]
*** xref:cloud/operator/using-persistence.adoc[Workflow Persistence]
*** xref:cloud/operator/configuring-workflow-eventing-system.adoc[Workflow
Eventing System]
-// *** xref:cloud/operator/configuring-knative-eventing-resources.adoc[Knative
Eventing]
+*** xref:cloud/operator/configuring-knative-eventing-resources.adoc[Knative
Eventing]
*** xref:cloud/operator/known-issues.adoc[Roadmap and Known Issues]
*** xref:cloud/operator/add-custom-ca-to-a-workflow-pod.adoc[Add Custom CA to
Workflow Pod]
* Integrations
@@ -93,9 +93,6 @@
* Data Index
** xref:data-index/data-index-core-concepts.adoc[Core concepts]
** xref:data-index/data-index-service.adoc[Standalone service]
-* xref:migration-guide/index.adoc[Migration Guide]
-** Operator
-*** xref:migration-guide/operator/to-1.43.0-migration-guide.adoc[Migrating
{product_name} operator to 1.43.0]
* Use Cases
** xref:use-cases/advanced-developer-use-cases/index.adoc[Advanced Development
Use Cases of {product_name} applications using Quarkus and Java]
*** Getting started
diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/index.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/index.adoc
index e8cf3bbd8..5a5509f39 100644
--- a/serverlessworkflow/modules/ROOT/pages/cloud/index.adoc
+++ b/serverlessworkflow/modules/ROOT/pages/cloud/index.adoc
@@ -128,6 +128,14 @@ xref:cloud/operator/using-persistence.adoc[]
Learn how to define the workflow `Persistence` field to allow the workflow to
store its context
--
+[.card]
+--
+[.card-title]
+xref:cloud/operator/enabling-jobs-service.adoc[]
+[.card-description]
+Learn how to enable the Jobs Service with Operator
+--
+
[.card]
--
[.card-title]
diff --git
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/build-and-deploy-workflows.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/build-and-deploy-workflows.adoc
index f79108850..da974dc5f 100644
---
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/build-and-deploy-workflows.adoc
+++
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/build-and-deploy-workflows.adoc
@@ -57,7 +57,7 @@ kubectl patch sonataflowplatform <name> --patch 'spec:\n
build:\n config:
[#customize-base-build]
=== Customize the base build Dockerfile
-The operator uses the `ConfigMap` named `sonataflow-operator-builder-config`
in the operator's installation namespace ({operator_installation_namespace}) to
configure and run the workflow build process.
+The operator uses the `ConfigMap` named `{sonataflow_builder_configmap_name}`
in the operator's installation namespace ({operator_installation_namespace}) to
configure and run the workflow build process.
You can change the `Dockerfile` entry in this `ConfigMap` to tailor the
Dockerfile to your needs. Just be aware that this can break the build process.
.Example of the sonataflow-operator-builder-config `ConfigMap`
@@ -66,7 +66,7 @@ You can change the `Dockerfile` entry in this `ConfigMap` to
tailor the Dockerfi
apiVersion: v1
data:
DEFAULT_WORKFLOW_EXTENSION: .sw.json
- Dockerfile: "FROM quay.io/kiegroup/kogito-swf-builder-nightly:latest AS
builder\n\n#
+ Dockerfile: "FROM {sonataflow_builder_imagename}:{operator_version} AS
builder\n\n#
variables that can be overridden by the builder\n# To add a Quarkus
extension
to your application\nARG QUARKUS_EXTENSIONS\n# Args to pass to the Quarkus
CLI
add extension command\nARG QUARKUS_ADD_EXTENSION_ARGS\n# Additional
java/mvn arguments
@@ -83,8 +83,8 @@ data:
-Djava.util.logging.manager=org.jboss.logmanager.LogManager\"\nENV
JAVA_APP_JAR=\"/deployments/quarkus-run.jar\"\n"
kind: ConfigMap
metadata:
- name: sonataflow-operator-builder-config
- namespace: sonataflow-operator-system
+ name: {sonataflow_builder_configmap_name}
+ namespace: {operator_installation_namespace}
----
[WARNING]
@@ -355,7 +355,7 @@ spec:
strategyOptions:
KanikoBuildCacheEnabled: "true"
registry:
- address: quay.io/kiegroup <1>
+ address: {container_image_registry_base} <1>
secret: regcred <2>
----
@@ -429,7 +429,7 @@ If you are running on OpenShift, you have access to the Red
Hat's supported regi
[source,bash,subs="attributes+"]
----
-kubectl edit cm/sonataflow-operator-builder-config -n
{operator_installation_namespace}
+kubectl edit cm/{sonataflow_builder_configmap_name} -n
{operator_installation_namespace}
----
In your editor, change the first line in the `Dockerfile` entry where it reads
`FROM quay.io/kiegroup/kogito-swf-builder-nightly:latest` to the desired image.
diff --git
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/customize-podspec.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/customize-podspec.adoc
index 9ae728467..568dfa600 100644
---
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/customize-podspec.adoc
+++
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/customize-podspec.adoc
@@ -196,7 +196,7 @@ When setting the attribute
`.spec.podTemplate.container.image` the operator unde
=== Setting a custom image in devmode
-In xref:cloud/operator/developing-workflows.adoc[development profile], it's
expected that the image is based on the default
`quay.io/kiegroup/kogito-swf-devmode:latest`.
+In xref:cloud/operator/developing-workflows.adoc[development profile], it's
expected that the image is based on the default
`{sonataflow_devmode_imagename}:{operator_version}`.
=== Setting a custom image in preview
diff --git
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc
new file mode 100644
index 000000000..9002e16f0
--- /dev/null
+++
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc
@@ -0,0 +1,169 @@
+= Managing Jobs Service with the Operator
+:compat-mode!:
+// Metadata:
+:description: Configure Jobs Service using the `SonataFlowPlatform` CR.
+:keywords: sonataflow, serverless, operator, kubernetes, jobs service
+
+
+This document describes how to configure the Jobs Service instance using the
SonataFlowPlarform CR.
+
+== Automate the Jobs Service instance management with the `SonataFlow` Operator
+
+It is possible to deploy the Jobs Service manually, leveraging the Operator
offers a more seamless integration by
+combining it with namespace configuration through the SonataFlowPlatform
Custom Resource (CR). When the Operator oversees
+the lifecycle of the jobs service, it automatically injects necessary
properties during creation into the SonataFlow workflows.
+This integration eliminates the need for including these properties within the
SonataFlow workflow CR instance, simplifying workflow management.
+
+== Configuring Jobs Service in the SonataFlowPlatform CR
+
+To enable the deployment of a Jobs Service instance, the `SonataFlowPlatform`
CRD exposes a set of fields that allow the user to
+configure the running instance.
+
+=== Ephemeral persistence
+The basic runtime is to deploy the Jobs Service with an ephemeral backend
running in the same container
+as the Jobs Service runtime.
+
+[source,yaml,subs="attributes+"]
+---
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: sonataflow-platform
+spec:
+ services:
+ jobService: {}
+---
+
+When executing this manifest, the operator will reconcile generating a pod
hosting the Jobs Service:
+
+[source,shell,subs="attributes+"]
+---
+$>kubectl get pod -n sonataflow
+NAME READY STATUS RESTARTS
AGE
+sonataflow-platform-jobs-service-cdf85d969-sbwkj 1/1 Running 0
108s
+---
+
+Keep in mind that this setup is not recommended for production environments,
especially because the data does not persist when the pod restarts.
+
+=== Using an existing PostgreSQL service
+For robust environments it is recommended to use an dedicated database service
and configure Jobs Service to make use of it. Currently, the Jobs Service
+only supports PostgreSQL database.
+
+Configuring Jobs Service to communicate with an existing PostgreSQL instance
is supported in two ways. In both cases it requires providing the persistence
+configuration, one by using the Jobs Service's persistence field and the other
one using the persistence field defined in the `SonataFlowPlatform` CR
+deployed in the same namespace.
+
+By default, the persistence specification defined in the `SonataFlow`
workflow's CR takes priority over the one in the `SonataFlowPlatform`
persistence specification.
+
+==== Using the persistence field defined in the `SonataFlowPlatform` CR
+Using the persistence configuration in the `SonataFlowPlatform` CR located in
the same namespace requires to have the `SonataFlow` CR persistence field
configured
+to have an empty `{}` value, signaling the Operator to derive the persistence
from the active `SonataFlowPlatform`, when available. If no persistence is
defined
+the operator will fallback to the ephemeral persistence previously described.
+
+[source,yaml,subs="attributes+"]
+---
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: sonataflow-platform
+spec:
+ persistence:
+ postgresql:
+ secretRef:
+ name: postgres-secrets
+ userKey: POSTGRES_USER
+ passwordKey: POSTGRES_PASSWORD
+ serviceRef:
+ name: postgres
+ port: 5432
+ databaseName: sonataflow
+---
+
+And the `SonataFlow` CR looks like this:
+
+[source,yaml,subs="attributes+"]
+---
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlow
+metadata:
+ name: callbackstatetimeouts
+ annotations:
+ sonataflow.org/description: Callback State Timeouts Example k8s
+ sonataflow.org/version: 0.0.1
+spec:
+ persistence: {}
+...
+---
+
+When using the `jdbcUrl` field instead of `serviceRef`, the user is
responsible for providing the correct JDBC URL connection value that does not
contain a `database schema`
+because the operator will use verbatim the contents of this field as the JDBC
connection in the Jobs Service pod, and if it provides a schema that has been
used or formatted
+by a different client, the pod will fail to run.
+
+===== Using the persistence field inside the service specification
+You can define the persistence configuration directly in the Jobs Service
specification. The structure is the same as in the `SonataFlowPlatform` CR and
also
+consist on the credentials to access the PostgreSQL instance, and the
kubernetes service reference to generate the connectivity.
+
+[source,yaml,subs="attributes+"]
+---
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: callbackstatetimeouts
+spec:
+ persistence:
+ postgresql:
+ secretRef:
+ name: postgres-secrets
+ userKey: POSTGRES_USER
+ passwordKey: POSTGRES_PASSWORD
+ serviceRef:
+ name: postgres
+ port: 5432
+ databaseName: sonataflow
+ databaseSchema: jobs-service
+---
+
+In this example we're using a PostgreSQL service located in the same namespace
where the Jobs Service is deployed, pointing to the default PostgreSQL port of
5432
+and referencing the database `sonataflow` and schema `jobs-service`. By
default, when the Jobs Service pod starts it will recreate the schema in the
given location
+if it doesn't exist.
+
+The values of `POSTGRES_USER` and `POSTGRES_PASSWORD` point to the keys in the
secret that contains the PostgreSQL credentials.
+
+[source,shell,subs="attributes+"]
+---
+$>kubectl describe secrets postgres-secrets
+Name: postgres-secrets
+Namespace: default
+Labels: <none>
+Annotations: <none>
+
+Type: Opaque
+
+Data
+\\\\====
+PGDATA: 28 bytes
+POSTGRES_DATABASE: 10 bytes
+POSTGRES_PASSWORD: 10 bytes
+POSTGRES_USER: 10 bytes
+---
+
+Putting everything together will render an output similar to this one below:
+
+[source,shell,subs="attributes+"]
+---
+$>kubectl get pod -w -n sonataflow
+NAME READY STATUS RESTARTS
AGE
+postgres-64c9ddb6bc-v96qb 1/1 Running 0
14m
+sonataflow-platform-jobs-service-79bb6bc67f-gvcg4 1/1 Running 0
1m
+---
+
+== Conclusion
+The Operator extends its scope to manage the lifecycle of the Jobs Service
instance, thus removing the burden on the users and allowing them to focus on
the
+implementation of the `Sonataworkflows. It takes care of managing the Jobs
Service deployment, dynamically configures its application properties
+when the Data Index service is also available and managed by the Operator, and
finally inject application properties in `SonataFlow` workflows in the target
+namespace when the Jobs Service is available.
+
+== Additional resources
+* xref:cloud/operator/install-serverless-operator.adoc[]
+
+include::../../../pages/_common-content/report-issue.adoc[]
\ No newline at end of file
diff --git
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/global-configuration.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/global-configuration.adoc
index f59f34624..d104ffdba 100644
---
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/global-configuration.adoc
+++
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/global-configuration.adoc
@@ -57,7 +57,7 @@ Set to false to send plain json events.
|===
-To edit this file, update the ConfigMap
`sonataflow-operator-controllers-config` using your preferred tool such as
`kubectl`.
+To edit this file, update the ConfigMap `{operator_controller_config}` using
your preferred tool such as `kubectl`.
[#config-changes]
== Configuration Changes Impact
@@ -103,7 +103,7 @@ The order of precedence is:
1. The `SonataFlowPlatform` in the current context
2. The global configuration entry
-3. The `FROM` clause in the Dockerfile in the operator's namespace
`sonataflow-operator-builder-config` ConfigMap
+3. The `FROM` clause in the Dockerfile in the operator's namespace
`{operator_controller_config}` ConfigMap
In summary, the entry in `SonataFlowPlatform` will always override any other
value.
diff --git
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/install-kn-workflow-cli.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/install-kn-workflow-cli.adoc
new file mode 100644
index 000000000..8d47dc471
--- /dev/null
+++
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/install-kn-workflow-cli.adoc
@@ -0,0 +1,51 @@
+= Installing the Knative Workflow Plugin
+:compat-mode!:
+// Metadata:
+:description: Install the operator on Kubernetes clusters
+:keywords: kogito, sonataflow, workflow, serverless, operator, kubernetes,
minikube, openshift, containers
+// links
+
+*Prerequisites*
+
+* You have first installed the link:{kn_cli_install_url}[Knative CLI].
+* link:{docker_install_url}[Docker] or {podman_install_url}[Podman] is
installed.
+
+[[proc-install-sw-plugin-kn-cli]]
+== Installing the {product_name} plug-in for Knative CLI
+
+You can use the {product_name} plug-in to set up your local workflow project
quickly using Knative CLI.
+
+.Procedure
+. Download the latest binary file, suitable for your environment, from the
link:{kn_workflow_plugin_releases_url}[download] page.
+. Install the `kn workflow` command as a plug-in of the Knative CLI using the
following steps:
++
+--
+.. Rename the downloaded binary as follows:
++
+`mv kn-workflow-linux-amd64 kn-workflow`
++
+.. Make the binary file executable as follows:
++
+`chmod +x kn-workflow`
++
+[WARNING]
+====
+On Mac, some systems might block the application to run due to Apple enforcing
policies. To fix this problem, check the *Security & Privacy* section in the
*System Preferences* -> *General* tab to approve the application to run. For
more information, see link:{apple_support_url}[Apple support article: Open a
Mac app from an unidentified developer].
+====
+.. Copy the `kn-workflow` binary file to `/usr/local/bin`.
+.. Run the following command to verify that `kn-workflow` plug-in is installed
successfully:
++
+`kn plugin list`
+--
+
+To verify that the installation was successful, you can execute the following
command:
+[source,shell]
+----
+kn workflow version
+----
+
+output:
+[source,shell,subs="attributes+"]
+----
+{product_version_long}
+----
diff --git
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/install-serverless-operator.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/install-serverless-operator.adoc
index 4f9e2df3d..aff342947 100644
---
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/install-serverless-operator.adoc
+++
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/install-serverless-operator.adoc
@@ -62,31 +62,31 @@ To install the {product_name} Operator, you can use the
following command:
.Install {product_name} Operator on Kubernetes
[source,shell,subs="attributes+"]
----
-kubectl create -f
https://raw.githubusercontent.com/apache/incubator-kie-kogito-serverless-operator/{operator_version}/operator.yaml
+kubectl create -f
{kogito_operator_repository_rawcontent_url}/{operator_version}/operator.yaml
----
-Replace `main` with specific version if needed:
+Replace `<version>` with specific version if needed:
----
-kubectl create -f
https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/<version>/operator.yaml
+kubectl create -f
{kogito_operator_repository_rawcontent_url}/<version>/operator.yaml
----
-`<version>` could be `1.44.1` for instance.
+`<version>` could be `{product_version_long}` for instance.
You can follow the deployment of the {product_name} Operator:
.Watch the {product_name} Operator pod
[source,shell,subs="attributes+"]
----
-kubectl get pod -n sonataflow-operator-system --watch
+kubectl get pod -n {operator_installation_namespace} --watch
----
A successful installation should have an output like this:
.Successful Installation Output
-[source]
+[source,subs="attributes+"]
----
NAME READY STATUS
RESTARTS AGE
-sonataflow-operator-controller-manager-948547ffd-sr2j2 0/2
ContainerCreating 0 6s
-sonataflow-operator-controller-manager-948547ffd-sr2j2 1/2 Running
0 7s
-sonataflow-operator-controller-manager-948547ffd-sr2j2 2/2 Running
0 20s
+{operator_controller_manager_deployment_name}-948547ffd-sr2j2 0/2
ContainerCreating 0 6s
+{operator_controller_manager_deployment_name}-948547ffd-sr2j2 1/2
Running 0 7s
+{operator_controller_manager_deployment_name}-948547ffd-sr2j2 2/2
Running 0 20s
----
You can also follow the operator’s log:
@@ -94,7 +94,7 @@ You can also follow the operator’s log:
.Watch the {product_name} Operator pod logs
[source,shell,subs="attributes+"]
----
-kubectl logs deployment/sonataflow-operator-controller-manager -n
sonataflow-operator-system -f
+kubectl logs deployment/{operator_controller_manager_deployment_name} -n
{operator_installation_namespace} -f
----
Once the operator is running, it will watch for instances of the
{product_name} Custom Resources (CR). Using CRs, you can configure your
{product_name} environment and define Workflows and builds to be handled by the
operator.
@@ -120,15 +120,15 @@ To uninstall the correct version of the operator, first
you must get the current
.Getting the operator version
[source,shell,subs="attributes+"]
----
-kubectl get deployment sonataflow-operator-controller-manager -n
sonataflow-operator-system -o
jsonpath="{.spec.template.spec.containers[?(@.name=='manager')].image}"
+kubectl get deployment {operator_controller_manager_deployment_name} -n
sonataflow-operator-system -o
jsonpath="{.spec.template.spec.containers[?(@.name=='manager')].image}"
-quay.io/kiegroup/kogito-serverless-operator-nightly:latest
+{sonataflow_operator_imagename}:{operator_version}
----
.Uninstalling the operator
[source,shell,subs="attributes+"]
----
-kubectl delete -f
https://raw.githubusercontent.com/apache/incubator-kie-kogito-serverless-operator/<version>.x/operator.yaml
+kubectl delete -f
{kogito_operator_repository_rawcontent_url}/<version>/operator.yaml
----
[TIP]
diff --git
a/serverlessworkflow/modules/ROOT/pages/core/configuration-properties.adoc
b/serverlessworkflow/modules/ROOT/pages/core/configuration-properties.adoc
index b46bb54b0..754dca609 100644
--- a/serverlessworkflow/modules/ROOT/pages/core/configuration-properties.adoc
+++ b/serverlessworkflow/modules/ROOT/pages/core/configuration-properties.adoc
@@ -136,7 +136,7 @@ a|Defines strategy to generate the configuration key of
open API specifications.
|`quarkus.kogito.devservices.image-name`
|Defines the Data Index image to use.
|string
-|`quay.io/kiegroup/kogito-data-index-ephemeral:{page-component-version}`
+|`{sonataflow_dataindex_ephemeral_imagename}:{page-component-version}`
|No
|`quarkus.kogito.devservices.shared`
diff --git
a/serverlessworkflow/modules/ROOT/pages/core/handling-events-on-workflows.adoc
b/serverlessworkflow/modules/ROOT/pages/core/handling-events-on-workflows.adoc
index 3a7e3b4bf..5f51ad3d5 100644
---
a/serverlessworkflow/modules/ROOT/pages/core/handling-events-on-workflows.adoc
+++
b/serverlessworkflow/modules/ROOT/pages/core/handling-events-on-workflows.adoc
@@ -141,5 +141,3 @@ Similar to the callback state in a workflow, the workflow
instance to be resumed
*
xref:use-cases/advanced-developer-use-cases/event-orchestration/consume-produce-events-with-knative-eventing.adoc[Consuming
and producing events on Knative Eventing]
include::../../pages/_common-content/report-issue.adoc[]
-
-
\ No newline at end of file
diff --git
a/serverlessworkflow/modules/ROOT/pages/data-index/data-index-service.adoc
b/serverlessworkflow/modules/ROOT/pages/data-index/data-index-service.adoc
index a8fa610e5..21409c668 100644
--- a/serverlessworkflow/modules/ROOT/pages/data-index/data-index-service.adoc
+++ b/serverlessworkflow/modules/ROOT/pages/data-index/data-index-service.adoc
@@ -4,7 +4,6 @@
:description: Data Index Service use as an independent service that allow to
index and query audit data in {product_name}
:keywords: workflow, serverless, data, dataindex, data-index, index, service,
standalone
// External pages
-:distributions_url: https://quay.io/organization/kiegroup
:dev_services_url: https://quarkus.io/guides/dev-services
:test_containers_url: https://www.testcontainers.org/
:kubernetes_configmap_url:
https://kubernetes.io/docs/concepts/configuration/configmap/
@@ -19,9 +18,7 @@ The goal is to configure the container to allow to process
ProcessInstances and
[#data-index-service-distributions]
=== {data_index_ref} distributions
-{data_index_ref} service can be deployed referencing directly a distributed
{data_index_ref} image. Here there are the different {data_index_ref} image
distributions that can be found in link:{distributions_url}[Quay.io/kiegroup]:
-
-image::data-index/data-index-distributions.png[Image of data-index different
available distributions]
+{data_index_ref} service can be deployed referencing directly a distributed
{data_index_ref} image. There are the different {data_index_ref} image
distributions that can be found in link:{images_distributions_url}[here].
=== {data_index_ref} standalone service deployment
@@ -81,7 +78,7 @@ Here you can see in example, how the {data_index_ref}
resource definition can be
QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION: update
----
-<1> Reference the right {data_index_ref} image to match with the type of
Database, in this case `quay.io/kiegroup/kogito-data-index-postgresql:latest`
+<1> Reference the right {data_index_ref} image to match with the type of
Database, in this case
`{sonataflow_dataindex_postgresql_imagename}:{operator_version}`
<2> Provide the database connection properties.
<3> When `KOGITO_DATA_INDEX_QUARKUS_PROFILE` is not present, the
{data_index_ref} is configured to use Kafka eventing.
<4> To initialize the database schema at start using flyway.
@@ -223,7 +220,7 @@ spec:
name: data-index-service-postgresql
uri: /jobs <7>
----
-<1> Reference the right {data_index_ref} image to match with the type of
Database, in this case `quay.io/kiegroup/kogito-data-index-postgresql:latest`
+<1> Reference the right {data_index_ref} image to match with the type of
Database, in this case
`{sonataflow_dataindex_postgresql_imagename}:{operator_version}`
<2> Provide the database connection properties
<3> KOGITO_DATA_INDEX_QUARKUS_PROFILE: http-events-support to use the
http-connector with Knative eventing.
<4> To initialize the database schema at start using flyway
diff --git
a/serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc
b/serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc
index 88ca5e6c8..2a07c7329 100644
---
a/serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc
+++
b/serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc
@@ -40,6 +40,8 @@ kn workflow run
* See
xref:testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc[Workflow
instances] guide on how to run workflows via Development UI.
* Once you are done developing your project navigate to the terminal that is
running the `kn workflow run` command and hit `Ctlr+C` to stop the development
environment.
+You can use any editor to develop your workflow to suit your use case. We
recommend getting familiar with
xref:../core/cncf-serverless-workflow-specification-support.adoc[] and guides
in `Core` chapter first.
+
To deploy the finished project to a local cluster, proceed to the next section.
[[proc-deploying-app-with-kn-cli]]
diff --git a/serverlessworkflow/modules/ROOT/pages/migration-guide/index.adoc
b/serverlessworkflow/modules/ROOT/pages/migration-guide/index.adoc
deleted file mode 100644
index 05569fcf4..000000000
--- a/serverlessworkflow/modules/ROOT/pages/migration-guide/index.adoc
+++ /dev/null
@@ -1,5 +0,0 @@
-= Migration guide for {product_name} components
-
-In this chapter you will find guide focusing on migration of our components
across version.
-We provide migration guides only when needed, so if there is no guide
available it means the migration
-is seamless.
\ No newline at end of file
diff --git
a/serverlessworkflow/modules/ROOT/pages/migration-guide/operator/to-1.43.0-migration-guide.adoc
b/serverlessworkflow/modules/ROOT/pages/migration-guide/operator/to-1.43.0-migration-guide.adoc
deleted file mode 100644
index 43680122d..000000000
---
a/serverlessworkflow/modules/ROOT/pages/migration-guide/operator/to-1.43.0-migration-guide.adoc
+++ /dev/null
@@ -1,103 +0,0 @@
-# Migration Guide for Operator
-
-
-## Version 1.43.0
-
-When migrating to version 1.43.0, you must review the `SonataFlowPlatform`
instances.
-
-.Procedure
-
-1. Change the `.spec.platform` to `.spec.build.config`. For example, given
that you have:
-+
-[source,yaml,subs="attributes+"]
-----
-apiVersion: sonataflow.org/v1alpha08
-kind: SonataFlowPlatform
-metadata:
- name: sonataflow-platform
-spec:
- platform:
- registry:
- address: quay.io/kiegroup
- secret: regcred
-----
-+
-You should change it to:
-+
-[source,yaml,subs="attributes+"]
-----
-apiVersion: sonataflow.org/v1alpha08
-kind: SonataFlowPlatform
-metadata:
- name: sonataflow-platform
-spec:
- build:
- config:
- registry:
- address: quay.io/kiegroup
- secret: regcred
-----
-
-2. Change the `.spec.build` to `.spec.build.template`. For example, given that
you have:
-+
-[source,yaml,subs="attributes+"]
-----
-apiVersion: sonataflow.org/v1alpha08
-kind: SonataFlowPlatform
-metadata:
- name: sonataflow-platform
-spec:
- build:
- resources:
- requests:
- memory: "64Mi"
- cpu: "250m"
- limits:
- memory: "128Mi"
- cpu: "500m"
-----
-+
-You should change it to:
-+
-[source,yaml,subs="attributes+"]
-----
-apiVersion: sonataflow.org/v1alpha08
-kind: SonataFlowPlatform
-metadata:
- name: sonataflow-platform
-spec:
- build:
- template:
- resources:
- requests:
- memory: "64Mi"
- cpu: "250m"
- limits:
- memory: "128Mi"
- cpu: "500m"
-----
-
-3. Change the `.spec.devModeBaseImage` to `spec.devMode.baseImage`. For
example, given that you have:
-+
-[source,yaml,subs="attributes+"]
-----
-apiVersion: sonataflow.org/v1alpha08
-kind: SonataFlowPlatform
-metadata:
- name: sonataflow-platform
-spec:
- devModeBaseImage: quay.io/johndoe/myworkflow:latest
-----
-+
-You should change it to:
-+
-[source,yaml,subs="attributes+"]
-----
-apiVersion: sonataflow.org/v1alpha08
-kind: SonataFlowPlatform
-metadata:
- name: sonataflow-platform
-spec:
- devMode:
- baseImage: quay.io/johndoe/myworkflow:latest
-----
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
