Deploying your Serverless Workflow application on Kubernetes
This document describes how to deploy a SonataFlow application using a Kubernetes cluster, along with a procedure to run the Knative platform.
-
Your SonataFlow application is ready to use.
For more information about building the application container, see Building workflow images using Quarkus CLI. -
Kubernetes Cluster is available
-
kubectl
command-line tool is installed -
Knative CLI is installed.
For more information, see Install the Knative CLI. -
Knative workflow CLI is installed.
For more information see Serverless Workflow plug-in for Knative CLI. -
(Optional) Quarkus CLI is installed.
For more information, see Building Quarkus Apps with Quarkus command line interface (CLI).
Before proceeding further, make sure that you have access to the Kubernetes cluster with Knative available.
Verifying Knative availability on Kubernetes
To make sure Knative is available, it can be checked with the commands below:
kubectl get services -n knative-serving
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
activator-service ClusterIP 10.97.110.167 <none> 9090/TCP,8008/TCP,80/TCP,81/TCP,443/TCP 44m
autoscaler ClusterIP 10.98.64.78 <none> 9090/TCP,8008/TCP,8080/TCP 44m
autoscaler-bucket-00-of-01 ClusterIP 10.111.19.134 <none> 8080/TCP 44m
controller ClusterIP 10.98.150.141 <none> 9090/TCP,8008/TCP 44m
default-domain-service ClusterIP 10.106.202.150 <none> 80/TCP 43m
domainmapping-webhook ClusterIP 10.102.87.208 <none> 9090/TCP,8008/TCP,443/TCP 44m
net-kourier-controller ClusterIP 10.100.120.208 <none> 18000/TCP 43m
webhook ClusterIP 10.108.153.180 <none> 9090/TCP,8008/TCP,443/TCP 44m
For more information on how to figure out if Knative is installed please refer to this link. If not, follow the installation steps described in the Knative documentation.
Deploying your workflow application on Kubernetes
Once Knative is ready, you can initiate the process of deploying your SonataFlow application on Kubernetes.
-
Kubernetes with Knative is ready.
-
Knative is ready.
For more information, see Verifying Knative on Kubernetes. -
Knative CLI is installed.
-
(Optional) Quarkus CLI is installed.
For more information, see Building Quarkus Apps with Quarkus command line interface (CLI). -
Your SonataFlow application is ready to use.
By default, Kubernetes does not have any registry installed. You can check with the administrator if a private registry is available. Otherwise, you can publish the Application Container image on the Quay.io, or on any other registry of your preference. If the registry requires authentication you need to create a Pull Secret with the registry credentials, for more information please take a look in this link. |
-
Create
serverless-workflow-greeting-quarkus
namespace using the following command:Create namespacekubectl create namespace serverless-workflow-greeting-quarkus
-
Set the Kubernetes context to the newly created namespace using the following command:
Set Kubernetes context to a namespacekubectl config set-context --current --namespace=serverless-workflow-greeting-quarkus
After setting the context, all kubectl commands will use the selected namespace.
You can use the following command to verify the current namespace:Verify the current namespacekubectl config view --minify -o jsonpath='{..namespace}'
-
Deploy your SonataFlow application on Kubernetes.
The next step is to deploy your workflow application and execute it. You can read the further sections on the different procedures to deploy your SonataFlow application.
You can use the native image due to the faster startup.
In the following procedures, you can find different approaches to deploy your workflow application, such as:
For this tutorial, we use the |
Deploying your workflow application using Knative CLI
Once you have pushed your workflow application into the target registry, you can use the command-line tools, such as Knative CLI or Kubernetes CLI
to initiate the deployment process.
-
Workflow application is installed.
-
Knative CLI is installed.
For more information, see Install the Knative CLI.
-
In a command terminal, execute the following command to deploy your workflow application using Knative CLI:
Example of deploying workflow application using Knative CLIkn service create hello-workflow \ --image=quay.io/kiegroup/serverless-workflow-greeting-quarkus:1.0 \ --pull-policy=IfNotPresent \ --port 8080
Example outputCreating service 'hello-workflow' in namespace 'serverless-workflow-greeting-quarkus': 0.066s The Route is still working to reflect the latest desired specification. 0.099s ... 0.322s Configuration "hello-workflow" is waiting for a Revision to become ready. 4.885s ... 5.061s Ingress has not yet been reconciled. 5.322s Waiting for load balancer to be ready 5.460s Ready to serve. Service 'hello-workflow' created to latest revision 'hello-workflow-00001' is available at URL: http://hello-workflow.serverless-workflow-greeting-quarkus.10.103.94.37.sslip.io
Depending on the cluster type where you have deployed the workflow application, the service URL might be different. Pay attention to the output to use the correct URL in the next topic. |
Verify if the workflow application is deployed correctly:
NAME URL LATEST AGE CONDITIONS READY REASON
hello-workflow http://hello-workflow.serverless-workflow-greeting-quarkus.10.103.94.37.sslip.io hello-workflow-00001 7m6s 3 OK / 3 True
curl -X POST -H 'Content-Type:application/json' -H 'Accept:application/json' -d '{"name": "John", "language": "English"}' http://hello-workflow.serverless-workflow-greeting-quarkus.10.103.94.37.sslip.io/jsongreet
{"id":"0f77abce-837e-4bd2-b4f1-a0e5e0265fcb","workflowdata":{"name":"John","language":"English","greeting":"Hello from JSON Workflow, "}}
Deploying your workflow application using Kubernetes CLI
You can also use kubectl
command-line interface and plain Kubernetes objects to deploy your workflow application.
And, instead of creating knative
yaml|json
descriptors, you can leverage the Quarkus Kubernetes extension and Kogito Knative add-on to generate the descriptors.
-
Kogito Workflow application ready to use.
-
Kubernetes CLI
command-line tool is installed. -
(Optional) Quarkus CLI is installed
For more information about installing the Quarkus CLI, see Installing the Quarkus CLI.
-
Add the Quarkus extensions to generate
knative
yaml|json
descriptors.To use the Quarkus Kubernetes extension and Kogito Knative add-on, ensure that the following dependencies are available in the
pom.xml
file and Gradle:<dependency> <groupId>org.kie.kogito</groupId> <artifactId>kogito-addons-quarkus-knative-eventing</artifactId> </dependency> <dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-kubernetes</artifactId> </dependency>
quarkus-kubernetes 'io.quarkus:quarkus-kubernetes:2.16.9.Final' quarkus-kubernetes 'org.kie.kogito:kogito-addons-quarkus-knative-eventing:1.43.0.Final'
quarkus ext add org.kie.kogito:kogito-addons-quarkus-knative-eventing quarkus-openshift1.43.0.Final'
-
To generate the
knative
yaml|json
descriptors, set the following properties in theapplication.properties
file of your workflow application:System properties to generate knative descriptorsquarkus.kubernetes.deployment-target=knative quarkus.knative.name=hello-workflow
-
Build your workflow application.
Once you have built your application, you can find the generated descriptors files in the
target/kubernetes
directory:-
knative.json
-
knative.yml
The image used in this section is the one built in the following guide: Build Workflow Image with Quarkus CLI.
Following is an example of the generated files:
Knative descriptor example for a workflow application--- apiVersion: serving.knative.dev/v1 kind: Service metadata: annotations: app.quarkus.io/commit-id: 06c3fe8e2dfc42e2211cbcc41224f5a3d6bd1f26 app.quarkus.io/build-timestamp: 2022-06-23 - 23:53:38 +0000 labels: app.kubernetes.io/name: hello-workflow name: hello-workflow spec: template: metadata: labels: app.kubernetes.io/name: hello-workflow spec: containerConcurrency: 0 containers: - image: quay.io/kiegroup/serverless-workflow-greeting-quarkus:1.0-native livenessProbe: failureThreshold: 3 httpGet: path: /q/health/live port: null scheme: HTTP initialDelaySeconds: 0 periodSeconds: 30 successThreshold: 1 timeoutSeconds: 10 name: hello-workflow ports: - containerPort: 8080 name: http1 protocol: TCP readinessProbe: failureThreshold: 3 httpGet: path: /q/health/ready port: null scheme: HTTP initialDelaySeconds: 0 periodSeconds: 30 successThreshold: 1 timeoutSeconds: 10
Once the files are generated, you must add the
imagePullPolicy
manually before deploying the workflow application. -
-
Enter the following command to deploy the workflow application using
kubectl
:Deploy the workflow application usingkubectl
kubectl apply -f target/kubernetes/knative.yml
Verify if the workflow application is deployed correctly:
NAME URL LATEST AGE CONDITIONS READY REASON
hello-workflow http://hello-workflow.serverless-workflow-greeting-quarkus.10.103.94.37.sslip.io hello-workflow-00001 7m6s 3 OK / 3 True
curl -X POST -H 'Content-Type:application/json' -H 'Accept:application/json' -d '{"name": "John", "language": "English"}' http://hello-workflow.serverless-workflow-greeting-quarkus.10.103.94.37.sslip.io/jsongreet
{"id":"0f77abce-837e-4bd2-b4f1-a0e5e0265fcb","workflowdata":{"name":"John","language":"English","greeting":"Hello from JSON Workflow, "}}
Deploying your workflow application using Quarkus CLI
-
Workflow application is ready.
-
Quarkus CLI is installed.
For more information, see Building Quarkus Apps with Quarkus command line interface (CLI).
-
Add the Quarkus extensions to deploy the
knative
service.You can add the Kubernetes and the Kogito Knative extensions to your project with the Quarkus CLI:
Add Kubernetes and Kogito Knative extensions to the project with Quarkus CLIquarkus ext add quarkus-kubernetes kogito-addons-quarkus-knative-eventing
-
To deploy the workflow application using Quarkus CLI, set the following system properties in
application.properties
file:Required system propertiesquarkus.knative.name=hello-workflow (1) quarkus.kubernetes.deployment-target=knative (2) quarkus.kubernetes.deploy=true (3) quarkus.container-image.push=true (4) quarkus.container-image.group=kiegroup (5) quarkus.container-image.registry=quay.io (6) quarkus.container-image.tag=1.0-SNAPSHOT (7)
1 Property to set the Knative service name 2 Property to set the target deployment type 3 Property to set whether or not deploy on an active Kubernetes cluster 4 Property to push or not the Container image to the given registry 5 Property to define which registry group/namespace the built image belongs to 6 Property to define to which registry the built image will be pushed to 7 Sets the built Container Image tag This feature works with Quarkus 2.10.2.Final or later. For more information, see link.
quarkus build -DskipTests
The |
Verify if the workflow application is deployed correctly:
NAME URL LATEST AGE CONDITIONS READY REASON
hello-workflow http://hello-workflow.serverless-workflow-greeting-quarkus.10.103.94.37.sslip.io hello-workflow-00001 7m6s 3 OK / 3 True
curl -X POST -H 'Content-Type:application/json' -H 'Accept:application/json' -d '{"name": "John", "language": "English"}' http://hello-workflow.serverless-workflow-greeting-quarkus.10.103.94.37.sslip.io/jsongreet
{"id":"0f77abce-837e-4bd2-b4f1-a0e5e0265fcb","workflowdata":{"name":"John","language":"English","greeting":"Hello from JSON Workflow, "}}
Found an issue?
If you find an issue or any misleading information, please feel free to report it here. We really appreciate it!