Chapter 1. Getting started

Procedure

1. Create a workflow YAML file similar to the following:

   apiVersion: sonataflow.org/v1alpha08
   kind: SonataFlow
   metadata:
     name: greeting
     annotations:
       sonataflow.org/description: Greeting example on k8s!
       sonataflow.org/version: 0.0.1
   spec:
     flow:
       start: ChooseOnLanguage
       functions:
         - name: greetFunction
           type: custom
           operation: sysout
       states:
         - name: ChooseOnLanguage
           type: switch
           dataConditions:
             - condition: "${ .language == \"English\" }"
               transition: GreetInEnglish
             - condition: "${ .language == \"Spanish\" }"
               transition: GreetInSpanish
           defaultCondition: GreetInEnglish
         - name: GreetInEnglish
           type: inject
           data:
             greeting: "Hello from JSON Workflow, "
           transition: GreetPerson
         - name: GreetInSpanish
           type: inject
           data:
             greeting: "Saludos desde JSON Workflow, "
           transition: GreetPerson
         - name: GreetPerson
           type: operation
           actions:
             - name: greetAction
               functionRef:
                 refName: greetFunction
                 arguments:
                   message:  ".greeting+.name"
           end: true

   Copy to Clipboard Toggle word wrap

2. Apply the SonataFlow workflow definition to your OpenShift Container Platform namespace by running the following command:

   $ oc apply -f <workflow-name>.yaml -n <your_namespace>

   Copy to Clipboard Toggle word wrap

   Example command for the greetings-workflow.yaml file:

   $ oc apply -f greetings-workflow.yaml -n workflows

   Copy to Clipboard Toggle word wrap

3. List all the build configurations by running the following command:

   $ oc get buildconfigs -n workflows

   Copy to Clipboard Toggle word wrap

4. Get the logs of the build process by running the following command:

   $ oc logs buildconfig/<workflow-name> -n <your_namespace>

   Copy to Clipboard Toggle word wrap

   Example command for the greetings-workflow.yaml file:

   $ oc logs buildconfig/greeting -n workflows

   Copy to Clipboard Toggle word wrap

Verification

1. To verify the deployment, list all the pods by running the following command:

   $ oc get pods -n <your_namespace>

   Copy to Clipboard Toggle word wrap

   Ensure that the pod corresponding to your workflow is running.

2. Check the running pods and their logs by running the following command:

   $ oc logs pod/<pod-name> -n workflows

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a workflow YAML file similar to the following:

   apiVersion: sonataflow.org/v1alpha08
   kind: SonataFlow
   metadata:
     name: greeting
     annotations:
       sonataflow.org/description: Greeting example on k8s!
       sonataflow.org/version: 0.0.1
   spec:
     flow:
       start: ChooseOnLanguage
       functions:
         - name: greetFunction
           type: custom
           operation: sysout
       states:
         - name: ChooseOnLanguage
           type: switch
           dataConditions:
             - condition: "${ .language == \"English\" }"
               transition: GreetInEnglish
             - condition: "${ .language == \"Spanish\" }"
               transition: GreetInSpanish
           defaultCondition: GreetInEnglish
         - name: GreetInEnglish
           type: inject
           data:
             greeting: "Hello from JSON Workflow, "
           transition: GreetPerson
         - name: GreetInSpanish
           type: inject
           data:
             greeting: "Saludos desde JSON Workflow, "
           transition: GreetPerson
         - name: GreetPerson
           type: operation
           actions:
             - name: greetAction
               functionRef:
                 refName: greetFunction
                 arguments:
                   message:  ".greeting+.name"
           end: true

   Copy to Clipboard Toggle word wrap

2. Create a route for the workflow service by running the following command:

   $ oc expose svc/<workflow-service-name> -n workflows

   Copy to Clipboard Toggle word wrap

   This command creates a public URL to access the workflow service.

3. Set an environment variable for the public URL by running the following command:

   $ WORKFLOW_SVC=$(oc get route/<workflow-service-name> -n <namespace> --template='{{.spec.host}}')

   Copy to Clipboard Toggle word wrap

4. Make an HTTP call to the workflow to send a POST request to the service by running the following command:

   $ curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{<"your": "json_payload">}' http://$WORKFLOW_SVC/<endpoint>

   Copy to Clipboard Toggle word wrap

   Example output

   {
     "id": "b5fbfaa3-b125-4e6c-9311-fe5a3577efdd",
     "workflowdata": {
       "name": "John",
       "language": "English",
       "greeting": "Hello from JSON Workflow, "
     }
   }

   Copy to Clipboard Toggle word wrap

   This output shows an example of the expected response if the workflow is running.

Procedure

1. Check if the SonataFlowBuild instance exists by running the following command:

   $ oc get sonataflowbuild <name> -n <namespace>

   Copy to Clipboard Toggle word wrap

2. Edit the SonataFlowBuild instance by running the following command:

   $ oc edit sonataflowbuild/<name> -n <namespace>

   Copy to Clipboard Toggle word wrap

   Replace <name> with the name of your SonataFlowBuild instance and <namespace> with the namespace where your workflow is deployed.

3. Add the sonataflow.org/restartBuild: true annotation to restart the build.

   apiVersion: sonataflow.org/v1alpha08
   kind: SonataFlowBuild
   metadata:
     name: <name>
     annotations:
       sonataflow.org/restartBuild: true

   Copy to Clipboard Toggle word wrap

   This action triggers the OpenShift Serverless Logic Operator to start a new build of the workflow.

4. To monitor the build process, check the build logs by running the following command:

   $ oc logs buildconfig/<name> -n <namespace>

   Copy to Clipboard Toggle word wrap

   Replace <name> with the name of your SonataFlowBuild instance and <namespace> with the namespace where your workflow is deployed.