Index

Документация по установке и использованию SonarQube в Kubernetes.

Описание

SonarQube - платформа для непрерывного анализа качества кода, которая обнаруживает ошибки, уязвимости и запахи кода в коде.

Возможности

✅ Анализ кода на 30+ языках программирования
✅ Обнаружение уязвимостей и запахов кода
✅ Интеграция с CI/CD
✅ Отчеты и метрики качества кода
✅ Поддержка плагинов

Текущая конфигурация

Namespace: tech-sonarqube
Storage: Longhorn (15Gi, StorageClass: longhorn-sonarqube)
Database: PostgreSQL (pg-public cluster)
Placement: Поды могут размещаться на мастерах и воркерах
Resources: 1Gi-2Gi RAM, 400m-1000m CPU
Ingress: Отключен (используется port-forward)

Быстрый старт

1. Подготовка нод

Подготовка нод выполняется автоматически через Ansible playbook:

cd ../.. && make k8s-prepare-nodes

2. Проверка зависимостей

Убедитесь, что PostgreSQL кластер pg-public запущен:

1	`make postgres-status`

Если кластер не создан:

make postgres-install-operator
make postgres-create-cluster

3. Создание секрета с паролем PostgreSQL

Создайте секрет с паролем для пользователя PostgreSQL:

1	`make sonarqube-create-secret`

Вам будет предложено ввести пароль для пользователя sonarqube в PostgreSQL.

Важно: После создания секрета, создайте пользователя и базу данных в PostgreSQL:

-- Подключитесь к PostgreSQL
kubectl -n tech-postgres-databases exec -it \
  $(kubectl -n tech-postgres-databases get pod -l cluster-name=pg-public,spilo-role=master -o jsonpath='{.items[0].metadata.name}') \
  -- psql -U postgres

-- Создайте пользователя и базу данных
CREATE USER sonarqube WITH PASSWORD 'your_password';
CREATE DATABASE sonarqube OWNER sonarqube;
GRANT ALL PRIVILEGES ON DATABASE sonarqube TO sonarqube;

4. Установка SonarQube

1	`make sonarqube-install`

Это создаст: - StorageClass longhorn-sonarqube - SonarQube deployment через Helm chart - Service для доступа к SonarQube

5. Проверка статуса

1	`make sonarqube-status`

6. Доступ к SonarQube

1	`make sonarqube-port-forward`

Откройте в браузере: http://localhost:9000

Учетные данные по умолчанию: - Username: admin - Password: admin (измените при первом входе)

Архитектура

Компоненты

Компонент	Namespace	Расположение	Описание
SonarQube Pod	`tech-sonarqube`	Любые ноды	Основной под SonarQube
PostgreSQL	`tech-postgres-databases`	Worker ноды	База данных (pg-public)
PVC	`tech-sonarqube`	Longhorn	Хранилище данных (15Gi)

Схема подключений

┌─────────────────────────────────────┐
│  tech-sonarqube                     │
├─────────────────────────────────────┤
│  sonarqube (Pod)                    │
│  ├── SonarQube 2025.5               │
│  ├── Volume: 15Gi (Longhorn)        │
│  └── Resources: 1Gi-2Gi RAM        │
│                                      │
│  sonarqube (Service)                │
│  └── ClusterIP: 9000                │
└─────────────────────────────────────┘
              │
              │ JDBC
              ▼
┌─────────────────────────────────────┐
│  tech-postgres-databases            │
│  └── pg-public (PostgreSQL)         │
│      └── Database: sonarqube        │
└─────────────────────────────────────┘

Команды

Управление

make sonarqube-help              # Справка по SonarQube командам
make sonarqube-add-repo          # Добавить Helm репозиторий
make sonarqube-create-secret     # Создать секрет пароля PostgreSQL
make sonarqube-install          # Установить SonarQube
make sonarqube-status            # Статус SonarQube
make sonarqube-port-forward      # Port-forward к localhost:9000
make sonarqube-connect           # Инструкции по подключению
make sonarqube-uninstall         # Удалить SonarQube (сохраняет данные)
make sonarqube-delete            # Удалить SonarQube и данные

Конфигурация

Helm Values

Основные настройки в charts/sonarqube/values.yaml:

Image: sonarqube:2025.5-community
Storage: 15Gi (Longhorn, StorageClass: longhorn-sonarqube)
Resources: 1Gi-2Gi RAM, 400m-1000m CPU
JVM Options: -Xmx1024m -Xms512m
PostgreSQL: Внешний кластер pg-public
Tolerations: Разрешено размещение на control-plane нодах
Node Selector: Пустой (разрешено размещение везде)

PostgreSQL Connection

SonarQube подключается к PostgreSQL через:

Host: pg-public.tech-postgres-databases.svc.cluster.local:5432
Database: sonarqube
Username: sonarqube
Password: Из секрета sonarqube-postgres-secret

Создание секрета пароля PostgreSQL

Вариант A: через Makefile (интерактивно)

1	`make sonarqube-create-secret`

Вариант B: вручную через kubectl

kubectl -n tech-sonarqube create secret generic sonarqube-postgres-secret \
  --from-literal=password=YOUR_PASSWORD

Или через YAML манифест:

apiVersion: v1
kind: Secret
metadata:
  name: sonarqube-postgres-secret
  namespace: tech-sonarqube
type: Opaque
stringData:
  password: YOUR_PASSWORD

Подключение

Service Endpoint

1	`sonarqube.tech-sonarqube.svc.cluster.local:9000`

Port-Forward

1	`make sonarqube-port-forward`

