Jenkins Stratégie Backup
L'application Jenkins
est utilisée de le cadre d'une intégration continue. Son installation est assez simple, mais elle nécessite quelques configurations, pour les projets, les planifications... Cet article présente la mise en place d'une telle stratégie, sous Ubuntu
, permettant de réaliser:
- 1 sauvegarde complète une fois tous les quinze jours.
- Export des sauvegardes vers un serveur "externe" via FTP.
- Conservation de la dernière sauvegarde complète, et des incrémentales.
La synchronisation des sauvegardes s'effectue à l'aide de l'outil de backup Duplicity. Le fait d'externaliser les sauvegardes apporte une garantie supplémentaire. En effet, si le serveur venait à être en panne, les sauvegardes de Jenkins
resteront disponibles.
A noter, il est nécessaire de paramétrer correctement Jenkins afin de ne pas conserver trop de build, au risque de voir grossir les sauvegardes. En effet, est il vraiment nécessaire de conserver une vingtaine de build, surtout si l'espace de travail nécessite des centaines de MégaOctets ?
Sommaire
Votre avis
Current user rating: 99/100 (2 votes)
|
|
Objectif
L'installation faite sous Ubuntu met en place différents répertoires / fichiers:
- Répertoire
/usr/share/tomcat6/.jenkins
: Contient les personnalisations de l'installation. - Répertoire
/var/lib/tomcat6/webapps/jenkins
: Contient l'installation de l'application. - Fichier
/etc/apache2/httpd.conf
: Contient la déclaration de la publication sous Apache.
Sous Ubuntu, il existe le répertoire /var/backups
, utilisé par aptitude, dpkg, OpenLDAP ... Cependant, il ne sera pas utilisé dans le cadre de cet article, pour ne pas engendrer d'éventuels effets de bord.
Tous les scripts et données seront stockés dans un nouveau répertoire /var/opt/backups
(pour l'ensemble des stratégies) et plus particulièrement dans le répertoire /var/opt/backups/jenkins
.
Concernant les logs, elles seront toutes placées dans le répertoire /var/log/backups
.
#sudo mkdir -p /var/opt/backups/jenkins #sudo chmod 740 /var/opt/backups/jenkins #sudo chown root:root /var/opt/backups/jenkins #sudo mkdir /var/log/backups
Sauvegardes
Les configurations, et installations, sont sauvegardées à l'aide de l'outil Duplicity.
Source
Le script jenkins_backup.sh
est mis en place, avec des sécurités autorisant uniquement le compte root
à le modifier, dans le répertoire /var/opt/backups/jenkins
avec le code suivant:
#!/bin/bash
dateLogFormat="+%Y-%m-%d %H:%M";
# Backup log
pathLog="/var/log/backups/jenkins_backup.log";
echo "[$(date "$dateLogFormat")] Start backup" >> $pathLog;
echo "[$(date "$dateLogFormat")] Start upload with duplicity" >> $pathLog;
export PASSPHRASE=DUPLICITY PASSPHRASE
export FTP_PASSWORD=USER_PASSWORD
duplicity remove-all-but-n-full 1 --force ftp://FTP_LOGIN@HOST/backup/jenkins >> $pathLog;
duplicity --include '/usr/share/tomcat6/.jenkins' --include '/var/lib/tomcat6/webapps/jenkins' --include '/etc/apache2/httpd.conf'
--exclude '**' --full-if-older-than 15D / ftp://FTP_LOGIN@HOST/backup/jenkins >> $pathLog;
unset PASSPHRASE
unset FTP_PASSWORD
echo "[$(date "$dateLogFormat")] End upload with duplicity" >> $pathLog;
echo "[$(date "$dateLogFormat")] End backup" >> $pathLog;
Attention à l'utilisation de l'instruction export
, surtout pour la PASSPHRASE. En effet, si celle-ci contient des espaces, il est impératif de la placer entre le caractère "
.
Le script est créé avec un droit de modification et exécution uniquement pour le compte root
:
#sudo chmod 740 /var/opt/backups/jenkins/jenkins_backup.sh #sudo chown root:root /var/opt/backups/jenkins/jenkins_backup.sh
Le fonctionnement de ce script est assez simple. Puis deux variables d'environnement sont mises en place:
- PASSPHRASE: Phrase pour le cryptage des données par duplicity.
- FTP_PASSWORD: Le mot de passe FTP utilisé pour se connecté via duplicity.
La première instruction, avec l'argument remove-all-but-n-full 1
, va conserver uniquement la dernière sauvegarde complète. Puis la seconde instruction, avec l'argument --full-if-older-than 15D
effectue une sauvegarde incrémentale uniquement si la précédente complète n'est pas plus ancienne de quinze jours.
Les fichiers sont ensuite synchronisés sur un serveur FTP, configuré par la value HOST
, en utilisant le login FTP_LOGIN
et le mot de passe USER_PASSWORD
placé dans la variable FTP_PASSWORD
. Les sauvegardes sont stockées à l'emplacement backup/jenkins
à la racine du compte après connexion sur FTP.
Enfin, les exécutions sont tracées dans la log /var/log/backups/jenkins_backup.log
.
Exemples
Le script n'accepte aucun argument. L'exécution s'effectue simplement par la ligne suivante:
#./jenkins_backup.sh
Planification
Une fois que le script de sauvegarde est mis en place, il est possible de l'exécuter manuellement. Mais l'objectif est de l'exécuter automatiquement et régulièrement sans s'en préoccuper. Dans le cadre de cette implémentation, la planification est réalisée à l'aide de l'outil Crontab disponible sur les systèmes Linux. L'outil Anacron n'a pas été utilisé car les planifications souhaitées doivent se faire à des heures et des jours particuliers.
La mise en place s'effectue en modifiant le fichier /etc/crontab
pour y ajouter une ligne.
# /etc/crontab: system-wide crontab
# Unlike any other crontab you don't have to run the `crontab'
# command to install the new version when you edit this file
# and files in /etc/cron.d. These files also have username fields,
# that none of the other crontabs do.
SHELL=/bin/sh
PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
# m h dom mon dow user command
17 * * * * root cd / && run-parts --report /etc/cron.hourly
25 6 * * * root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.daily )
47 6 * * 7 root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.weekly )
52 6 1 * * root test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.monthly )
30 5 * * * root cd / && /var/opt/backups/jenkins/jenkins_backup.sh
#
Les sauvegardes sont planifiées à 5h30 AM, tous les jours de la semaine, par l'exécution de la commande cd / && /var/opt/backups/jenkins/jenkins_backup.sh
.
Gestions des logs
Un fichier de log est créé par le script mis en place, à l'emplamcent /var/log/backups/jenkins_backup.log
. Comme pour l'ensemble des produits, une rotation de ces logs est mise en place, à l'aide de l'outil Logrotate.
La configuration permet une rotation hebdomadaire, en conservant 3 rotations. Les rotations sont compressées, en asynchrone, et créées avec un accès en modification au compte root.
Cette configuration est mise en place dans le fichier jenkins_backup
, sous le répertoire /etc/logrotate.d
/var/log/backups/jenkins_backup.log {
weekly
missingok
rotate 3
compress
delaycompress
notifempty
create 640 root root
}
Update
Suite à la mise à jour de Tomcat 7, le script de sauvegarde, fichier jenkins_backup.sh
, n'est plus valide. Il est nécessaire de modifier les chemins des répertoires sauvegardés en passant de tomcat6
à tomcat7
.
#!/bin/bash
dateLogFormat="+%Y-%m-%d %H:%M";
# Backup log
pathLog="/var/log/backups/jenkins_backup.log";
echo "[$(date "$dateLogFormat")] Start backup" >> $pathLog;
echo "[$(date "$dateLogFormat")] Start upload with duplicity" >> $pathLog;
export PASSPHRASE=DUPLICITY PASSPHRASE
export FTP_PASSWORD=USER_PASSWORD
duplicity remove-all-but-n-full 1 --force ftp://FTP_LOGIN@HOST/backup/jenkins >> $pathLog;
duplicity --include '/usr/share/tomcat7/.jenkins' --include '/var/lib/tomcat7/webapps/jenkins' --include '/etc/apache2/httpd.conf'
--exclude '**' --full-if-older-than 15D / ftp://FTP_LOGIN@HOST/backup/jenkins >> $pathLog;
unset PASSPHRASE
unset FTP_PASSWORD
echo "[$(date "$dateLogFormat")] End upload with duplicity" >> $pathLog;
echo "[$(date "$dateLogFormat")] End backup" >> $pathLog;
De la même façon, lors de la mise à jour de Tomcat 8, l'emplacement n'est plus valide et doit être modifié pour prendre le changement d'emplacement depuis tomcat7
vers tomcat8
.
#!/bin/bash
dateLogFormat="+%Y-%m-%d %H:%M";
# Backup log
pathLog="/var/log/backups/jenkins_backup.log";
echo "[$(date "$dateLogFormat")] Start backup" >> $pathLog;
echo "[$(date "$dateLogFormat")] Start upload with duplicity" >> $pathLog;
export PASSPHRASE=DUPLICITY PASSPHRASE
export FTP_PASSWORD=USER_PASSWORD
duplicity remove-all-but-n-full 1 --force ftp://FTP_LOGIN@HOST/backup/jenkins >> $pathLog;
duplicity --include '/usr/share/tomcat8/.jenkins' --include '/var/lib/tomcat8/webapps/jenkins' --include '/etc/apache2/httpd.conf'
--exclude '**' --full-if-older-than 15D / ftp://FTP_LOGIN@HOST/backup/jenkins >> $pathLog;
unset PASSPHRASE
unset FTP_PASSWORD
echo "[$(date "$dateLogFormat")] End upload with duplicity" >> $pathLog;
echo "[$(date "$dateLogFormat")] End backup" >> $pathLog;