bitnamicharts/sonarqube

Bitnami SonarQube™ 镜像文档

镜像概述和主要用途

SonarQube™ 是一款开源代码质量管理平台，用于分析和度量代码的技术质量。它能帮助开发人员在早期阶段检测代码问题、安全漏洞和缺陷。Bitnami 提供的 SonarQube™ 镜像经过优化，具备易于部署、安全可靠的特点，适用于开发、测试及生产环境。

商标声明：本软件包由 Bitnami 打包。所提及的商标分属各自公司所有，使用这些商标并不意味着任何关联或背书。SonarQube 是 SonarSource SA 的注册商标。

核心功能和特性

• 代码质量分析：支持多种编程语言，检测代码异味、漏洞、重复代码及合规性问题。
• 灵活部署：支持 Docker 容器化部署，兼容 Kubernetes 环境，提供 Helm Chart 简化集群部署。
• 外部数据库集成：可连接外部 PostgreSQL 数据库，避免集群内数据库依赖，适合生产环境。
• 监控与可观测性：集成 Prometheus 监控，通过 JMX Exporter 暴露 metrics，支持 ServiceMonitor 配置。
• 安全加固：遵循容器安全最佳实践，默认使用非 root 用户运行，支持内核参数调整（如 vm.max_map_count、fs.file-max）。
• 持久化存储：通过 Persistent Volume Claims (PVC) 实现数据持久化，支持存储权限自动调整。
• Ingress 支持：可配置 Ingress 资源实现外部访问，支持 TLS 加密和证书管理（如 cert-manager 集成）。
• 环境变量扩展：支持通过 ConfigMap/Secret 注入额外环境变量，满足自定义配置需求。

使用场景和适用范围

• 开发环境：本地或 CI/CD 流水线中集成，实时检测代码提交质量。
• 测试环境：验证代码修复效果，评估版本发布前的整体代码质量。
• 生产环境：持续监控线上代码库质量，预防技术债务累积。
• 企业级应用：与 Jenkins、GitLab CI、GitHub Actions 等工具集成，构建自动化质量管控流程。

详细的使用方法和配置说明

前提条件

• Docker 19.03+ 或 Kubernetes 1.23+（如使用 Helm 部署）。
• Helm 3.8.0+（如使用 Helm Chart）。
• 外部数据库（推荐 PostgreSQL 12+，如不使用内置数据库）。

Docker 快速部署

1. 使用 docker run 部署

bash
# 启动 SonarQube（需提前准备外部 PostgreSQL 数据库）
docker run -d \
  --name sonarqube \
  -p 9000:9000 \
  -e SONARQUBE_JDBC_URL=jdbc:postgresql://<POSTGRES_HOST>:5432/sonar \
  -e SONARQUBE_JDBC_USERNAME=<POSTGRES_USER> \
  -e SONARQUBE_JDBC_PASSWORD=<POSTGRES_PASSWORD> \
  -e SONARQUBE_USERNAME=admin \
  -e SONARQUBE_PASSWORD=<ADMIN_PASSWORD> \  # 至少 12 字符
  bitnami/sonarqube:latest

2. 使用 Docker Compose 部署（含 PostgreSQL）

yaml
version: '3.8'

services:
  postgresql:
    image: bitnami/postgresql:14
    environment:
      - POSTGRESQL_USER=sonar
      - POSTGRESQL_PASSWORD=sonar_password  # 自定义密码
      - POSTGRESQL_DATABASE=sonar
    volumes:
      - postgresql_data:/bitnami/postgresql
    networks:
      - sonarqube-network

  sonarqube:
    image: bitnami/sonarqube:latest
    ports:
      - "9000:9000"
    environment:
      - SONARQUBE_JDBC_URL=jdbc:postgresql://postgresql:5432/sonar
      - SONARQUBE_JDBC_USERNAME=sonar
      - SONARQUBE_JDBC_PASSWORD=sonar_password
      - SONARQUBE_USERNAME=admin
      - SONARQUBE_PASSWORD=admin_password  # 至少 12 字符，生产环境建议复杂密码
    depends_on:
      - postgresql
    volumes:
      - sonarqube_data:/bitnami/sonarqube
    networks:
      - sonarqube-network

