Skip to content

Commit 0f428b5

Browse files
GitHub Actionsjmagak
authored andcommitted
Apply Piotr and Yona's suggestions
1 parent 465bc36 commit 0f428b5

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

modules/orchestrator/con-environment-variables-supported-by-the-build-script.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Add Kafka messaging support or other integrations at build time.
2020

2121
* `MAVEN_ARGS_APPEND`
2222

23-
The `MAVEN_ARGS_APPEND` variable appends additional arguments to the Maven build command.
23+
The `MAVEN_ARGS_APPEND` variable appends additional arguments to the *Maven build* command.
2424
This variable takes the format of the string of Maven CLI arguments as shown in the following example:
2525

2626
[source,yaml]

modules/orchestrator/con-generated-workflow-manifests.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Values are not required at this stage as you can set them later after applying C
2222

2323
[Important]
2424
====
25-
In OpenShift Serverless Logic `v1.35`, after updating a secret, you must manually restart the workflow Pod for changes to apply.
25+
In OpenShift Serverless Logic `v1.36`, after updating a secret, you must manually restart the workflow Pod for changes to apply.
2626
====
2727

2828
`01-configmap_basic-props.yaml`::
@@ -54,21 +54,21 @@ podTemplate:
5454
----
5555

5656
.The persistence configuration example:
57-
[source,yaml]
57+
[source,yaml,subs="+quotes"]
5858
----
5959
persistence:
6060
postgresql:
6161
secretRef:
62-
name: sonataflow-psql-postgresql
63-
userKey: postgres-username
64-
passwordKey: postgres-password
62+
name: `sonataflow-psql-postgresql` # Update to match the name of the Secret of your deployment.
63+
userKey: `__<your_postgres_username>__` # Replace with the key for your deployment.
64+
passwordKey: `__<your_postgres_password>__` # Replace with the password of your deployment.
6565
serviceRef:
66-
name: sonataflow-psql-postgresql
66+
name: `sonataflow-psql-postgresql` # Update to match the name of the Secret of your deployment.
6767
port: 5432
6868
databaseName: sonataflow
6969
databaseSchema: basic
7070
----
7171

72-
If you must connect to an external database, replace `serviceRef` with a `jdbcUrl`. See the link:https://sonataflow.org/serverlessworkflow/latest/cloud/operator/enabling-jobs-service.html#_using_the_persistence_field_defined_in_the_sonataflowplatform_cr[SonataFlow Guides] for more information.
72+
If you must connect to an external database, replace `serviceRef` with a `jdbcUrl`. See link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/1.36/html-single/serverless_logic/index#serverless-logic-managing-persistence[Managing workflow persistence].
7373

74-
By default, the script generates all the manifests without a namespace. You can specify a namespace to the script by using the `--namespace` flag if you know the target namespace in advance. Otherwise, you must provide the namespace when applying the manifests to the cluster. See link:https://sonataflow.org/serverlessworkflow/latest/cloud/operator/configuring-workflows.html[Configuring workflow services].
74+
By default, the script generates all the manifests without a namespace. You can specify a namespace to the script by using the `--namespace` flag if you know the target namespace in advance. Otherwise, you must provide the namespace when applying the manifests to the cluster. See link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/1.36/html-single/serverless_logic/index#serverless-logic-configuring-workflow-services[Configuring workflow services].

modules/orchestrator/proc-deploying-workflows-on-a-cluster.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,29 @@ You can now deploy the workflow on a cluster, since the image has been pushed to
99

1010
* You have an {ocp-short} cluster with the following versions of components installed:
1111

12-
* {product} ({product-very-short}) `v1.5`
13-
* Orchestrator plugins `v1.4` or `v1.5`
14-
* OpenShift Serverless `v1.35`
15-
* OpenShift Serverless Logic `v1.35`
12+
* {product} ({product-very-short}) `v1.7`
13+
* Orchestrator plugins `v1.7.1`
14+
* OpenShift Serverless `v1.36`
15+
* OpenShift Serverless Logic `v1.36`
1616

1717
For further instructions on installing these components, see the {orchestrator-book-link}#con-orchestrator-plugin-components[Orchestrator plugin components on {ocp-short}].
1818

19-
* You must apply the workflow manifests in a namespace that contains a `SonataflowPlatform` custom resource (CR), which manages the link:https://sonataflow.org/serverlessworkflow/latest/cloud/operator/supporting-services.html[supporting services]. By default, OpenShift Serverless Logic services are installed in the `sonataflow-infra` namespace.
19+
* You must apply the workflow manifests in a namespace that contains a `SonataflowPlatform` custom resource (CR), which manages the link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/1.36/html-single/serverless_logic/index#serverless-logic-configuring-workflow-services[supporting services]. By default, OpenShift Serverless Logic services are installed in the `sonataflow-infra` namespace.
2020

2121
.Procedure
2222

2323
. Use the `kubectl create` command specifying the target namespace to apply the Kubernetes manifests as shown in the following example:
2424
+
2525
[source,bash]
2626
----
27-
kubectl create -n sonataflow-infra -f ./01_basic/manifests/.
27+
kubectl create -n <your-namespace> -f ./01_basic/manifests/.
2828
----
2929

3030
. After deployment, monitor the status of the workflow pods as shown in the following example:
3131
+
3232
[source,yaml]
3333
----
34-
kubectl get pods -n sonataflow-infra -l app=basic
34+
kubectl get pods -n <your-namespace> -l app=basic
3535
----
3636
+
3737
The pod may initially appear in an `Error` state because of missing or incomplete configuration in the Secret or ConfigMap.
@@ -40,7 +40,7 @@ The pod may initially appear in an `Error` state because of missing or incomplet
4040
+
4141
[source,yaml]
4242
----
43-
oc logs -n sonataflow-infra basic-f7c6ff455-vwl56
43+
oc logs -n <your-namespace> basic-f7c6ff455-vwl56
4444
----
4545
+
4646
The following is an example of the output:
@@ -59,7 +59,7 @@ The error indicates a missing property: `quarkus.openapi-generator.notifications
5959
+
6060
[source,yaml]
6161
----
62-
oc get -n sonataflow-infra configmaps basic-props -o yaml
62+
oc get -n <your-namespace> configmaps basic-props -o yaml
6363
----
6464
+
6565
The sample output looks as in the following example:
@@ -81,17 +81,17 @@ Resolve the placeholders using values provided using a Secret.
8181
+
8282
[source,yaml]
8383
----
84-
kubectl edit secrets -n sonataflow-infra basic-secrets
84+
kubectl edit secrets -n <your-namespace> basic-secrets
8585
----
86-
. Restart the workflow Pod for Secret changes to take effect in OpenShift Serverless Logic `v1.35`.
86+
. Restart the workflow Pod for Secret changes to take effect in OpenShift Serverless Logic `v1.36`.
8787

8888
.Verification
8989

9090
. Verify the deployment status by checking the pods again as shown in the following example:
9191
+
9292
[source,yaml]
9393
----
94-
oc get pods -n sonataflow-infra -l app=basic
94+
oc get pods -n <your-namespace> -l app=basic
9595
----
9696
+
9797
The expected status for a successfully deployed workflow Pod is as shown in the following example:

0 commit comments

Comments
 (0)