Integrate SonarQube into Pipelines

This tutorial demonstrates how you can integrate SonarQube into pipelines. Refer to the following steps first before you create a pipeline using a Jenkinsfile.

You need to .

Install the SonarQube Server

To integrate SonarQube into your pipeline, you must install SonarQube Server first.

1. Install Helm first so that you can install SonarQube using the tool. For example, run the following command to install Helm 3:

   View the Helm version.

   version.BuildInfo{Version:"v3.4.1", GitCommit:"c4e74854886b2efe3321e185578e6db9be0a6e29", GitTreeState:"clean", GoVersion:"go1.14.11"}

   Note

   For more information, see .

2. Execute the following command to install SonarQube Server.

   helm upgrade --install sonarqube sonarqube --repo https://charts.kubesphere.io/main -n kubesphere-devops-system  --create-namespace --set service.type=NodePort

   Note

   Make sure you use Helm 3 to install SonarQube Server.

3. You will get this prompt:

1. Execute the following command to get SonarQube NodePort.

   export NODE_PORT=$(kubectl get --namespace kubesphere-devops-system -o jsonpath="{.spec.ports[0].nodePort}" services sonarqube-sonarqube)
   export NODE_IP=$(kubectl get nodes --namespace kubesphere-devops-system -o jsonpath="{.items[0].status.addresses[0].address}")
   echo http://$NODE_IP:$NODE_PORT

2. You can get the output as below (31434 is the port number in this example, which may be different from yours):

Configure the SonarQube Server

1. Execute the following command to view the status of SonarQube. Note that the SonarQube console is not accessible until SonarQube is up and running.

2. Access the SonarQube console http://<Node IP>:<NodePort> in your browser.

3. Click Log in in the upper-right corner and log in as the default account admin/admin.

   Note

   You may need to set up necessary port forwarding rules and open the port to access SonarQube in your security groups depending on where your instances are deployed.

Step 2: Create a SonarQube admin token

1. Click the letter A and select My Account from the menu to go to the Profile page.

   

2. Click Security and enter a token name, such as kubesphere.

3. Click Generate and copy the token.

   Warning

   Make sure you do copy the token because you won’t be able to see it again as shown in the prompt.

1. Execute the following command to get the address of SonarQube Webhook.

   export NODE_PORT=$(kubectl get --namespace kubesphere-devops-system -o jsonpath="{.spec.ports[0].nodePort}" services devops-jenkins)
   export NODE_IP=$(kubectl get nodes --namespace kubesphere-devops-system -o jsonpath="{.items[0].status.addresses[0].address}")
   echo http://$NODE_IP:$NODE_PORT/sonarqube-webhook/

2. Expected output:

   http://192.168.0.4:30180/sonarqube-webhook/

3. Click Administration, Configuration and Webhooks in turn to create a webhook.

   

4. Click Create.

5. Enter Name and Jenkins Console URL (for example, the SonarQube Webhook address) in the displayed dialog box. Click Create to finish.

   

Step 4: Add the SonarQube configuration to ks-installer

1. Execute the following command to edit .

   kubectl edit cc -n kubesphere-system ks-installer

2. Navigate to devops. Add the field sonarqube and specify externalSonarUrl and externalSonarToken under it.

   devops:
     enabled: true
     jenkinsJavaOpts_MaxRAM: 2g
     jenkinsJavaOpts_Xms: 512m
     jenkinsJavaOpts_Xmx: 512m
     jenkinsMemoryLim: 2Gi
     jenkinsMemoryReq: 1500Mi
     sonarqube: # Add this field manually.
       externalSonarUrl: http://192.168.0.4:31434 # The SonarQube IP address.
   

3. Save the file after you finish.

1. Execute the following command to get the address of Jenkins.

2. You can get the output as below, which tells you the port number of Jenkins.

   http://192.168.0.4:30180

3. Access Jenkins with the address http://<Node IP>:30180. When KubeSphere is installed, the Jenkins dashboard is also installed by default. Besides, Jenkins is configured with KubeSphere LDAP, which means you can log in to Jenkins with KubeSphere accounts (for example, admin/[[email protected]](https://kubesphere.io/cdn-cgi/l/email-protection)) directly. For more information about configuring Jenkins, see .

   Note

   You may need to set up necessary port forwarding rules and open port 30180 to access Jenkins in your security groups depending on where your instances are deployed.

4. Click Manage Jenkins on the left navigation pane.

5. Scroll down to Configure System and click it.

7. Enter Name and Server URL (http://<Node IP>:<NodePort>). Click Add, select Jenkins, and then create the credentials with the SonarQube admin token in the displayed dialog box as shown in the second image below. After adding the credentials, select it from the drop-down list for Server authentication token and then click Apply to finish.

   

   Note

   If the Add button is not working, which is a known bug from Jenkins, you can navigate to Manage Credentials under Manage Jenkins, click Jenkins under Stores scoped to Jenkins, click Global credentials (unrestricted), and then click Add Credentials from the left navigation bar to add the credentials with the SonarQube admin token by referencing the second image above. After you add the credentials, you can select it from the drop-down list for Server authentication token.

Step 6: Add sonarqubeURL to the KubeSphere Console

You need to specify sonarqubeURL so that you can access SonarQube directly from the KubeSphere console.

1. Execute the following command:

   kubectl edit  cm -n kubesphere-system  ks-console-config

2. Go to data.client.enableKubeConfig and add the field devops with sonarqubeURL specified under it.

   client:
     enableKubeConfig: true
     devops: # Add this field manually.
       sonarqubeURL: http://192.168.0.4:31434 # The SonarQube IP address.

3. Save the file.

Execute the following commands.

kubectl -n kubesphere-devops-system rollout restart deploy devops-apiserver

You need a SonarQube token so that your pipeline can communicate with SonarQube as it runs.

1. On the SonarQube console, click Create new project.

2. Enter a project key, such as , and click Set Up.

   

3. Enter a project name, such as java-sample, and click Generate.

4. After the token is created, click Continue.

   

View Results on the KubeSphere Console

After you create a pipeline using the graphical editing panel or , you can view the result of code quality analysis.