Deploying camunda BPM process applications on the OpenShift cloud


Cloud at dusk over the skyline of Alicante, Spain.
Cloud at dusk over the skyline of Alicante, Spain. Photo by Rafael Cordones.

This post is a follow up from a previous article "A camunda BPM Quickstart for JBoss EAP 6.0 on OpenShift?" in which I wrote about deploying the camunda BPM engine on OpenShift. You should definitely have a look at it since it describes the quickstart project we will use in this article.

This post focuses on two things:

  1. how to initially deploy an existing application to camunda BPM running on JBoss EAP 6.x on OpenShift
  2. a proposal on how to manage the further development of the application and keep pushing new releases out to OpenShift

Note the word "proposal". This is how I do it and I would be very glad to hear about other approaches!

The two main requirements I have are:

  1. keep the OpenShift deployment environment aspect orthogonal to the rest of my application codebase, i.e. I want to be in a position to keep deploying my app to my internally managed deployment environment or I might even want to have several OpenShift deployment environments (test, staging, production).
  2. whenever a new camunda BPM release is supported by the camunda BPM OpenShift quickstart, I would like to be able to easily upgrade

In my humble opinion, the easiest way of doing fulfill these requirements, is to have a dedicated branch called "openshift" on which all the code/configuration related to camunda BPM on a given OpenShift deployment environment.

We will follow the steps using The Job Announcement as an example. Please note that you will need to create a JBoss EAP 6.x application type on OpenShift and get its corresponding Git deployment repository.

We first need to add both the 'quickstart' and the 'openshift' Git deployment repository remotes:

rafa@trane: ~/dev/vc/the-job-announcement$ git remote add quickstart
rafa@trane: ~/dev/vc/the-job-announcement$ git remote -v
openshift ssh:// (push)
openshift ssh:// (fetch)
origin (fetch)
origin (push)
quickstart (fetch)
quickstart (push)
upstream (push)
upstream (fetch)
rafa@trane: ~/dev/vc/the-job-announcement$

This is the purpose of each of those remotes is:

  • upstream: the canonical repository containing The Job Announcement project code
  • origin: my personal fork of the project on which I do my development work which I later push to 'upstream'
  • quickstart: the repository containing a JBoss EAP 6.x distributions with the camunda BPM engine already configured (check article "A camunda BPM Quickstart for JBoss EAP 6.0 on OpenShift?" for background)
  • opeshift: the OpenShift application deploymnet Git deployment repository to which we will push our application's code

We create the aforementioned 'openshift' branch and switch to it with:

Switched to a new branch 'openshift'
rafa@trane: ~/dev/vc/the-job-announcement$

We pull in the 'camunda-bpm-jboss-as-7.0.0-alpha3' tag from the 'quickstart' repository:

remote: Counting objects: 103, done.
remote: Compressing objects: 100% (44/44), done.
remote: Total 98 (delta 43), reused 98 (delta 43)
Unpacking objects: 100% (98/98), done.
 * tag               camunda-bpm-jboss-as-7.0.0-alpha3 -> FETCH_HEAD
Merge made by the 'recursive' strategy.
rafa@trane: ~/dev/vc/the-job-announcement$ 

The reason you (most probably) did not get any merge conflicts in the previous step is because I decided to remove all code whatsoever from the quickstart project. But this means that you will need to manually add (and commit) the following to your pom.xml:

    <!-- When built in OpenShift the 'openshift' profile will be used when invoking mvn. -->
    <!-- Use this profile for any OpenShift specific customization your app will need. -->
    <!-- By default that is to put the resulting archive into the 'deployments' folder. -->
    <!-- -->
rafa@trane: ~/dev/vc/the-job-announcement$ git ci -m "Added needed &lt;profile&gt; for OpenShift"
[openshift 8f9895d] Added needed &lt;profile&gt; for OpenShift
1 file changed, 20 insertions(+)
rafa@trane: ~/dev/vc/the-job-announcement$

We are now in a position to fetch the contents of the 'master' branch at OpenShift Git deployment repository with:

From ssh://
 * [new branch]      master     -> openshift/master
rafa@trane: ~/dev/vc/the-job-announcement$ 

And now, before we can replace the contents of the 'master' branch on the 'openshift' remote with the contents of our local 'openshift' branch we need to merge that branch into ours using the 'ours' strategy to make sure that any merging conflict is resolved by choosing the code from the 'quickstart' repository we pulled from before:

rafa@trane: ~/dev/vc/the-job-announcement$ git merge -s ours openshift/master
Merge made by the 'ours' strategy.
rafa@trane: ~/dev/vc/the-job-announcement$ 

You can also push now the 'openshift' branch to OpenShift for deployment (the 'master' branch on the 'openshift' remote):

rafa@trane: ~/dev/vc/the-job-announcement$ git push openshift openshift:master
Counting objects: 2288, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (1362/1362), done.
Writing objects: 100% (2274/2274), 4.05 MiB | 748 KiB/s, done.
Total 2274 (delta 846), reused 1906 (delta 683)
remote: restart_on_add=false
remote: Sending SIGTERM to jboss:28842 ...
remote: Done
remote: restart_on_add=false
remote: Running .openshift/action_hooks/pre_build
remote: [INFO] ------------------------------------------------------------------------
remote: [INFO] ------------------------------------------------------------------------
remote: [INFO] Total time: 8:16.535s
remote: [INFO] Finished at: Fri May 10 11:02:44 EDT 2013
remote: [INFO] Final Memory: 30M/158M
remote: [INFO] ------------------------------------------------------------------------
remote: Running .openshift/action_hooks/build
remote: Running .openshift/action_hooks/deploy
remote: hot_deploy_added=false
remote: Found listening port
remote: Done
remote: Running .openshift/action_hooks/post_deploy
To ssh://
   d38fcb0..73cbd9f  openshift -> master
rafa@trane: ~/dev/vc/the-job-announcement$

After OpenShift has built your application from source and deployed it, your application should be ready to rock at the OpenShift's provided URL:

Feedback welcome!

You can reach me either via the comments section below or via any of the social coordinates you will find on the top right corner of this page.