{"id":641,"date":"2013-09-08T16:19:35","date_gmt":"2013-09-08T15:19:35","guid":{"rendered":"http:\/\/qualilogy.com\/en\/?p=641"},"modified":"2013-09-08T18:05:56","modified_gmt":"2013-09-08T17:05:56","slug":"migrate-sonarqube-tomcat-to-windows-service","status":"publish","type":"post","link":"http:\/\/qualilogy.com\/en\/migrate-sonarqube-tomcat-to-windows-service\/","title":{"rendered":"Migrate SonarQube from Tomcat to a Windows service"},"content":{"rendered":"

\"SonarQubeService\"<\/a><\/p>\n

As I have already mentioned, SonarQube will soon be no\u00a0longer available for Tomcat, but only as a Windows service. That means that I will have to migrate my platform SonarQube \/ Jenkins.<\/p>\n

This brings some questions: will I loose my settings? Will I loose my analysis? SonarQube uses a database to store the results of the analysis, so we can expect to keep them and their history.<\/p>\n

But what about my SonarQube configuration? Will I have to reinstall plugins? Damn, where did I put the license keys for these plugins? And my Quality Profiles? Are they stored in the database or in a file?<\/p>\n

<\/p>\n

In what order should I proceed: first migrate Jenkins then check if Jenkins is still able to recognize my SonarQube installation and continue to work on existing projects? In fact, I will start by migrating SonarQube, because it is far simpler than Jenkins.<\/p>\n

We then have the opportunity to continue with this last one and install it as a service, so we will finally be able to get rid of Tomcat.<\/p>\n

Migrate SonarQube to a Windows service<\/h2>\n

Objectives<\/h3>\n

Note that I will migrate my current version 3.5.1\u00a0of SonarQube. There is a newer version 3.7 … at the time I am writing this post. It changes very quickly, the SonarSource team is highly productive. This latest 3.7 version has many new features, and it will be the subject of future posts.<\/p>\n

This is also an opportunity to check how to perform an upgrade of version of SonarQube as a service. If this topic interests you, we have seen how to perform such an upgrade there:\u00a0Upgrade Sonar<\/a>.<\/p>\n

I will also dedicate this post to a migration of the SonarQube as a Windows service, and ensure that I can continue to work with my existing repository: my dashboard, my analysis, my configurations, etc.. We will see in the next post the changes to make in my current Jenkins (under Tomcat) to work with my new SonarQube installation.<\/p>\n

Documentation<\/h3>\n

Like any (good) IT specialist, I never read documentations, and especially not those about installation. I find it quite unnatural if a software does not know how to install itself (you know: ‘Next’, ‘Next’, ‘Next’, etc.) and requires to first read an installation guide. But well, here is the link to the SonarSource website:\u00a0http:\/\/docs.codehaus.org\/display\/SONAR\/Running+SonarQube+as+a+Service+on+Windows<\/a>.<\/p>\n

Well, it looks super simple:<\/p>\n

\"Sonar_InstallWinService\"<\/a><\/p>\n

Installation<\/h3>\n

I will first stop Tomcat, to be sure that I will not be working with my current SonarQube installation.<\/p>\n

\"Stop_Tomcat\"<\/a><\/p>\n

Then I open a DOS windows and go to the directory of installation of SonarQube.<\/p>\n

\"Sonar_Bin\"<\/a><\/p>\n

My current SonarQube version is 3.5.1. In the foleer ‘\\sonar-3.5.1\\bin’, I can find two sub-directories \u2018windows-x86-32\u2019 and \u2018windows-x86-64\u2019, this last one for an installation with a Windows 64 bits.<\/p>\n

\"Sonar_InstallWinService2\"<\/a><\/p>\n

I won’t go into details of what this batch program. does. We’ll just follow the recommendation of the documentation and run this program as an Administrator.<\/p>\n

It’s very fast. I note the appearance of the Sonar service in the Services window.<\/p>\n

\"Sonar_Service\"<\/a><\/p>\n

I can launch this service, either with a\u00a0‘Start’ from this service, either executing the corresponding file in the ‘bin’ directory of SonarQube, from my DOS window.<\/p>\n

\"sonar_Runservice1\"<\/a><\/p>\n

But this will bring the following error message:<\/p>\n

\"Sonar_ServiceLaunchError\"<\/a><\/p>\n

Same if I try to start the SonarQube service:<\/p>\n

\"Sonar_ServiceLaunchError2\"<\/a><\/p>\n

\"Sonar_ServiceProp1\"<\/a><\/p>\n

Now, if we open the service Properties (right click on the service to get the menus)\u2026<\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

\u2026and goes on the tab ‘Log On’.<\/p>\n

\"Sonar_ServiceProp2\"<\/a><\/p>\n

Check the box \u2018This account\u2019 and then the button \u2018Browse\u2019 :<\/p>\n

\"Sonar_ServiceProp3\"<\/a><\/p>\n

In the following windows, click the button ‘Advanced’.<\/p>\n

\"Sonar_ServiceProp4a\"<\/a><\/p>\n

Then ‘Find Now’ in order to list the users who can connect (Log On) to launch this service.<\/p>\n

\"Sonar_ServiceProp4\"<\/a><\/p>\n

I will select the Windows user I use to log on my laptop:<\/p>\n

\"Sonar_ServiceProp5\"<\/a><\/p>\n

‘OK’ to validate. Notice that my Window user is prefixed with the ID of my machine (JPFPC).<\/p>\n

\"Sonar_ServiceProp6\"<\/a><\/p>\n

‘OK’ again to get back to the ‘Log On’ tab, where I can enter the password corresponding to my user. ‘Apply’ then ‘OK’ to close the Properties window.<\/p>\n

Now we can start again the service and …\u00a0Yes, it works ! The error message has disappeared and the service displays a ‘Started’ status.<\/p>\n

Validation<\/h3>\n

\"SonarQubeURL\"<\/a><\/p>\n

Your SonarQube dashboard- as a Windows service – is available at the url localhost:9000<\/strong>. Enter it in your favorite browser, and you will see your SonarQube portal as it was the last one you’ve been consulting it.<\/p>\n

You can check that your previous analysis appear correctly, your custom Quality Profiles are present, your plugins are also there, and active (no need to re-enter the licenses). Your entire SonarQube configuration\u00a0under Tomcat and your projects, well your whole repository, is fully available and ready for use.<\/p>\n

We still have to perform an analysis from our current Jenkins under Tomcat.<\/p>\n

This we will see in the next post. In the meantime, have a good week.<\/p>\n","protected":false},"excerpt":{"rendered":"

As I have already mentioned, SonarQube will soon be no\u00a0longer available for Tomcat, but only as a Windows service. That means that I will have to migrate my platform SonarQube \/ Jenkins. This brings some questions: will I loose my settings? Will I loose my analysis? SonarQube uses a database to store the results of […]<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[7],"tags":[],"class_list":["post-641","post","type-post","status-publish","format-standard","hentry","category-sonar-installation"],"_links":{"self":[{"href":"http:\/\/qualilogy.com\/en\/wp-json\/wp\/v2\/posts\/641"}],"collection":[{"href":"http:\/\/qualilogy.com\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/qualilogy.com\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/qualilogy.com\/en\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"http:\/\/qualilogy.com\/en\/wp-json\/wp\/v2\/comments?post=641"}],"version-history":[{"count":16,"href":"http:\/\/qualilogy.com\/en\/wp-json\/wp\/v2\/posts\/641\/revisions"}],"predecessor-version":[{"id":643,"href":"http:\/\/qualilogy.com\/en\/wp-json\/wp\/v2\/posts\/641\/revisions\/643"}],"wp:attachment":[{"href":"http:\/\/qualilogy.com\/en\/wp-json\/wp\/v2\/media?parent=641"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/qualilogy.com\/en\/wp-json\/wp\/v2\/categories?post=641"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/qualilogy.com\/en\/wp-json\/wp\/v2\/tags?post=641"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}