Поддержание высокого качества кода имеет важное значение для любого проекта разработки программного обеспечения. SonarQube, мощная платформа с открытым исходным кодом, помогает разработчикам проверять и анализировать свою кодовую базу для выявления и устранения проблем, обеспечивая чистый, удобный в обслуживании и безопасный код. В этом подробном руководстве мы покажем вам пошаговый процесс установки SonarQube в Ubuntu 24.04 LTS, стабильной и надежной операционной системе для размещения вашего инструмента управления качеством кода.
Предварительные условия
Системные требования
Перед установкой SonarQube убедитесь, что ваша система соответствует следующим минимальным требованиям:
- Аппаратное обеспечение: не менее 2 ГБ ОЗУ, 1 ядро ЦП и 30 ГБ свободного места на диске.
- Программное обеспечение: Java (OpenJDK 17) и база данных PostgreSQL.
Разрешения пользователя
Чтобы установить и настроить SonarQube, вам понадобится учетная запись пользователя с привилегиями sudo. Это позволяет при необходимости выполнять команды с повышенными разрешениями.
Конфигурация сети
Убедитесь, что ваша система Ubuntu имеет стабильное подключение к Интернету для загрузки необходимых пакетов и зависимостей во время процесса установки.
Шаг 1. Обновите систему
Прежде чем приступить к установке, крайне важно обновить вашу систему Ubuntu, чтобы убедиться, что у вас установлены последние исправления безопасности и обновления программного обеспечения. Откройте терминал и выполните следующие команды:
sudo apt update
sudo apt upgrade -y
Шаг 2. Установите Java
Для работы SonarQube требуется Java, поэтому давайте установим OpenJDK 17. Выполните в терминале следующую команду:
sudo apt install openjdk-17-jdk -y
После завершения установки проверьте версию Java, выполнив:
java -version
Вы должны увидеть установленную версию Java, отображаемую в выводе терминала.
Шаг 3. Установите PostgreSQL
SonarQube использует базу данных для хранения данных конфигурации и анализа. Мы будем использовать PostgreSQL в качестве базы данных для нашей установки SonarQube. Выполните следующие шаги, чтобы установить и настроить PostgreSQL:
1. Добавьте репозиторий PostgreSQL в свою систему:
sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
wget -qO- https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo tee /etc/apt/trusted.gpg.d/pgdg.asc &>/dev/null
2. Обновите список пакетов и установите PostgreSQL:
sudo apt update
sudo apt-get install postgresql postgresql-contrib -y
3. Настройте PostgreSQL для SonarQube:
sudo passwd postgres
su - postgres
createuser sonar
psql
ALTER USER sonar WITH ENCRYPTED PASSWORD 'sonar';
CREATE DATABASE sonarqube OWNER sonar;
GRANT ALL PRIVILEGES ON DATABASE sonarqube TO sonar;
\q
exit
Шаг 4. Загрузите и установите SonarQube
Теперь, когда у нас есть все необходимые условия, давайте загрузим и установим SonarQube:
1. Загрузите последнюю версию SonarQube:
wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-10.6.0.92116.zip
2. Распакуйте загруженный ZIP-файл и переместите извлеченный каталог в /opt/sonarqube
:
unzip sonarqube-10.6.0.92116.zip
sudo mv sonarqube-10.6.0.92116 /opt/sonarqube
3. Создайте выделенного пользователя для запуска SonarQube:
sudo adduser --system --no-create-home --group --disabled-login sonarqube
sudo chown -R sonarqube:sonarqube /opt/sonarqube
Шаг 5. Настройте SonarQube
Перед запуском SonarQube нам необходимо настроить его для использования базы данных PostgreSQL, которую мы настроили ранее:
1. Откройте файл конфигурации SonarQube:
sudo nano /opt/sonarqube/conf/sonar.properties
2. Найдите следующие строки и раскомментируйте их, удалив #
символ:
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
sonar.jdbc.url=jdbc:postgresql://localhost/sonarqube
3. Сохраните изменения и выйдите из редактора.
Шаг 6. Создайте служебный файл Systemd
Для управления SonarQube как системной службой мы создадим systemd
служебный файл:
1. Создайте новый служебный файл:
sudo nano /etc/systemd/system/sonarqube.service
2. Добавьте в файл следующее содержимое:
[Unit]
Description=SonarQube service
After=syslog.target network.target
[Service]
Type=forking
ExecStart=/opt/sonarqube/bin/linux-x86-64/sonar.sh start
ExecStop=/opt/sonarqube/bin/linux-x86-64/sonar.sh stop
User=sonarqube
Group=sonarqube
Restart=always
[Install]
WantedBy=multi-user.target
3. Сохраните изменения и выйдите из редактора.
Шаг 7: Запуск SonarQube
Имея конфигурационный и служебный файл, мы можем запустить SonarQube:
1. Перезагрузите systemd
конфигурация:
sudo systemctl daemon-reload
2. Запустите сервис SonarQube:
sudo systemctl start sonarqube
3. Включите автоматический запуск службы при загрузке системы:
sudo systemctl enable sonarqube
Доступ к SonarQube
SonarQube теперь установлен и работает в вашей системе Ubuntu 24.04 LTS. Чтобы получить доступ к веб-интерфейсу SonarQube:
1. Откройте веб-браузер и перейдите к http://localhost:9000
.
2. Войдите в систему, используя учетные данные по умолчанию:
- Имя пользователя: admin
- Пароль: admin
После первого входа в систему вам будет предложено изменить пароль по умолчанию.
Поиск неисправностей
Если у вас возникнут какие-либо проблемы во время установки или во время работы SonarQube, вот несколько советов по устранению неполадок:
- Проверьте журналы SonarQube, расположенные по адресу
/opt/sonarqube/logs/sonar.log
для любых сообщений об ошибках или предупреждений. - Убедитесь, что база данных PostgreSQL запущена и доступна с использованием настроенных учетных данных.
- Убедитесь, что служба SonarQube запущена, выполнив
sudo systemctl status sonarqube
. - Убедитесь, что необходимые порты (9000 для веб-интерфейса SonarQube) не используются другими приложениями.