Dans l'exemple qui suit, j'ai fait un programme Java qui va logguer un message toute les 5 secondes. J'utilise dans cette exemple Lombok , SLF4 et le @Scheduled de Spring . Il sera lancer comme service au lancement de l'OS.
Les sources de l'exemple sont sur github.
Fichier control
Pour la réalisation du paquet, il est nécessaire d'avoir un fichier control contenant les informations de votre paquet tel que son nom, sa version, ses dépendances...
Dans l'exemple, j'ai mis 2 dépendances pour illustrer cette utilisation :
- dos2unix interviendra dans le script de post-installation (postinst) pour s'assurer que le script de lancement est bien au format unix.
- sudo sera utilisé pour lancer le service avec l'utilisateur approprié
Scripts de pre et post-installation
L'installation d'un paquet peut aussi faire intervenir des scripts avant la phase d'installation de votre application et après installation de votre application. Vous pouvez faire intervenir les scripts :
- preinst : avant installation
- postinst : après installation
- prerm : avant désinstallation
- postrm : après désinstallation
Je met l'ensemble de ces fichiers dans le répertoire src/main/deb/control de mon projet :
Dans cet exemple, le script de pre-installation vérifie par exemple l'existence d'un utilisateur dédié au lancement du service. Il va aussi préparer l'arborescence pour le bon fonctionnement du service.
Le script de post-installation utilisera la commande update-rc.d pour inscrire le service et le démarrera.
Fichier init.d
Pour lancer et arrêter le service, j'utilise le fichier jdeb-tips.sh que j'ai mis dans le répertoire src/main/deb/init.d
J'ai utilisé et modifié un template provenant d'ici.
pom.xml
Step 1
Ayant utilisé des propriétés Maven dans les fichiers du répertoire src/main/deb, je les copies dans le répertoire 'target' en utilisant le filtragre :
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>2.4.3</version>
<executions>
<execution>
<id>copy-deb-package-resources</id>
<phase>prepare-package</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${basedir}/target/deb</outputDirectory>
<resources>
<resource>
<directory>src/main/deb</directory>
<filtering>true</filtering>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
Step 2
Je récupère les dépendances pour permettre une exécution autonome du programme :
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<id>copy-dependencies</id>
<phase>prepare-package</phase>
<goals>
<goal>copy-dependencies</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/libs</outputDirectory>
<overWriteReleases>false</overWriteReleases>
<overWriteSnapshots>false</overWriteSnapshots>
<overWriteIfNewer>true</overWriteIfNewer>
</configuration>
</execution>
</executions>
</plugin>
Step 3
J'utilise ensuite maven-jar-plugin pour réaliser mon Jar exécutable :
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.3.2</version>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<classpathPrefix>libs/</classpathPrefix>
<mainClass>fr.gunduz.tips.jdeb.Main</mainClass>
</manifest>
</archive>
</configuration>
</plugin>
Step 4
Enfin, l'utilisation du plugin JDeb. Ce qui est important de noter dans ce qui suit est comment indiquer au plugin où ce trouve les fichiers control grâce à la balise <controlDir>. Etant donnée que j'ai copié les fichiers -afin qu'ils soient valués- dans le répertoire target, il faut absolument utiliser cette balise.
Le reste de la configuration indique uniquement les fichiers à inclure dans le paquet deb ainsi que les répertoires de destination et leurs propriétés.
<plugin>
<artifactId>jdeb</artifactId>
<groupId>org.vafer</groupId>
<version>1.0</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>jdeb</goal>
</goals>
<configuration>
<verbose>true</verbose>
<controlDir>${basedir}/target/deb/control</controlDir>
<dataSet>
<data>
<src>${project.basedir}/target/libs</src>
<type>directory</type>
<mapper>
<type>perm</type>
<prefix>${debian.target.dir}/jdeb-tips/libs/</prefix>
<user>jdeb-tips</user>
<group>jdeb-tips</group>
<filemode>644</filemode>
</mapper>
</data>
<data>
<src>${basedir}/target/${project.build.finalName}.jar</src>
<dst>${debian.target.dir}/jdeb-tips/${project.build.finalName}.jar</dst>
<type>file</type>
<mapper>
<type>perm</type>
<user>jdeb-tips</user>
<group>jdeb-tips</group>
<filemode>644</filemode>
</mapper>
</data>
<data>
<src>${basedir}/target/deb/init.d/jdeb-tips.sh</src>
<dst>/etc/init.d/jdeb-tips</dst>
<type>file</type>
<mapper>
<type>perm</type>
<user>root</user>
<group>root</group>
<filemode>755</filemode>
</mapper>
</data>
</dataSet>
</configuration>
</execution>
</executions>
</plugin>
Construction et installation
Il vous suffit de lancer la commande mvn clean install pour avoir votre paquet Debian. Pour l'installer sur le système hôte, il faudra utiliser la commande dpkg -i <votre paquet>.
Attention, si vos dépendances ne sont pas installées au préalable à l'aide d'apt, la commande dpkg retournera une erreur.
Aucun commentaire:
Enregistrer un commentaire