wmedvede commented on code in PR #625:
URL:
https://github.com/apache/incubator-kie-kogito-docs/pull/625#discussion_r1610003072
##########
serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc:
##########
@@ -92,18 +96,97 @@ spec:
image: <image:tag> <5>
----
-<1> Determines whether "prod" profile workflows should be configured to use
this service, defaults to `true`
+<1> Determines whether "preview" profile workflows should be configured to use
this service, defaults to `true`
<2> Secret key of your postgresql credentials user, defaults to
`POSTGRESQL_USER`
<3> PostgreSql JDBC URL
<4> Number of Data Index pods, defaults to `1`
-<5> Custom Data Index container image name
+<5> Custom Data Index container image name, if customization is required
+
+
+[#deploy-job-service]
+=== Jobs Service
+
+You can deploy Job Service via `SonataFlowPlatform` configuration. The
operator will then configure all new workflows, with the "preview" profile, to
use that Job Service.
+
+Following is a basic configuration. It will deploy an ephemeral Job Service to
the same namespace as the `SonataFlowPlatform`.
+
+.Example of a SonataFlowPlatform instance with an ephemeral Job Service
deployment
+[source,yaml,subs="attributes+"]
+----
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: sonataflow-platform
+spec:
+ services:
+ jobService: {}
+----
+
+If your use case requires persistence, Job Service supports a `postgresql`
database.
+First, you need to create a secret with credentials to access your postgresql
deployment.
+
+.Create a Secret for datasource authentication.
+[source,bash,subs="attributes+"]
+----
+kubectl create secret generic <creds-secret>
--from-literal=POSTGRESQL_USER=<user>
--from-literal=POSTGRESQL_PASSWORD=<password>
--from-literal=POSTGRESQL_DATABASE=<db_name> -n workflows
+----
+
+.Example of a SonataFlowPlatform instance with a Job Service deployment
persisted to a postgresql database
+[source,yaml,subs="attributes+"]
+----
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: sonataflow-platform
+spec:
+ services:
+ jobService:
+ persistence:
+ postgresql:
+ secretRef:
+ name: <creds-secret> <1>
+ serviceRef:
+ name: <postgresql-service> <2>
+----
+
+<1> Name of your postgresql credentials secret
+<2> Name of your postgresql k8s service
+
+.Example of a SonataFlowPlatform instance with a persisted Job Service
deployment and custom pod configuration
+[source,yaml,subs="attributes+"]
+----
+apiVersion: sonataflow.org/v1alpha08
+kind: SonataFlowPlatform
+metadata:
+ name: sonataflow-platform
+spec:
+ services:
+ jobService:
+ enabled: false <1>
+ persistence:
+ postgresql:
+ secretRef:
+ name: <creds-secret>
+ userKey: <secret-user-key> <2>
+ jdbcUrl:
"jdbc:postgresql://host:port/database?currentSchema=data-index-service" <3>
+ podTemplate:
+ replicas: 1 <4>
+ container:
+ image: <image:tag> <5>
+----
+
+<1> Determines whether "preview" profile workflows should be configured to use
this service, defaults to `true`
Review Comment:
```suggestion
<1> Determines whether "preview" or "gitops" profile workflows should be
configured to use this service, defaults to `true`
```
##########
serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc:
##########
@@ -15,14 +19,15 @@ By default, workflows use an embedded version of
xref:data-index/data-index-core
.Prerequisites
* The {operator_name} installed. See
xref:cloud/operator/install-serverless-operator.adoc[] guide
-* A postgresql database, if persistence is required
+* A postgresql database. Required when you are targetting non-embedded
postgresql versions of supporting services. We recommend creating a postgresql
deployment in your cluster. Please note your credentials.
[#deploy-supporting-services]
== Deploy supporting services
+[#deploy-data-index-service]
=== Data Index
-You can deploy Data Index via `SonataFlowPlatform` configuration. The operator
will then configure all new workflows, with the "prod" profile, to use that
Data Index.
+You can deploy Data Index via `SonataFlowPlatform` configuration. The operator
will then configure all new workflows, with the "preview" profile, to use that
Data Index.
Review Comment:
```suggestion
You can deploy Data Index via `SonataFlowPlatform` configuration. The
operator will then configure all new workflows, with the "preview" or "gitops"
profile, to use that Data Index.
```
##########
serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc:
##########
@@ -14,7 +17,7 @@ start the development on your local machine using our guides.
. Install link:{minikube_start_url}[minikube] or link:{kind_install_url}[kind].
. Install link:{kubectl_install_url}[Kubernetes CLI].
. Install link:{knative_quickstart_url}[Knative using quickstart]. This will
also set up Knative Serving and Eventing for you and the cluster should be
running.
-. xref:cloud/operator/install-serverless-operator.adoc[]
+. Install the
xref:cloud/operator/install-serverless-operator.adoc#_sonataflow_operator_manual_installation[{product_name}
operator manually].
Review Comment:
```suggestion
. Install the
xref:cloud/operator/install-serverless-operator.adoc#_sonataflow_operator_manual_installation[{operator_name}
manually].
```
##########
serverlessworkflow/modules/ROOT/pages/cloud/operator/supporting-services.adoc:
##########
@@ -92,18 +96,97 @@ spec:
image: <image:tag> <5>
----
-<1> Determines whether "prod" profile workflows should be configured to use
this service, defaults to `true`
+<1> Determines whether "preview" profile workflows should be configured to use
this service, defaults to `true`
Review Comment:
```suggestion
<1> Determines whether "preview" or "gitops" profile workflows should be
configured to use this service, defaults to `true`
```
--
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]
