Your Engineering Excellency

Transcription

1 Your Engineering Excellency With hundreds of projects in dozens of industries, EPAM Systems can boast expertise and excellence in lots of different technologies. E-commerce, Big Data, content management, digital asset management these are but a few areas where EPAM can be trusted to deliver a unique and reliable solution. However, no matter which product we develop, in which industry and for which customer, it all boils down to the same requirements code quality, timely delivery, reliable performance. With lots of project teams, development platforms and tools, it was critical to come up with a unified approach to code quality and continuous delivery to ensure top-notch end product. This requirement evolved into a whole dedicated project, EngX, which is committed to help development projects to establish the most effective, productive and optimal engineering process. The EngX team is in constant search and analysis of engineering tools and best practices and they are ready to share their expertise and knowledge with the rest of the EPAM Community. Naturally, all good things developed in EPAM eventually find their way to EPAM Cloud, because it is the easiest way to make a service or tool available for everyone. The EngX project also offered to combine their experience and know-how with Cloud technology, and soon EPAM Cloud started developing its first CI/CD service Jenkins as a Service. We continued adding services one by one. Jenkins, the core continuous integration service, was followed by Gerrit for code review and SonarQube for code quality inspection. And now, the final piece of the puzzle has fallen into place Artifactory as a Service was released in February, 2017, completing the CI/CD package which can be deployed in Cloud. Of course, to create a fully functional CI/CD environment, it is not enough to have four standalone services. The key point was to enable their automatic integration, so that all flows work smoothly and require minimum manual interventions. The Jenkins-Gerrit and Jenkins-SonarQube integration is automatic. As soon as you start Jenkins and Gerrit services for your project, all corresponding jobs are created and data exchange is established properly. Similar processes occur when Jenkins and SonarQube are started. However, when you start all three services simultaneously, there should be some manual setup, as Gerrit and SonarQube are not integrated automatically. You will need to install a special plugin, create a dedicated job and make certain configuration settings. You can find detailed instructions on Gerrit-SonarQube integration below. After you have completed all integration steps, you will have a functional CI/CD environment with code review and code quality inspection tools. This is a solid platform which can help your project to achieve better code quality and stable and timely delivery. However, you can make the most of Cloud CI/CD by using Artifactory as a Service. By activating the service, you are getting a JFrog Artifactory server together with a storage for your artifact collections and metadata.

2 Currently, Artifactory is not immediately integrated with your Jenkins, this also requires some manual configuration installing a plugin and setting up its parameters for Artifactory to be properly connected to Jenkins. See below for details on integrating Artifactory with Jenkins. As the result, you will have a complete Cloud-based CI/CD environment which requires minimal manual configuration. All required virtual resources will be created and all components will be deployed automatically. EPAM AD VM 5: Artifactory VM 3: Jenkins VM 1: Gerrit VM 2: PostgreSQL SSH VM 4: SonarQube Volume 1 Volume 2 Volume 3 Git data Cache Site SSH git.epam.com Jenkins-Sonar-Gerrit Integration Start with activating Jenkins, Sonar and Gerrit services for your project: or2ms -p project -r region -a -s jenkins or2ms - p project -r region -a -s sonar or2ms - p project -r region -a -s gerrit These are the basic command examples, while you can customize your services, for example, by specifying an SSH key with which the service will be started, by adding other optional parameters. See the Services Guide for details on service activation. Verify that the servers have been started and the services are available: or2dser - p project -r region Login to Jenkins to make sure that all integrations are configured: To check that Jenkins-Sonar integration is ready, navigate to Manage Jenkins -> Configure System. You should see your Sonar server in SonarQube servers section:

3 To check that Jenkins-Gerrit integration is ready, navigate to Manage Jenkins -> Gerrit Trigger. There you can see actual status of Jenkins-Gerrit integration (a blue ball means that everything works as expected): To integrate Sonar and Gerrit, perform the following steps: 1) Install the Sonar Gerrit Plugin : Go to Manage Jenkins -> Manage Plugins -> Available and search for Sonar Gerrit Plugin. Install using the Download now and install after restart option:

4 2) Configure your job (you can copy it from example_gerrit_job as Gerrit configuration will remain the same): After copying the job, you should continue configuration from the Build stage. Please note that you may need to add the Execute SonarQube Scanner step twice, as Sonar Gerrit Plugin requires Sonar report generated only in the preview mode (see the Additional arguments section on the screenshot below). Please also note that the Analysis properties section is specific for each project, so it should be changed in all cases.

5 After completing the Build stage, you can proceed with your configuration. In the Post-build Actions stage choose the Post SonarQube issues as Gerrit comments option. You need to configure 3 fields here: SonarQube URL your Sonar service URL which you can get using or2dser command. SonarQube report path path to the generated reports. If you apply the same settings as on screenshot above, this path should be equal to:.sonar/sonar-report.json

6 Click the Advanced button and set the Category field value to Sonar-Check: 3) Disable the example_gerrit_job by clicking the Disable Project button on the job page: 4) Push changes to your Gerrit. Your job will be triggered automatically. After the execution you can find analysis results in Gerrit change request (the links to both Sonar and Gerrit can be found in the Build History section near build number):

7 You can see that History now contains +1 Sonar-Check from Sonar and +1 Verified from Jenkins showing that all integrations are properly finished and operational.

8 Jenkins-Artifactory Integration Start with activating Jenkins and Artifactory services for your project: or2ms -p project -r region -a -s jenkins or2ms - p project -r region -a -s artifactory These are the basic command examples, while you can customize your services by adding other optional parameters. See the Services Guide for details on service activation. Verify that the servers have been started and the services are available: or2dser - p project -r region Login to Jenkins and perform the following steps to integrate your Artifactory service with Jenkins: 1) Install the Artifactory plugin. Navigate to Manage Jenkins -> Manage Plugins -> Available and search for Artifactory plugin:

9 Install the plugin using the Download now and install after restart option 2) Create configurations for the Artifactory plugin. Navigate to Manage Jenkins -> Configure System Add your Artifactory service and admin credentials to Artifactory section: 3) Integration is now complete, and you can use Artifactory in your work. For example, upload a simple file after the build:

10 After the upload, you will be able to find the same file on your Artifactory Web UI: