Chapter 1. Getting started

Procedure

1. Create a new OpenShift Serverless Logic workflow project by running the following command:

   $ kn workflow create

   By default, the generated project name is new-project. You can change the project name by using the [-n|--name] flag as follows:

   Example command

   $ kn workflow create --name my-project

Procedure

1. Run the following command to build and run your OpenShift Serverless Logic workflow project:

   $ kn workflow run

   When the project is ready, the Development UI automatically opens in your browser on localhost:8080/q/dev-ui and you will find the Serverless Workflow Tools tile available. Alternatively, you can access the tool directly using http://localhost:8080/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows.

Procedure

1. Create the workflow configuration YAML file.

   Example workflow-dev.yaml file

   apiVersion: sonataflow.org/v1alpha08
   kind: SonataFlow
   metadata:
     name: greeting 1
     annotations:
       sonataflow.org/description: Greeting example on k8s!
       sonataflow.org/version: 0.0.1
       sonataflow.org/profile: dev 2
   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

   1

   is a workflow_name

   2

   indicates that you must deploy the workflow in Dev mode

2. To deploy the application, apply the YAML file by entering the following command:

   $ oc apply -f <filename> -n <your_namespace>

3. Verify the deployment and check the status of the deployed workflow by entering the following command:

   $ oc get workflow -n <your_namespace> -w

   Ensure that your workflow is listed and the status is Running or Completed.

4. Edit the workflow directly in the cluster by entering the following command:

   $ oc edit sonataflow <workflow_name> -n <your_namespace>

5. After editing, save the changes. The OpenShift Serverless Logic Operator detects the changes and updates the workflow accordingly.

Verification

1. To ensure the changes are applied correctly, verify the status and logs of the workflow by entering the following commands:

   1. View the status of the workflow by running the following command:

      $ oc get sonataflows -n <your_namespace>

   2. View the workflow logs by running the following command:

      $ oc logs <workflow_pod_name> -n <your_namespace>

Next steps

1. After completing the testing, delete the resources to avoid unnecessary usage by running the following command:

   $ oc delete sonataflow <workflow_name> -n <your_namespace>

Procedure

1. Open and edit the ConfigMap by running the following command:

   $ oc edit cm <workflow_name>-props -n <namespace>

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

2. Add the properties in the application.properties section.

   Example of a workflow properties stored within a ConfigMap:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     labels:
       app: greeting
     name: greeting-props
     namespace: default
   data:
     application.properties: |
       my.properties.key = any-value

   Ensure the properties are correctly formatted to prevent the Operator from replacing your configuration with the default one.

3. After making the necessary changes, save the file and exit the editor.

Procedure

1. To create a route for the specified service in your namespace by running the following command:

   $ oc expose svc <service_name> -n <namespace>

2. To fetch the URL for the newly exposed service by running the following command:

   $ WORKFLOW_SVC=$(oc get route/<service_name> --template='{{.spec.host}}')

3. Perform a test HTTP call and send a POST request by running the following command:

   $ curl -X POST -H 'Content-Type:application/json' -H 'Accept:application/json' -d '<request_body>' http://$WORKFLOW_SVC/<endpoint>

4. Verify the response to ensure the workflow is functioning as expected.

Procedure

1. Check the workflow status by running the following command:

   $ oc get workflow <name> -o jsonpath={.status.conditions} | jq .

2. To fetch and analyze the the logs from the workflow’s deployment, run the following command:

   $ oc logs deployment/<workflow_name> -f

Procedure

1. Verify that you have the correct file that defines the Workflow you want to delete. For example, workflow.yaml.

2. Run the oc delete command to remove the Workflow from your specified namespace:

   $ oc delete -f <your_file> -n <your_namespace>

   Replace <your_file> with the name of your Workflow file and <your_namespace> with your namespace.