Skip to content

Commit a6a8389

Browse files
GitHub Actionsjmagak
authored andcommitted
Apply technical reviewers suggestions
1 parent be70b3d commit a6a8389

File tree

3 files changed

+14
-13
lines changed

3 files changed

+14
-13
lines changed

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The `build-sh` script supports the following environment variables to customize
77

88
`QUARKUS_EXTENSIONS`::
99

10-
The `QUARKUS_EXTENSIONS` variable specifies additional Quarkus extensions required by the workflow. This variable takes the format of a comma-separated list of fully qualified extension IDs as shown in the following example:
10+
The `QUARKUS_EXTENSIONS` variable specifies additional link:https://quarkus.io/extensions/[Quarkus] extensions required by the workflow. This variable takes the format of a comma-separated list of fully qualified extension IDs as shown in the following example:
1111
+
1212
[source,yaml]
1313
----
@@ -18,10 +18,11 @@ Add Kafka messaging support or other integrations at build time.
1818

1919
`MAVEN_ARGS_APPEND`::
2020

21-
The `MAVEN_ARGS_APPEND` variable appends additional arguments to the *Maven build* command.
22-
This variable takes the format of the string of Maven CLI arguments as shown in the following example:
21+
The `MAVEN_ARGS_APPEND` variable appends additional arguments to the *Maven build* command. This variable takes the format of a string of Maven CLI arguments as shown in the following example:
2322
+
2423
[source,yaml]
2524
----
2625
export MAVEN_ARGS_APPEND="-DmaxYamlCodePoints=35000000"
27-
----
26+
----
27+
+
28+
Control build behavior. For example, set `maxYamlCodePoints` parameter that controls the maximum input size for YAML input files to 35000000 characters (~33MB in UTF-8).

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ podTemplate:
5959
persistence:
6060
postgresql:
6161
secretRef:
62-
name: `sonataflow-psql-postgresql` # Update to match the name of the Secret of your deployment.
62+
name: `sonataflow-psql-postgresql` # Replace with the Secret name of your deployment.
6363
userKey: `__<your_postgres_username>__` # Replace with the key for your deployment.
6464
passwordKey: `__<your_postgres_password>__` # Replace with the password of your deployment.
6565
serviceRef:
66-
name: `sonataflow-psql-postgresql` # Update to match the name of the Secret of your deployment.
66+
name: `sonataflow-psql-postgresql` # Replace with the Secret name of your deployment.
6767
port: 5432
6868
databaseName: sonataflow
6969
databaseSchema: basic

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,22 @@ You can now deploy the workflow on a cluster, since the image has been pushed to
1616

1717
For further instructions on installing these components, see the {orchestrator-book-link}#con-orchestrator-plugin-components.adoc_orchestrator-rhdh[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://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.
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].
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 <your-namespace> -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 <your-namespace> -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 <your-namespace> 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 <your-namespace> 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,7 +81,7 @@ Resolve the placeholders using values provided using a Secret.
8181
+
8282
[source,yaml]
8383
----
84-
kubectl edit secrets -n <your-namespace> basic-secrets
84+
kubectl edit secrets -n <your_namespace> basic-secrets
8585
----
8686
. Restart the workflow Pod for Secret changes to take effect in OpenShift Serverless Logic `v1.36`.
8787

@@ -91,7 +91,7 @@ kubectl edit secrets -n <your-namespace> basic-secrets
9191
+
9292
[source,yaml]
9393
----
94-
oc get pods -n <your-namespace> -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)