Baris Can Vural

Apr 30, 2018

Deploy a Hippo CMS Project to the Bloomreach Cloud (OD1) with 1 Click or Less

Deploying CMS projects with a jenkins environment injector plugin

How to Deploy a Simple Hippo CMS Project Through Jenkins Automation

Jenkins is a very popular automation server that is used for continuous integration and continuous delivery (CI/CD) pipelines. This lab post will serve as a guide on how to automate building a typical Bloomreach CMS project and deploying it on the Bloomreach Cloud / OnDemand 1 environment through Rundeck.
 

The typical Steps:

Bloomreach CMS developers usually take the following steps to deploy a version of the project using the OD1 environment:

  1. Run mvn clean verify && mvn -Pdist
  2. Use SFTP to send the distribution file over, where it is visible on the Rundeck website.
  3. Select the correct distribution and deploy it to the correct environment.
     

💪 What we have:

  1. A Jenkins server
  2. Code repository (GitHub) where our Hippo CMS project resides
  3. Environment where we deploy using Rundeck
     

🔍 What we want:

Build and deploy with 1 click or less. I will outline the steps required to trigger the build and deployment manually through the Jenkins UI, but triggering push/pull request events from GitHub to automatically trigger the whole build and deploy process is also possible.
 

Jenkins Requirements: 

Jenkins is all about the functionalities that installed plugins provide. If you are the one setting up the server, make sure you install the suggested plugins. The list of plugins you will need are:

Credential Configuration:

Since we will be communicating with the Rundeck server, we are going to have to set up the credentials within Jenkins. This will allow us to use SFTP to transfer the distribution file without having to provide a password.

First, we go to the Credentials option on the left-hand panel of the Jenkins Homepage.

left-hand panel of jenkins environment injector plugin

 

Configure the login credentials. This is for the SFTP command.

login credentials in jenkins environment injector plugin

 

Next, we are going to configure the Rundeck plugin for Jenkins:

configuration of jenkins environment injector plugin

 

Go to ‘Configure System’ and fill in the plugin configuration with your details:

jenkins environment injector plugin configuration

 

In the actual build and deploy steps, we will refer to these configurations we just created. Let’s start by giving the project a name and showing the GitHub project URL:

jenkins environment injector plugin project in GitHub

 

A little further down the page, select the SSH configuration we configured earlier on:

SSH configuration of the jenkins environment injector plugin

 

Further down, we add the actual build script:

 

Lastly, a little below, we add the Rundeck plugin configuration:

configure rundeck and jenkins environment injector plugin


That’s it! Now the build job should fetch the code from GitHub, build it and deploy it through Rundeck! 🤓

Newsletter

Don’t miss the next post!

Join
Don’t miss the next post!