Run a spring boot jar as a linux service with systemd

May 1st, 2019

Generate a new spring boot camel project by running a maven archetype (maven settings.xml supplied at the end of this article if you need the repositories):

mvn org.apache.maven.plugins:maven-archetype-plugin:RELEASE:generate -DgroupId=com.codergists -DartifactId=simple-camel-logger -Dversion=1.0 -DarchetypeGroupId=org.jboss.fuse.fis.archetypes -DarchetypeArtifactId=spring-boot-camel-archetype -DarchetypeVersion=2.2.0.fuse-720018-redhat-00001 -DarchetypeRepository=https://maven.repository.redhat.com/ga/
cd simple-camel-logger
view raw generate-springboot-jar.sh hosted with ❤ by GitHub

Check you can build and run the project

mvn clean package
cd target
java -jar simple-camel-logger-1.0.jar
view raw run-standalone-jar.sh hosted with ❤ by GitHub

Check you get some output:

. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v1.5.16.RELEASE)
...
15:10:35.483 [main] INFO com.codergists.Application - Started Application in 4.552 seconds (JVM running for 4.991)
15:10:36.395 [Camel (MyCamel) thread #1 - timer://foo] INFO route1 - >>> Hello World
15:10:41.386 [Camel (MyCamel) thread #1 - timer://foo] INFO route1 - >>> Hello World
view raw java-jar-output.txt hosted with ❤ by GitHub

Create a new user and copy the jar to a runnable location

sudo useradd springboot
sudo passwd springboot
sudo chown springboot:springboot simple-camel-logger-1.0.jar
sudo chmod 500 simple-camel-logger-1.0.jar
sudo mkdir -p /var/springboot/
mv simple-camel-logger-1.0.jar /var/springboot/simple-camel-logger-1.0.jar
view raw setup-users-permissions.sh hosted with ❤ by GitHub

Create a new systemd configuration file at /etc/systemd/system/simple-camel-logger.service

#/etc/systemd/system/simple-camel-logger.service
[Unit]
Description=simple-camel-logger spring boot application
After=syslog.target
[Service]
Type=simple
User=springboot
Restart=always
RestartSec=5
ExecStart=/usr/bin/java -jar /var/springboot/simple-camel-logger-1.0.jar
SuccessExitStatus=143
[Install]
WantedBy=multi-user.target
view raw simple-camel-logger.service hosted with ❤ by GitHub

You should now be able to use systemctl to enable, start, and stop the service:

[user@localhost somedir]$ systemctl enable simple-camel-logger.service
[user@localhost somedir]$ systemctl start simple-camel-logger.service
[user@localhost somedir]$ systemctl status simple-camel-logger.service
● simple-camel-logger.service - simple-camel-logger spring boot application
   Loaded: loaded (/etc/systemd/system/simple-camel-logger.service; disabled; vendor preset: disabled)
   Active: active (running) since Wed 2019-05-01 09:29:19 BST; 8s ago
 Main PID: 8968 (java)
    Tasks: 44 (limit: 4915)
   Memory: 556.1M
   CGroup: /system.slice/simple-camel-logger.service
           └─8968 /usr/bin/java -jar /var/springboot/simple-camel-logger-1.0.jar

May 01 09:29:25 somebox java[8968]: 09:29:25.356 [main] INFO  o.a.camel.spring.SpringCamelContext - StreamCaching is not in use. If using streams then its reco>
May 01 09:29:25 somebox java[8968]: 09:29:25.382 [main] INFO  o.a.camel.spring.SpringCamelContext - Route: route1 started and consuming from: timer://foo?perio>
May 01 09:29:25 somebox java[8968]: 09:29:25.383 [main] INFO  o.a.camel.spring.SpringCamelContext - Total 1 routes, of which 1 are started
May 01 09:29:25 somebox java[8968]: 09:29:25.384 [main] INFO  o.a.camel.spring.SpringCamelContext - Apache Camel 2.21.0.fuse-720050-redhat-00001 (CamelContext:>
May 01 09:29:25 somebox java[8968]: 09:29:25.448 [main] INFO  o.s.b.c.e.u.UndertowEmbeddedServletContainer - Undertow started on port(s) 8081 (http)
May 01 09:29:25 somebox java[8968]: 09:29:25.454 [main] INFO  o.s.c.s.DefaultLifecycleProcessor - Starting beans in phase 0
May 01 09:29:25 somebox java[8968]: 09:29:25.464 [main] INFO  o.s.b.a.e.jmx.EndpointMBeanExporter - Located managed bean 'healthEndpoint': registering with JMX>
May 01 09:29:25 somebox java[8968]: 09:29:25.512 [main] INFO  o.s.b.c.e.u.UndertowEmbeddedServletContainer - Undertow started on port(s) 8080 (http)
May 01 09:29:25 somebox java[8968]: 09:29:25.515 [main] INFO  com.codergists.Application - Started Application in 5.419 seconds (JVM running for 5.913)
May 01 09:29:26 somebox java[8968]: 09:29:26.393 [Camel (MyCamel) thread #1 - timer://foo] INFO  route1 - >>> Hello World

[user@localhost somedir]$ systemctl stop simple-camel-logger.service

Maven Repositories

Add the following to your ~/.m2/settings.xml file so maven knows how to resolve the fuse and redhat java artefacts.

<?xml version="1.0"?>
<settings>
<profiles>
<profile>
<id>extra-repos</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>redhat-ga-repository</id>
<url>https://maven.repository.redhat.com/ga</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>redhat-ea-repository</id>
<url>https://maven.repository.redhat.com/earlyaccess/all</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>jboss-public</id>
<name>JBoss Public Repository Group</name>
<url>https://repository.jboss.org/nexus/content/groups/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>redhat-ga-repository</id>
<url>https://maven.repository.redhat.com/ga</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>redhat-ea-repository</id>
<url>https://maven.repository.redhat.com/earlyaccess/all</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>jboss-public</id>
<name>JBoss Public Repository Group</name>
<url>https://repository.jboss.org/nexus/content/groups/public</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<activeProfiles>
<activeProfile>extra-repos</activeProfile>
</activeProfiles>
</settings>
view raw settings.xml hosted with ❤ by GitHub

References

codergists