SonarQube Update Version 4.4.1 vers 4.5

De EjnTricks

Cette mise à jour s'effectue sur l'installation décrite pour la version 4.4.


Hand-icon.png Votre avis

Nobody voted on this yet

 You need to enable JavaScript to vote


System-Install-icon.png Download-icon.png Téléchargement et installation

#sudo wget -P /tmp http://downloads.sonarsource.com/sonarqube/sonarqube-4.5.zip
#sudo unzip /tmp/sonarqube-4.5.zip -d /var/opt/sonarqube


Icon-Configuration-Settings.png Déploiement

Il faut dans un premier temps organiser les binaires sous /var/opt/sonarqube/4.5.

#sudo mv /var/opt/sonarqube/sonarqube-4.5 /var/opt/sonarqube/4.5
#sudo chown -R sonar:sonar /var/opt/sonarqube/4.5
#sudo chmod -R go-rwx /var/opt/sonarqube/4.5

Les droits sont positionnés pour que seul le compte sonar puisse accéder aux fichiers.


Run-icon.png Script démarrage

Les modifications dans le script de démarrage, fichier /var/opt/sonarqube/4.5/bin/linux-x86-64/sonar.sh, doivent permettre :

  • Spécifier l'utilisateur d'exécution;
  • Spécifier un emplacement spécifique pour le fichier "PID".

A noter que lors de l'exécution, si un compte est spécifié et différent de celui en cours d'exécution, le script de démarrage est redémarré avec le compte souhaité.

# If specified, the Wrapper will be run as the specified user.
# IMPORTANT - Make sure that the user has the required privileges to write
#  the PID file and wrapper.log files.  Failure to be able to write the log
#  file will cause the Wrapper to exit without any way to write out an error
#  message.
# NOTE - This will set the user which is used to run the Wrapper as well as
#  the JVM and is not useful in situations where a privileged resource or
#  port needs to be allocated prior to the user being changed.
#RUN_AS_USER=
RUN_AS_USER=sonar

Et

# Location of the pid file.
#PIDDIR="."
PIDDIR="/run/sonarqube"

Cependant, le répertoire /run/sonarqube n'existe pas et le compte sonar n'a pas les droits d'écriture dans /run. Une erreur se produira donc lors de l'exécution, car le fichier "PID" ne pourra être créé. Le script de démarrage /var/opt/sonarqube/4.5/bin/linux-x86-64/sonar.sh est donc modifié afin de forcer la création du répertoire. Pour rappel, comme il est exécuté avec le compte root du fait du service, il est tout à fait possible de créer le répertoire et de modifier les droits d'accès.

Au final, le script est modifié ainsi :

# Location of the pid file.
#PIDDIR="."
PIDDIR="/run/sonarqube"

# If uncommented, causes the Wrapper to be shutdown using an anchor file.
#  When launched with the 'start' command, it will also ignore all INT and
#  TERM signals.
#IGNORE_SIGNALS=true

# If specified, the Wrapper will be run as the specified user.
# IMPORTANT - Make sure that the user has the required privileges to write
#  the PID file and wrapper.log files.  Failure to be able to write the log
#  file will cause the Wrapper to exit without any way to write out an error
#  message.
# NOTE - This will set the user which is used to run the Wrapper as well as
#  the JVM and is not useful in situations where a privileged resource or
#  port needs to be allocated prior to the user being changed.
#RUN_AS_USER=
RUN_AS_USER=sonar
if [ ! -d "$PIDDIR" ]; then
        mkdir -p "$PIDDIR"
        [ -z "$RUN_AS_USER" ] || chown "$RUN_AS_USER:$RUN_AS_USER" "$PIDDIR"
fi


Icon-log.png Fichiers log

Par défaut, les logs sont placés dans le répertoire logs de l’instance SonarQube :

  • /var/opt/sonarqube/4.5/logs/sonar.log
  • /var/opt/sonarqube/4.5/logs/access.log

La définition de ces emplacements se situe dans différentes configurations.

  • Fichier conf/wrapper.conf les écritures du wrapper dans les fichiers sonar.log
#********************************************************************
# Wrapper Logs
#********************************************************************

