lopf/sonar-ldap-groups

Sonar LDAP/AD组同步镜像

镜像概述

本镜像提供LDAP/AD组到Sonarqube的同步功能，解决官方Sonarqube文档中提到的“授权委托需先在SonarQube中定义组”的问题。当Sonarqube集成LDAP/AD认证后，同步组可用于为项目设置权限，适配企业内部代码质量分析场景。

核心功能

1. 同步LDAP/AD组到Sonarqube，自动创建或删除组
2. 支持干运行模式（无实际修改），便于验证同步效果
3. 可通过配置文件自定义同步规则
4. 适配Python 3.7及Sonarqube 7.6+版本

使用场景

• 企业内部Sonarqube集成LDAP/AD认证后，需要同步团队组以管理项目权限
• 定期自动同步组信息，确保Sonarqube权限与LDAP/AD一致
• 快速部署组同步功能，避免手动维护Sonarqube组的繁琐

配置说明

1. 生成Sonar管理员Token：进入Sonarqube后台 → 管理 → 安全 → 用户 → 选择管理员用户 → 生成Token
2. 配置文件设置：

   bash
   cp config.yml.sample config.yml
   # 编辑config.yml，填写Sonarqube地址、Token、LDAP服务器信息等
   

3. 验证同步效果：运行镜像时不添加--no-dry参数，查看拟修改的组数量
4. 执行同步：添加--no-dry参数实际创建/删除组

部署示例

Docker部署

1. 构建镜像：

   bash
   docker build . -t sonar-ldap-groups
   

2. 运行镜像（挂载本地配置文件）：

   bash
   docker run -it -v $(pwd)/config.yml:/etc/config.yml sonar-ldap-groups --config /etc/config.yml
   

   （添加--no-dry参数执行实际同步）

Kubernetes部署

参考镜像目录下kubernetes/文件夹中的Cronjob（定时任务）和ConfigMap（配置存储）示例，配置后部署到Kubernetes集群实现定期同步。

# 示例：Kubernetes Cronjob片段（需结合实际环境调整）
apiVersion: batch/v1beta1
kind: CronJob
metadata:
  name: sonar-ldap-sync
spec:
  schedule: "0 0 * * *" # 每日凌晨执行
  jobTemplate:
    spec:
      template:
        spec:
          containers:
          - name: sonar-ldap-sync
            image: lopf/sonar-ldap-groups
            volumeMounts:
            - name: config-volume
              mountPath: /etc/config.yml
              subPath: config.yml
          volumes:
          - name: config-volume
            configMap:
              name: sonar-ldap-config
          restartPolicy: OnFailure