kaldesai commented on code in PR #530:
URL:
https://github.com/apache/incubator-kie-kogito-docs/pull/530#discussion_r1487259254
##########
serverlessworkflow/modules/ROOT/pages/cloud/operator/enabling-jobs-service.adoc:
##########
@@ -0,0 +1,170 @@
+= 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 usimg the
SonataFlowPlarform CR.
+
+== Automate the Jobs Service instance management with the `SonataFlow` Operator
+
+While it is possible to deploy the Jobs Service manually, the Operator also
provides a convenient way to combine it with the
+namespace configuration via the `SonataFlowPlatform` CR. With this approach,
the Operator will take care of configuring the
+Jobs Service instance and ensure it is in sync with the specification in the
CR. When the operator manages the Jobs Service lifecycle,
+it will inject properties in `SonataFlow` workflows at creation time to enable
the workflows to communicate with the Jobs Service
+instance during their execution, removing the need to add these properties as
part of the `SonataFlow` workflow CR instance.
+
+== Configuring Jobs Service in the SonataFlowPlatformCR
+
+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,
chiefly because the data is not persisted when the pod restarts.
+
+==== Using an existing postgreSQL service
+For robust environments it is recommened 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 precedence over the one in the `SonataFlowPlatform`
persistence's 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 of 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 persistency field inside the service specification
+You can specify 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: SonataFlow
+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 to the users and allowing them to focus on
the
Review Comment:
```suggestion
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
```
--
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]