wrapper.console.format=PM
wrapper.console.loglevel=INFO
wrapper.logfile=../../logs/sonar.log
wrapper.logfile.format=M
wrapper.logfile.loglevel=INFO
  • Fichier conf/sonar.properties pour sonar.log et access.log
#--------------------------------------------------------------------------------------------------
# LOGGING

# Level of information displayed in the logs: NONE (default), BASIC (functional information)
# and FULL (functional and technical details)
#sonar.log.profilingLevel=NONE

# Path to log files. Can be absolute or relative to installation directory.
# Default is <installation home>/logs
#sonar.path.logs=logs


Afin de centraliser les logs, les messages sont redirigés vers /var/log/sonarqube en mettant en place des liens symboliques. Ceci permet de ne pas modifier les fichiers de configurations, limitant les modifications lors des futures montées de version. Le répertoire /var/opt/sonarqube/4.5/logs existe déjà et sera supprimé. Du fait de cette organisation, utilisation d'un répertoire common, un répertoire /var/opt/sonarqube/common/logs sera créé lors du démarrage. Pour ce dernier, le lien est préalablement créé.

#sudo rmdir /var/opt/sonarqube/4.5/logs
#sudo ln -s /var/log/sonarqube /var/opt/sonarqube/4.5/logs
#sudo chown -h sonar:sonar /var/opt/sonarqube/4.5/logs


Icon-Configuration-Settings.png Paramétrages

Les fichiers de paramétrages seront déplacés dans le répertoire /var/opt/sonarqube/common/conf afin de faciliter les montées de version. Ils ont très certainement écrit sur un environnement Windows, et dans le cadre d'une installation sous Linux, il est préférable de "formater" les fichiers avec l'utilitaire fromdos. Les fichiers vont être modifiés et placés dans le répertoire common, il est donc nécessaire d'arrêter le service avant les modifications.

#sudo service sonarqube stop
#sudo fromdos -p /var/opt/sonarqube/4.5/conf/*

Le fichier sonar.properties est légèrement différent de celui pour la version 4.4 et il est modifié avant d'être placé dans le répertoire /var/opt/sonarqube/common/conf.

Icon-database.png Base de données

La configuration MySql a été réalisée depuis les premières versions. Elle pourrait être reprise, mais le format du fichier sonar.properties a été légèrement modifié. De plus, des éléments de paramétrages ont été supprimés.

Un exemple est fourni dans le fichier et il suffit de commenter le paramètre actif, sur une base H2, et d'activer celui pour MySql. Il faut également configurer le compte d'accès à la base en reseignant les paramètres sonar.jdbc.username et sonar.jdbc.password

# User credentials.
# Permissions to create tables, indices and triggers must be granted to JDBC user.
# The schema must be created first.
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar

#----- Embedded Database (default)
# It does not accept connections from remote hosts, so the
# server and the analyzers must be executed on the same host.
#sonar.jdbc.url=jdbc:h2:tcp://localhost:9092/sonar

# H2 embedded database server listening port, defaults to 9092
#sonar.embeddedDatabase.port=9092


#----- MySQL 5.x
#sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance

User-group-icon.png Annuaire LDAP

La configuration LDAP a été mise en place depuis la version 1.1 du plugin, sans être modifiée. Lors de cette mise à jour, celle-ci est reprise pour être épurée. Les lignes suivantes sont ajoutées au fichier de configuration /var/opt/sonarqube/common/conf/sonar.properties.

#--------------------------------------------------------------------------------------------------
# LDAP Configuration
# General Configuration
sonar.security.realm=LDAP
ldap.url=ldap://localhost:389

# User Configuration
ldap.user.baseDn=ou=people,dc=ejnserver,dc=fr
ldap.user.request=(uid={login})
ldap.user.realNameAttribute=cn
ldap.user.emailAttribute=mail

# Group Configuration
ldap.group.baseDn=ou=groups,dc=ejnserver,dc=fr
ldap.group.request=(&(objectClass=groupOfNames)(member={dn}))

Configuration App Web-Icon.png Contexte

Il faut donc spécifier à l'instance qu'il y a un contexte de déploiement, soit sonar, à mettre en place en modifiant le paramètre sonar.web.context.

