CI/CD Demo on OpenShift
*For other versions of OpenShift, follow the instructions in the corresponding branch.
This repository includes the infrastructure and pipeline definition for continuous delivery using Jenkins, Nexus, SonarQube and Eclipse Che on OpenShift.
On every pipeline execution, the code goes through the following steps:
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
Download and install CodeReady Containers in order to create a local OpenShift 4 cluster on your workstation. Otherwise create an OpenShift 4 cluster on the public cloud or the infrastructure of your choice.
You can se the
scripts/provision.shscript provided to deploy the entire demo:
./provision.sh --help ./provision.sh deploy ./provision.sh delete
If you want to use Quay.io as an external registry with this demo, Go to quay.io and register for free. Then deploy the demo providing your quay.io credentials:
./provision.sh deploy --enable-quay --quay-username quay_username --quay-password quay_password
In that case, the pipeline would create an image repository called
tasks-app(default name but configurable) on your Quay.io account and use that instead of the integrated OpenShift registry, for pushing the built images and also pulling images for deployment.
Create the following projects for CI/CD components, Dev and Stage environments:
# Create Projects oc new-project dev --display-name="Tasks - Dev" oc new-project stage --display-name="Tasks - Stage" oc new-project cicd --display-name="CI/CD"
Grant Jenkins Access to Projects
oc policy add-role-to-group edit system:serviceaccounts:cicd -n dev oc policy add-role-to-group edit system:serviceaccounts:cicd -n stage
And then deploy the demo:
# Deploy Demo oc new-app jenkins-ephemeral -n cicd oc new-app -n cicd -f cicd-template.yaml
To use custom project names, change
stagein the above commands to your own names and use the following to create the demo:
oc new-app -n cicd -f cicd-template.yaml --param DEV_PROJECT=dev-project-name --param STAGE_PROJECT=stage-project-name
This demo by default uses the WildFly community image. You can use the JBoss EAP enterprise images provide by Red Hat by simply editing the
tasksbuild config in the Tasks - Dev project and changing the builder image from
jboss-eap70-openshift:1.5. The demo would work exactly the same and would build the images using the JBoss EAP builder image. If using Quay, be sure not to leave the JBoss EAP images on a publicly accessible image repository.
If Maven fails with
/opt/rh/rh-maven33/root/usr/bin/mvn: line 9: 298 Killed(e.g. during static analysis), you are running out of memory and need more memory for OpenShift.
If running into
Permission deniedissues on minishift or CDK, run the following to adjust minishift persistent volume permissions:
minishift ssh chmod 777 -R /var/lib/minishift/
Take note of these credentials and then follow the demo guide below:
A Jenkins pipeline is pre-configured which clones Tasks application source code from Gogs (running on OpenShift), builds, deploys and promotes the result through the deployment pipeline. In the CI/CD project, click on Builds and then Pipelines to see the list of defined pipelines.
Click on tasks-pipeline and Configuration and explore the pipeline definition.
You can also explore the pipeline job in Jenkins by clicking on the Jenkins route url, logging in with the OpenShift credentials and clicking on tasks-pipeline and Configure.
Run an instance of the pipeline by starting the tasks-pipeline in OpenShift or Jenkins.
During pipeline execution, verify a new Jenkins slave pod is created within CI/CD project to execute the pipeline.
If you have enabled Quay, after image build completes go to quay.io and show that a image repository is created and contains the Tasks app image
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:
Clone and checkout the eap-7 branch of the openshift-tasks git repository and using an IDE (e.g. JBoss Developer Studio), remove the
src/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 in getUsers method.
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.
You can install Eclipse Che on OpenShift 4 using the OperatorHub. Follow the Installing Che on OpenShift 4 from OperatorHub docs in order to install Eclipse Che 7. Alternatively, if you OpenShift cluster is accessible over the internet, you can use the hosted Eclipse Che service at https://che.openshift.io .
You can then follow these instructions to use Eclipse Che for editing code in the above demo flow.