One of the interesting part if the CI/CD in Openshift, which provided built-in capabilities using embeded Jenkins for that, 2 ways to build CI/CD using Jenkins either use Jenkins directly and configure everything or uses OpenShift Pipeline feature which uses Jenkins behind the scene, we will demonstrate both in this post.
In this post, I will go through this using GitHub + OpenShift + Jenkins.
Pre-requisites:
You have deployed your application and have build configurations for that application already configured in OpenShift.
Get the Jenkins URL from the Routes section:
a) General Tab
Add project description and may be GitHub URL (just some information about the project)
b) Source Code Management
Add your project source code for me I have added: https://github.com/osa-ora/AcmeInternetBankingApp as my own repository and I uses the master branch for all the builds in my sample project.
c) Build Triggers
Check Poll SCM and configure it like */2 * * * * which means every 2 minutes check for any new commits in the configured branch in the GitHub configured repository
This is similar to cron job configurations: MINUTE HOUR DOM MONTH DOW
This is one way to achieve CI/CD from GitHub the other way that we are going to use is to use the WebHook to push any changes from GitHub to Jenkins as below in step 2 & 3 as it uses push rather than keep pinging GitHub for any changes.
d) Build
This is the core of any Jenkins project, you need to configure every step from the build till the deployment.
In Trigger OpenShift build add the project name and build name as in OpenShift, also check the box for getting the build output, both project nme and build config should match exactly what is configured in OpenShift for this application.
In deployment do the same, also configure the image stream name, tags, etc. and check the box for deployment validation.
You can optionally add scaling to the project as per the required number of nodes.
e) Post Build Actions
You can optionally add some post build actions, like running certain script or some test cases, etc.
To verify that every thing is configured properly, execute build now and check the console output, if any issues fix them.
The console output should show successful build and deployment steps:
Go to GitHub section and get the WebHook URL, and save it in a notepad file.
Now, with every new push to the GitHub an invocation to Jenkins hook URL, so Jenkins can start building the project and deploy it.
You can see Jenkins invoked with this new commit push.
And now we have a complete cycle from pushing the code, build, deploy and may be test as well.
OpenShift has the capability to hide all Jenkins configurations by using OpenShift Pipeline feature in the build tab.
To use it all you need to do is to structure a file format for the pipeline such as the following:
Note that the main components of the pipeline file is the stages which have a name and one or more actions to do.
And now we have another complete cycle from pushing the code, build, deploy and may be test as well but using OpenShift Pipeline feature this time.
In this post, I will go through this using GitHub + OpenShift + Jenkins.
Pre-requisites:
You have deployed your application and have build configurations for that application already configured in OpenShift.
Before We Start: Add Jenkins to OpenShift
From the search box, search for Jenkins and add it to your project, go through the configuration wizard and wait for its deployment till you get the Jenkins end point.
Get the Jenkins URL from the Routes section:
Use Case I: Using Jenkins Directly
1) Configure Jenkins
The Instant app Jenkins that come with OpenShift has a built in plugin for interaction with OpenShift, there is a sample project which you can either use or create a new one, simply rename the sample project with your project name and let's configure this step by step.a) General Tab
Add project description and may be GitHub URL (just some information about the project)
b) Source Code Management
Add your project source code for me I have added: https://github.com/osa-ora/AcmeInternetBankingApp as my own repository and I uses the master branch for all the builds in my sample project.
c) Build Triggers
Check Poll SCM and configure it like */2 * * * * which means every 2 minutes check for any new commits in the configured branch in the GitHub configured repository
This is similar to cron job configurations: MINUTE HOUR DOM MONTH DOW
This is one way to achieve CI/CD from GitHub the other way that we are going to use is to use the WebHook to push any changes from GitHub to Jenkins as below in step 2 & 3 as it uses push rather than keep pinging GitHub for any changes.
This is the core of any Jenkins project, you need to configure every step from the build till the deployment.
In Trigger OpenShift build add the project name and build name as in OpenShift, also check the box for getting the build output, both project nme and build config should match exactly what is configured in OpenShift for this application.
In deployment do the same, also configure the image stream name, tags, etc. and check the box for deployment validation.
You can optionally add scaling to the project as per the required number of nodes.
e) Post Build Actions
You can optionally add some post build actions, like running certain script or some test cases, etc.
To verify that every thing is configured properly, execute build now and check the console output, if any issues fix them.
2) Enable Jenkins WebHook
Now from Jenkins settings (Manage Jenkins ==> Configure System)
3) Configure GitHub WebHooks
Go to the GitHub project go to Settings and select WebHooks and add the Jenkins hook url, content type as application/json and send only push events and make sure it is active and save this webhook configurations.
Now, with every new push to the GitHub an invocation to Jenkins hook URL, so Jenkins can start building the project and deploy it.
4) Test it
Now commit a new change to your project and push it to the Git Repository branch that you configured in GitHub and wait for workflow to be invoked and changes to be deployed.
You can see Jenkins invoked with this new commit push.
Use Case II: Using OpenShift Pipelines
OpenShift has the capability to hide all Jenkins configurations by using OpenShift Pipeline feature in the build tab.
To use it all you need to do is to structure a file format for the pipeline such as the following:
1) Build the Pipeline File
This is a sample file that has 3 stages; one for build, then deploy and 3rd one for scaling.
Note that the main components of the pipeline file is the stages which have a name and one or more actions to do.
2) Import the Pipeline File
Select Import YAML/JSON and copy and paste the file content.
Validate by Invoking the pipeline to see if the progress is okay and no issues with your configurations.
3) Get the Pipeline WebHook URL
From inside the pipeline get the Hook URL.4) Configure GitHub WebHook
Similar to what we did in step 3 in the first use case above.And now we have another complete cycle from pushing the code, build, deploy and may be test as well but using OpenShift Pipeline feature this time.
No comments:
Post a Comment