networks:
  sonarqube-network:
    driver: bridge

volumes:
  postgresql_data:
  sonarqube_data:

启动命令：

bash
docker-compose up -d

Helm Chart 部署（Kubernetes）

1. 添加 Bitnami Helm 仓库

bash
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo update

2. 安装 Helm Chart

bash
# 基础安装（使用内置 PostgreSQL）
helm install my-sonarqube oci://registry-1.docker.io/bitnamicharts/sonarqube

# 指定外部数据库（生产环境推荐）
helm install my-sonarqube oci://registry-1.docker.io/bitnamicharts/sonarqube \
  --set postgresql.enabled=false \
  --set externalDatabase.host=<POSTGRES_HOST> \
  --set externalDatabase.user=<POSTGRES_USER> \
  --set externalDatabase.password=<POSTGRES_PASSWORD> \
  --set externalDatabase.database=sonar \
  --set externalDatabase.port=5432

3. 验证部署

bash
# 检查 Pod 状态
kubectl get pods -l app.kubernetes.io/name=sonarqube

# 获取访问地址（NodePort 或 LoadBalancer 模式）
kubectl get svc my-sonarqube-sonarqube

关键配置说明

1. 数据库配置

2. 访问控制配置

3. 内核参数调整

SonarQube 运行依赖以下内核参数，如未提前配置，可通过 initContainer 自动调整（Helm Chart 默认启用）：

yaml
# Helm Chart 参数
sysctl:
  enabled: true  # 启用 initContainer 调整内核参数
  commands:
    - sysctl -w vm.max_map_count=262144
    - sysctl -w fs.file-max=65536

如需手动调整（非容器环境）：

bash
sudo sysctl -w vm.max_map_count=262144
sudo sysctl -w fs.file-max=65536

4. 持久化存储配置

5. 监控配置

启用 Prometheus 监控（Helm Chart）：

yaml
metrics:
  enabled: true  # 启用 JMX Exporter 侧car容器
  jmx:
    enabled: true
    port: 10443  # metrics 暴露端口
  serviceMonitor:
    enabled: true  # 生成 ServiceMonitor 资源（需 Prometheus Operator）

重要注意事项

镜像变更通知（2025年8月28日起）

Bitnami 将调整公共镜像目录，推出 Bitnami Secure Images 计划，主要变更包括：

• 非加固的 Debian 基础镜像将逐步废弃，仅保留安全加固的 "latest" 标签镜像（供开发使用）。
• 现有镜像（含历史版本标签，如 10.6、9.9.0）将迁移至 docker.io/bitnamilegacy 仓库，不再更新。
• 生产环境建议使用 Bitnami Secure Images，提供安全加固、SBOM、CVE 透明度及企业支持。

详情参见 https://github.com/bitnami/containers/issues/83267%E3%80%82

安全最佳实践

• 避免使用默认密码：部署时务必自定义 sonarqubePassword，长度至少 12 字符。
• 使用外部数据库：生产环境禁用内置 PostgreSQL，采用托管数据库服务（如 AWS RDS、Azure Database）。
• 启用 TLS 加密：通过 Ingress 配置 TLS，或使用 sonar.forceAuthentication=true 强制 HTTPS。
• 限制容器权限：禁用 privileged 模式（Helm Chart 中 sysctl.enabled=true 时需特权 initContainer，建议生产环境提前配置内核参数并禁用该 initContainer）。

完整参数列表（Helm Chart）

全局参数

SonarQube 配置参数

完整参数列表参见 https://github.com/bitnami/charts/blob/main/bitnami/sonarqube/README.md%E3%80%82