epamedp/sonar-operator

Sonar Operator

本文介绍Sonar Operator的概述、安装流程、本地开发及架构方案。

概述

Sonar Operator是KubeRocketCI的operator，负责配置SonarQube。

注意： Operator是平台无关的，因此部署说明是统一的。

前提条件

1. Linux机器或Windows Subsystem for Linux实例，已安装Helm 3；
2. 集群管理员权限。

安装

如需安装KubeRocketCI Sonar Operator，请按以下步骤操作：

1. 执行以下命令将EPAMEDP Helm Charts添加到本地客户端：

   bash
   helm repo add epamedp https://epam.github.io/edp-helm-charts/stable
   

2. 选择可用的Helm chart版本：

   bash
   helm search repo epamedp/sonar-operator -l
   NAME                    CHART VERSION   APP VERSION     DESCRIPTION
   epamedp/sonar-operator  3.1.1           3.1.1           A Helm chart for KRCI Sonar Operator
   

   注意： 强烈建议使用最新发布的版本。

3. 部署operator：

   完整的可用chart参数请参见deploy-templates/README.md。

4. 使用helm命令在任意命名空间（如sonar-operator）中安装operator，安装命令示例如下：

   bash
   helm install sonar-operator epamedp/sonar-operator --version <chart_version> --namespace sonar
   

5. 检查sonar命名空间，其中应包含operator部署，且operator处于运行状态。

快速开始

1. 登录SonarQube并创建用户，为用户分配质量门禁、配置文件、用户管理等权限。将用户凭据存入Kubernetes secret：

   yaml
   apiVersion: v1
   kind: Secret
   metadata:
     name:  sonar-access
   type: Opaque
   data:
     username: dXNlcg==  # "user"的base64编码值
     password: cGFzcw==  # "pass"的base64编码值
   

2. 创建kind: Sonar自定义资源，包含Sonar实例URL和上一步创建的secret：

   yaml
   apiVersion: edp.epam.com/v1alpha1
   kind: Sonar
   metadata:
     name: sonar-sample
   spec:
     url: https://sonar.example.com   # Sonar URL
     secret: sonar-access             # Secret名称
   

   等待.status字段出现status.connected: true。

3. 使用SonarQualityGate自定义资源创建质量门禁：

   yaml
   apiVersion: edp.epam.com/v1alpha1
   kind: SonarQualityGate
   metadata:
     name: qualityGate-sample
   spec:
     sonarRef:
       name: sonar-sample # `kind: Sonar`的名称
     name: qualityGate-sample
     default: true
     conditions:
       new_coverage:
         op: LT
         error: "80"
   

   创建质量配置文件：

   yaml
   apiVersion: edp.epam.com/v1alpha1
   kind: SonarQualityProfile
   metadata:
     name: qualityProfile-sample
   spec:
     sonarRef:
       name: sonar-sample # `kind: Sonar`的名称
     name: qualityProfile-sample
     language: java
     default: true
     rules:
       checkstyle:com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck:
         severity: 'MAJOR'
   

   更多示例请参见CR模板文件夹。

本地开发

如需开发operator，需先搭建本地环境。详情请参考本地开发页面。

开发版本也可用，详情请参考https://epam.github.io/edp-helm-charts/snapshot/%E9%A1%B5%E9%9D%A2%E3%80%82

相关文章

• 安装KubeRocketCI