This repository includes the infrastructure and pipeline definition for continuous delivery using Jenkins, Nexus and SonarQube on OpenShift. On every pipeline execution, the code goes through the following steps:
- Code is cloned from Gogs, built, tested and analyzed for bugs and bad patterns
- The WAR artifact is pushed to Nexus Repository manager
- A Docker image (tasks:latest) is built based on the Tasks application WAR artifact deployed on JBoss EAP 6
- The Tasks Docker image is deployed in a fresh new container in DEV project
- If tests successful, the DEV image is tagged with the application version (tasks:7.x) in the STAGE project
- The staged image is deployed in a fresh new container in the STAGE project
The following diagram shows the steps included in the deployment pipeline:
The application used in this pipeline is a JAX-RS application which is available on GitHub and is imported into Gogs during the setup process: https://github.com/OpenShiftDemos/openshift-tasks
Follow these instructions in order to create a local OpenShift cluster. Otherwise using your current OpenShift cluster, create projects for CI/CD components and Dev and Stage environments:
oc new-project dev --display-name="Tasks - Dev"
oc new-project stage --display-name="Tasks - Stage"
oc new-project cicd --display-name="CI/CD"
Jenkins needs to access OpenShift API to discover slave images as well accessing container images. Grant Jenkins service account enough privileges to invoke OpenShift API for the created projects:
oc policy add-role-to-user edit system:serviceaccount:cicd:jenkins -n dev
oc policy add-role-to-user edit system:serviceaccount:cicd:jenkins -n stage
Create the CI/CD components based on the provided template
oc process -f cicd-template.yaml | oc create -f -
Note: you need ~6GB memory for running this demo.
- Jenkins has the Pipeline plugin pre-installed. A Jenkins pipeline job is also pre-configured which clones Tasks JAX-RS application source code from GitHub, builds, deploys and promotes the result through the deployment pipeline. Click on
tasks-cd-pipelineand Configure and explore the pipeline definition.
Default Jenkins credentials: admin/password Default Gogs credentials: admin/gogs
-
Run an instance of the pipeline by starting the
tasks-cd-pipelinejob. -
During pipeline execution, verify a new Jenkins slave pod is created within CI/CD project to execute the pipeline.
-
Pipelines pauses at Deploy STAGE for approval in order to promote the build to the STAGE environment. Click on this step on the pipeline and then Promote.
-
After pipeline completion, demonstrate the following:
- Explore the
snapshotsrepository in Nexus and verifyopenshift-tasksis pushed to the repository - Explore SonarQube and verify a project is created with metrics, stats, code coverage, etc
- Explore Tasks - Dev project in OpenShift console and verify the application is deployed in the DEV environment
- Explore Tasks - Stage project in OpenShift console and verify the application is deployed in the STAGE environment
-
Clone the
openshift-tasksgit repository and using an IDE (e.g. JBoss Developer Studio), remove the@Ignoreannotation fromsrc/test/java/org/jboss/as/quickstarts/tasksrs/service/UserResourceTest.javatest methods to enable the unit tests. Commit and push to the git repo. -
Check out Jenkins, a pipeline instance is created and is being executed. The pipeline will fail during unit tests due to the enabled unit test.
-
Check out the failed unit and test
src/test/java/org/jboss/as/quickstarts/tasksrs/service/UserResourceTest.javaand run it in the IDE. -
Fix the test by modifying
src/main/java/org/jboss/as/quickstarts/tasksrs/service/UserResource.javaand uncommenting the sort function ingetUsersmethod. -
Run the unit test in the IDE. The unit test runs green. Commit and push the fix to the git repository and verify a pipeline instance is created in Jenkins and executes successfully.
Pipeline in OpenShift 3.3 is a tech preview feature and disabled by default. The steps required to enable this feature is detailed in OpenShift documentation.
-
SonarQube sometimes fails to load quality profiles requires for static analysis. Scale down the SonarQube pod and its database to 0 and then scale them up to 1 again in order to re-initialize SonarQube.
-
Downloading the images might take a while depending on the network. Remove the install-gogs pod and re-create the app to retry Gogs initialization.
$ oc delete pod install-gogs $ oc process -f cicd-template.yaml | oc create -f - pod "install-gogs" created Error from server: routes "jenkins" already exists Error from server: deploymentconfigs "jenkins" already exists Error from server: serviceaccounts "jenkins" already exists Error from server: rolebinding "jenkins_edit" already exists ...