Затем откройте в браузере: http://localhost:9000

Подключение из приложения

apiVersion: v1
kind: Service
metadata:
  name: sonarqube-external
  namespace: tech-sonarqube
spec:
  type: ClusterIP
  ports:
    - port: 9000
      targetPort: 9000
  selector:
    app: sonarqube

Используйте endpoint: sonarqube.tech-sonarqube.svc.cluster.local:9000

Мониторинг

Метрики Prometheus

SonarQube поддерживает сбор метрик для Prometheus через плагин Prometheus Exporter.

Установка плагина Prometheus Exporter

Войдите в SonarQube UI (http://localhost:9000)
Перейдите в Administration → Marketplace
Найдите плагин "Prometheus Exporter" или "SonarQube Prometheus Exporter"
Установите плагин
Перезапустите SonarQube (плагин будет активирован после перезапуска)

Примечание: После установки плагина метрики будут доступны по endpoint /api/prometheus/metrics или /api/monitoring/metrics (зависит от плагина). Проверьте документацию установленного плагина для точного пути.

Настройка ServiceMonitor

ServiceMonitor для SonarQube уже настроен в infra/k8s/monitoring/manifests/monitors/sonarqube-servicemonitor.yaml.

Для активации сбора метрик:

# Применить ServiceMonitor
kubectl apply -f ../../monitoring/manifests/monitors/sonarqube-servicemonitor.yaml

Важно: ServiceMonitor настроен на endpoint /api/prometheus/metrics. Если плагин использует другой путь (например, /api/monitoring/metrics), обновите path в ServiceMonitor:

# Отредактируйте файл
kubectl edit servicemonitor -n tech-monitoring sonarqube
# Или измените файл напрямую:
# infra/k8s/monitoring/manifests/monitors/sonarqube-servicemonitor.yaml

Проверка метрик

Проверьте, что ServiceMonitor создан:

kubectl get servicemonitor -n tech-monitoring sonarqube

Проверьте targets в Prometheus:

# Port-forward к Prometheus
kubectl -n tech-monitoring port-forward svc/kube-prometheus-stack-prometheus 9090:9090
# Откройте http://localhost:9090/targets и найдите sonarqube

Проверьте доступность метрик:

# Port-forward к SonarQube
kubectl -n tech-sonarqube port-forward svc/sonarqube 9000:9000
# Проверьте endpoint метрик (попробуйте оба варианта)
curl http://localhost:9000/api/prometheus/metrics
# или
curl http://localhost:9000/api/monitoring/metrics

Доступные метрики

После установки плагина Prometheus Exporter, SonarQube будет экспортировать метрики о: - Состоянии системы (up/down) - Производительности (время ответа, throughput) - Использовании ресурсов - Статистике анализа кода - Количестве проектов, анализов и т.д.

Troubleshooting

SonarQube pod не запускается

# Проверить логи
kubectl -n tech-sonarqube logs -l app=sonarqube

# Проверить статус пода
kubectl -n tech-sonarqube get pods -o wide

# Проверить события
kubectl -n tech-sonarqube get events --sort-by='.lastTimestamp'

Проблемы с подключением к PostgreSQL

# Проверить секрет
kubectl -n tech-sonarqube get secret sonarqube-postgres-secret

# Проверить подключение к PostgreSQL
kubectl -n tech-postgres-databases exec -it \
  $(kubectl -n tech-postgres-databases get pod -l cluster-name=pg-public,spilo-role=master -o jsonpath='{.items[0].metadata.name}') \
  -- psql -U postgres -c "\l" | grep sonarqube

# Проверить логи SonarQube на ошибки подключения
kubectl -n tech-sonarqube logs -l app=sonarqube | grep -i "jdbc\|postgres\|database"

Проблемы с PVC

# Проверить PVC
kubectl -n tech-sonarqube get pvc

# Проверить StorageClass
kubectl get storageclass longhorn-sonarqube

# Проверить Longhorn volumes
kubectl -n longhorn-system get volumes

SonarQube не отвечает

# Проверить health check
kubectl -n tech-sonarqube exec -it \
  $(kubectl -n tech-sonarqube get pod -l app=sonarqube -o jsonpath='{.items[0].metadata.name}') \
  -- curl http://localhost:9000/api/system/status

# Проверить ресурсы
kubectl -n tech-sonarqube top pod

# Проверить limits
kubectl -n tech-sonarqube describe pod -l app=sonarqube | grep -A 5 "Limits\|Requests"

Проблемы с памятью

Если SonarQube падает из-за нехватки памяти, увеличьте ресурсы в charts/sonarqube/values.yaml:

resources:
  requests:
    memory: "2Gi"
    cpu: "1000m"
  limits:
    memory: "4Gi"
    cpu: "2000m"

jvmOpts: "-Xmx2048m -Xms1024m"

Ссылки

← Назад к главной документации

На странице

Оглавление Описание Возможности Текущая конфигурация Быстрый старт 1. Подготовка нод 2. Проверка зависимостей 3. Создание секрета с паролем PostgreSQL 4. Установка SonarQube 5. Проверка статуса 6. Доступ к SonarQube Архитектура Компоненты Схема подключений Команды Управление Конфигурация Helm Values PostgreSQL Connection Создание секрета пароля PostgreSQL Подключение Service Endpoint Port-Forward Подключение из приложения Мониторинг Метрики Prometheus Troubleshooting SonarQube pod не запускается Проблемы с подключением к PostgreSQL Проблемы с PVC SonarQube не отвечает Проблемы с памятью Ссылки