#--------------------------------------------------------------------------------------------------
# WEB SERVER

# Web server is executed in a dedicated Java process. By default its heap size is 768Mb.
# Use the following property to customize JVM options. Enabling the HotSpot Server VM
# mode (-server) is recommended.
# Note that the option -Dfile.encoding=UTF-8 is mandatory.
#sonar.web.javaOpts=-Xmx768m -XX:MaxPermSize=160m -XX:+HeapDumpOnOutOfMemoryError \
#  -Djava.awt.headless=true -Dfile.encoding=UTF-8 -Djruby.management.enabled=false

# Binding IP address. For servers with more than one IP address, this property specifies which
# address will be used for listening on the specified ports.
# By default, ports will be used on all IP addresses associated with the server.
#sonar.web.host=0.0.0.0

# Web context. When set, it must start with forward slash (for example /sonarqube).
# The default value is root context (empty value).
#sonar.web.context=
sonar.web.context=/sonar


Share-icon.png Fichiers communs

Folder-icon.png Références répertoires communs

Les liens vers les fichiers communs sont mis en place.

#sudo rm -rf /var/opt/sonarqube/4.5/conf
#sudo ln -s /var/opt/sonarqube/common/conf /var/opt/sonarqube/4.5/conf
#sudo chown -h sonar:sonar /var/opt/sonarqube/4.5/conf
#sudo rm -rf /var/opt/sonarqube/4.5/data
#sudo ln -s /var/opt/sonarqube/common/data /var/opt/sonarqube/4.5/data
#sudo chown -h sonar:sonar /var/opt/sonarqube/4.5/data
#sudo rm -rf /var/opt/sonarqube/4.5/extensions/plugins
#sudo ln -s /var/opt/sonarqube/common/extensions/plugins /var/opt/sonarqube/4.5/extensions/plugins
#sudo chown -h sonar:sonar /var/opt/sonarqube/4.5/extensions/plugins
#sudo rm -rf /var/opt/sonarqube/4.5/temp
#sudo ln -s /var/opt/sonarqube/common/temp /var/opt/sonarqube/4.5/temp
#sudo chown -h sonar:sonar /var/opt/sonarqube/4.5/temp

Delete-file-icon.png Liens obsolètes

Lors du démarrage de la version 4.4, la variable SONAR_HOME était spécifiée en fonction de l'emplacement du fichier sonar.properties, ce qui avait obligé de mettre en place les liens dans le répertoire common. Pour cette version, le mode d'initialisation est modifié et prend en compte l'emplacement du script de démarrage sonar.sh. Les liens deviennent donc obsolètes et sont supprimés.

#sudo rm /var/opt/sonarqube/common/lib
#sudo rm /var/opt/sonarqube/common/web
#sudo rm /var/opt/sonarqube/common/extensions/jdbc-driver


Run-icon.png Exécution

Lors de l'installation de SonarQube en service, un lien /var/opt/sonarqube/installed a été mis en place pour pointer sur la version à activer. Des liens ont également été mis en place depuis /var/opt/sonarqube/common vers /var/opt/sonarqube/installed. Ainsi, en modifiant le lien installed, ceux-ci seront automatiquement activés sans aucune modification nécessaire.

#sudo service sonarqube stop
#sudo rm /var/opt/sonarqube/installed
#sudo ln -s /var/opt/sonarqube/4.5 /var/opt/sonarqube/installed
#sudo chown -h sonar:sonar /var/opt/sonarqube/installed

Il suffit de relancer le service pour la prise en compte de la mise à jour.

#sudo service sonarqube start


Icon-database-process.png Mise à jour de la base

Une mise à jour de la base de données est nécessaire pour cette version, ce qui est indiqué dans la trace d'exécution, fichier /var/log/sonarqube/sonar.log.

WARN  web[o.s.s.p.DatabaseServerCompatibility]  Database must be upgraded. Please browse /setup

Celle-ci se déclenche en accédant à l'URL http://SERVER/sonar/setup.


Viewer icon.png Voir Aussi

Upgrade Notes: http://docs.sonarqube.org/display/SONARNEXT/Release+4.5+Upgrade+Notes