Skip to content

Commit 8101a30

Browse files
committed
[SRVLOGIC-404] Add info about Dev, Preview, GitOps deployment profiles
first batch of mode to profile corr second batch of mode to profile corr fix double signs improvements for the overview section remove profile from list improve heading remove parentheses GitOps qe feedback qe feedback no2 qe feedback no2 fix pr feedback
1 parent ac76d5e commit 8101a30

File tree

2 files changed

+63
-10
lines changed

2 files changed

+63
-10
lines changed

modules/serverless-logic-deploying-workflows-dev-mode.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="serverless-logic-deploying-workflows-dev-mode_{context}"]
7-
= Deploying workflows in Dev mode
7+
= Deploying workflows using the Dev profile
88

9-
You can deploy your local workflow on {ocp-product-title} in Dev mode. You can use this deployment to experiment and modify your workflow directly on the cluster, seeing changes almost immediately. Dev mode is designed for development and testing purposes. It is ideal for initial development stages and for testing new changes.
9+
You can deploy your local workflow on {ocp-product-title} using the Dev profile. You can use this deployment to experiment and modify your workflow directly on the cluster, seeing changes almost immediately. Dev profile is designed for development and testing purposes. Because it automatically reloads the workflow without restarting the container, it is ideal for initial development stages and for testing workflow changes in a live environment.
1010

1111
.Prerequisites
1212

@@ -66,8 +66,8 @@ spec:
6666
end: true
6767
----
6868
+
69-
<1> is a workflow_name
70-
<2> indicates that you must deploy the workflow in Dev mode
69+
<1> Is a <workflow_name>.
70+
<2> Indicates that you must deploy the workflow using the Dev profile.
7171

7272
. To deploy the application, apply the YAML file by entering the following command:
7373
+

serverless-logic/serverless-logic-getting-started/serverless-logic-deploying-workflows.adoc

Lines changed: 59 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,38 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="serverless-logic-deploying-workflows"]
3-
= Deploying workflows
3+
= Deployment options and deploying workflows
44
include::_attributes/common-attributes.adoc[]
55
:context: serverless-logic-deploying-workflows
66

77
toc::[]
88

9-
You can deploy the {ServerlessLogicProductShortName} workflows on the cluster in two modes: Dev mode and Preview mode.
9+
You can deploy the {ServerlessLogicProductShortName} workflows on the cluster using one of three deployment profiles:
10+
11+
* Dev
12+
* Preview
13+
* GitOps
14+
15+
Each profile defines how the Operator builds and manages workflow deployments, including image lifecycle, live updates, and reconciliation behavior.
1016

1117
include::modules/serverless-logic-deploying-workflows-dev-mode.adoc[leveloffset=+1]
1218

1319
[id="serverless-logic-deploying-workflows-preview-mode_{context}"]
14-
== Deploying workflows in Preview mode
20+
== Deploying workflows using the Preview profile
1521

16-
You can deploy your local workflow on {ocp-product-title} in Preview mode. This allows you to experiment and modify your workflow directly on the cluster, seeing changes almost immediately. Preview mode is used for final testing and validation before deploying to production. It also ensures that workflows will run smoothly in a production-like setting.
22+
You can deploy your local workflow on {ocp-product-title} using the Preview profile. This allows you to validate and test workflows in a production-like environment directly on the cluster. Preview profile is ideal for final testing and validation before moving workflows to production, as well as for quick iteration without directly managing the build pipeline. It also ensures that workflows will run smoothly in a production-like setting.
1723

1824
.Prerequisites
1925

2026
* You have an {ServerlessLogicOperatorName} installed on your cluster.
2127
* You have access to an {ServerlessLogicProductName} project with the appropriate roles and permissions to create applications and other workloads in {ocp-product-title}.
2228
* You have installed the OpenShift CLI `(oc)`.
2329

24-
To deploy a workflow in Preview mode, {ServerlessLogicOperatorName} uses the build system on {ocp-product-title}, which automatically creates the image for deploying your workflow.
30+
To deploy a workflow in Preview profile, {ServerlessLogicOperatorName} uses the build system on {ocp-product-title}, which automatically creates the image for deploying your workflow.
2531

2632
The following sections explain how to build and deploy your workflow on a cluster using the {ServerlessLogicOperatorName} with a `SonataFlow` custom resource.
2733

2834
[id="serverless-logic-configuring-workflows-preview-mode_{context}"]
29-
=== Configuring workflows in Preview mode
35+
=== Configuring workflows in Preview profile
3036

3137
include::modules/serverless-logic-workflow-base-builder-image.adoc[leveloffset=+3]
3238
include::modules/serverless-logic-workflow-base-builder-dockerfile.adoc[leveloffset=+3]
@@ -38,6 +44,53 @@ include::modules/serverless-logic-building-deploying-workflow-preview-mode.adoc[
3844
include::modules/serverless-logic-verifying-workflow-deployment-preview-mode.adoc[leveloffset=+2]
3945
include::modules/serverless-logic-restarting-the-build-preview-mode.adoc[leveloffset=+2]
4046

47+
[id="serverless-logic-deploying-workflows-gitops-mode_{context}"]
48+
== Deploying workflows using the GitOps profile
49+
50+
[IMPORTANT]
51+
====
52+
Use the GitOps profile only for production deployments.
53+
For development, rapid iteration, or testing, use the Dev or Preview profiles instead.
54+
====
55+
56+
You can deploy your local workflow on {ocp-product-title} using the GitOps profile. The GitOps profile provides full control over the workflow container image by allowing you to build and manage the image externally, typically through a CI/CD pipeline such as ArgoCD or Tekton. When a container image is defined in the `SonataFlow` custom resource (CR), the Operator automatically assumes the GitOps profile is being used and it does not attempt to build or modify the image in any way.
57+
58+
.Prerequisites
59+
60+
* You have {ServerlessLogicOperatorName} installed on your cluster.
61+
* You have access to a {ServerlessLogicProductName} project with the appropriate roles and permissions to create applications and other workloads in {ocp-product-title}.
62+
* You have installed the OpenShift CLI `(oc)`.
63+
64+
.Procedure
65+
66+
. Specify your container image in your SonataFlow CR:
67+
+
68+
.Example SonataFlow CR with set GitOps profile
69+
[source,yaml]
70+
----
71+
apiVersion: sonataflow.org/v1alpha08
72+
kind: SonataFlow
73+
metadata:
74+
annotations:
75+
sonataflow.org/profile: gitops
76+
name: workflow_name
77+
spec:
78+
flow: <1>
79+
#...
80+
podTemplate:
81+
container:
82+
image: your-registry/workflow_name:tag
83+
#...
84+
----
85+
<1> The `flow` definition must match the workflow definition used during the build process. When you deploy your workflow using the GitOps profile, the Operator compares this definition with the workflow files embedded in the container image. If the definition and files do not match, the deployment fails.
86+
87+
. Apply your CR to deploy the workflow:
88+
+
89+
[source,terminal]
90+
----
91+
$ oc apply -f <filename>
92+
----
93+
4194
include::modules/serverless-logic-editing-workflows.adoc[leveloffset=+1]
4295
include::modules/serverless-logic-testing-workflows.adoc[leveloffset=+1]
4396
include::modules/serverless-logic-troubleshooting-workflows.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)