{"id":1217,"date":"2020-12-25T02:41:36","date_gmt":"2020-12-25T02:41:36","guid":{"rendered":"https:\/\/www.nicktailor.com\/?p=1217"},"modified":"2022-10-21T11:22:32","modified_gmt":"2022-10-21T11:22:32","slug":"how-to-add-your-custom-tomcat-installation-to-systemd-with-ansible","status":"publish","type":"post","link":"https:\/\/nicktailor.com\/tech-blog\/how-to-add-your-custom-tomcat-installation-to-systemd-with-ansible\/","title":{"rendered":"How to add a custom tomcat installation to SystemD with ansible."},"content":{"rendered":"

Okay so say you have a custom install of tomcat and java, which is what a lot of people do because java update and tomcat updates can bring things down. So things need to be tested before updates and standard patch cycles can end up affecting the environment.<\/p>\n

But you want to handle the startup and stopping via systemd to be able to get status outputs and let system handle the service on reboots. This is how to do it slick.<\/p>\n

.<\/span><\/span><\/p>\n

Ansible Setup:<\/strong><\/p>\n

\n
\n
\u2022<\/span> <\/span>This post assumes you have ansible setup and running. If you don\u2019t search through my blog and you should find a post on how to setup.<\/div>\n<\/div>\n<\/div>\n

Role: <\/strong><\/p>\n

\n
\n
\u2022<\/span> <\/span>We are going to setup a custom role to add your custom tomcat install system<\/div>\n<\/div>\n<\/div>\n

Setup the new role:<\/strong><\/p>\n

.<\/span><\/span><\/p>\n

\n
\n
\u2022<\/span> <\/span>Create a new directory in \/etc\/ansible\/role for your new role<\/div>\n
\n
\n
\u25e6<\/span> <\/span>mkdir<\/em><\/span> -p \/etc\/ansible\/roles\/<\/em><\/span>AddtomcatSystemD<\/em><\/span>\/tasks\/<\/em><\/span><\/strong><\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n

.<\/span><\/span><\/p>\n

\n
\n
\u2022<\/span> <\/span>Now create a yaml file that will run a set of tasks to set this up for ya.<\/div>\n
\n
\n
\u25e6<\/span> <\/span>vi <\/em><\/span>main.yml<\/em><\/span><\/strong><\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n

.<\/span><\/span><\/p>\n

Main.yml<\/span><\/p>\n

===========================================<\/span><\/p>\n

Note: this will install the <\/span>redhat<\/span> tomcat version of tomcat. Do not worry we are not going to be using this tomcat. This is just so <\/span>redhat<\/span> automatically setups all the needed services and locations. We will then update the <\/span>SystemD<\/span> config for tomcat to use the custom version.<\/span><\/strong><\/p>\n

– name: Install the latest version of tomcat<\/span><\/p>\n

package:<\/span><\/p>\n

name: tomcat<\/span><\/p>\n

state: latest<\/span><\/p>\n

.<\/span><\/span><\/p>\n

Note: This <\/span>symlink<\/span> is important as tomcat default install by <\/span>redhat<\/span> is inside \/opt\/tomcat. Update the <\/span>src<\/span> to the custom location of your tomcat<\/span><\/strong><\/p>\n

.<\/span><\/span><\/p>\n

– name: Create symbolic link for “tomcat” in \/opt<\/span><\/p>\n

file:<\/span><\/p>\n

    <\/span>src<\/span>: \/<\/span>custom\/install\/tomcat<\/span><\/p>\n

path: \/opt\/tomcat<\/span><\/p>\n

force: yes<\/span><\/p>\n

state: link<\/span><\/p>\n

.<\/span><\/span><\/p>\n

Note: This will enable tomcat to start up on reboot<\/span><\/strong><\/p>\n

.<\/span><\/span><\/p>\n

– name: Enable tomcat service on <\/span>startup<\/span><\/p>\n

shell: <\/span>systemctl<\/span> enable tomcat<\/span><\/p>\n

.<\/span><\/span><\/p>\n

Note: This is the tomcat <\/span>systemd<\/span> service file that <\/span>systemd<\/span> uses for the default install. We are going to empty.<\/span><\/strong><\/p>\n

.<\/span><\/span><\/p>\n

– name: Null <\/span>tomcat.service<\/span> file<\/span><\/p>\n

shell: “>\/etc\/<\/span>systemd<\/span>\/system\/<\/span>tomcat.service<\/span>“<\/span><\/p>\n

.<\/span><\/span><\/p>\n

Note: We are now going to add our custom block for tomcat into the <\/span>tomcat.service<\/span> file we just emptied above using the <\/span>blockinfle<\/span> module. This means that this whole section will also be managed by ansible as well. Make sure you adjust the <\/span>java_home<\/span> if your java <\/span>isn\u2019t<\/span> location inside tomcat. Along with the <\/span>user<\/span>,group<\/span>,umask<\/span> for <\/span>to your <\/span>custom tomcat<\/span>.<\/span> <\/strong><\/p>\n

.<\/span><\/span><\/p>\n

– name: Edit <\/span>tomcat.service<\/span> for <\/span>systemd<\/span><\/p>\n

  <\/span>blockinfile<\/span>:<\/span><\/p>\n

    <\/span>dest<\/span>: \/etc\/<\/span>systemd<\/span>\/system\/<\/span>tomcat.service<\/span><\/p>\n

    <\/span>insertafter<\/span>:<\/span><\/p>\n

block: |<\/span><\/p>\n

[Unit]<\/span><\/p>\n

Description=Apache Tomcat Web Application Container<\/span><\/p>\n

After=<\/span>syslog.target<\/span> network.target<\/span><\/p>\n

      <\/span><\/p>\n

[Service]<\/span><\/p>\n

Type=forking<\/span><\/p>\n

.<\/span><\/span><\/p>\n

Environment=JAVA_HOME=\/opt\/tomcat<\/span><\/p>\n

Environment=CATALINA_PID=\/opt\/tomcat\/temp\/<\/span>tomcat.pid<\/span><\/p>\n

Environment=CATALINA_HOME=\/opt\/tomcat<\/span><\/p>\n

Environment=CATALINA_BASE=\/opt\/tomcat<\/span><\/p>\n

Environment=’CATALINA_OPTS=-Xms512M -Xmx1024M -server –<\/span>XX:+<\/span>UseParallelGC<\/span>‘<\/span><\/p>\n

Environment=’JAVA_OPTS=-<\/span>Djava.awt.headless<\/span>=true –<\/span>Djava.security.egd<\/span>=file:\/dev\/.\/<\/span>urandom<\/span>‘<\/span><\/p>\n

.<\/span><\/span><\/p>\n

ExecStart=\/opt\/tomcat\/bin\/startup.sh<\/span><\/p>\n

      <\/span>ExecStop<\/span>=\/bin\/kill -15 $MAINPID<\/span><\/p>\n

.<\/span><\/span><\/p>\n

User=<\/span>tomcat<\/span><\/p>\n

Group=<\/span>tomcat<\/span><\/p>\n

      <\/span>UMask<\/span>=<\/span><\/p>\n

      <\/span>RestartSec<\/span>=10<\/span><\/p>\n

Restart=always<\/span><\/p>\n

      <\/span><\/p>\n

[Install]<\/span><\/p>\n

      <\/span>WantedBy<\/span>=multi-<\/span>user.target<\/span><\/p>\n

.<\/span><\/span><\/p>\n

Note: This will then reload the custom tomcat via <\/span>systemd<\/span><\/strong><\/p>\n

– name: Start tomcat service with <\/span>Systemd<\/span><\/p>\n

  <\/span>systemd<\/span>: <\/span><\/p>\n

name: tomcat<\/span><\/p>\n

    <\/span>daemon_<\/span>reload<\/span>:<\/span> yes<\/span><\/p>\n

.<\/span><\/span><\/p>\n

Note: This will then check to see if the new tomcat is service running and out to the ansible playbook log.<\/span><\/strong><\/p>\n

    <\/span><\/p>\n

– name: get service facts<\/span><\/p>\n

  <\/span>service_facts<\/span>:<\/span><\/p>\n

.<\/span><\/span><\/p>\n

– name: Check to see if tomcat is running<\/span><\/p>\n

debug:<\/span><\/p>\n

var: <\/span>ansible_<\/span>facts.services<\/span>[“<\/span>tomcat.service<\/span>“]<\/span><\/p>\n

.<\/span><\/span><\/p>\n

.<\/span><\/span><\/p>\n

Ansibe playbook log:<\/p>\n

.<\/span><\/span><\/p>\n

[<\/span>root@<\/span>nickansible<\/span>]#<\/span> ansible-playbook –<\/span>i<\/span> i<\/span>nventory\/DEV\/hosts <\/span>justtomcatrole.yml<\/span> –limit ‘<\/span>nicktestvm<\/span>‘ -k<\/span><\/p>\n

.<\/span><\/span><\/p>\n

SSH password:<\/span><\/p>\n

.<\/span><\/span><\/p>\n

PLAY [all] ************************************************************************************************************************************************************************************************<\/span><\/p>\n

.<\/span><\/span><\/p>\n

TASK [<\/span>AddTomCatSystemD<\/span> : Create symbolic link for “tomcat” in \/opt] ***************************************************************************************************************************************<\/span><\/p>\n

changed: <\/span>nicktestvm<\/span>]<\/span><\/p>\n

.<\/span><\/span><\/p>\n

TASK [<\/span>AddTomCatSystemD<\/span> : Enable tomcat service on <\/span>startup<\/span>] ************************************************************************************************************************************************<\/span><\/p>\n

changed: <\/span>nicktestvm<\/span>]<\/span><\/p>\n

.<\/span><\/span><\/p>\n

TASK [<\/span>AddTomCatSystemD<\/span> : Null <\/span>tomcat.service<\/span> file] ********************************************************************************************************************************************************<\/span><\/p>\n

changed: <\/span>nicktestvm<\/span>]<\/span><\/p>\n

.<\/span><\/span><\/p>\n

TASK [<\/span>AddTomCatSystemD<\/span> : Edit <\/span>tomcat.service<\/span> for <\/span>systemd<\/span>] *************************************************************************************************************************************************<\/span><\/p>\n

changed: <\/span>nicktestvm<\/span>]<\/span><\/p>\n

.<\/span><\/span><\/p>\n

TASK [<\/span>AddTomCatSystemD<\/span> : Start tomcat service with <\/span>Systemd<\/span>] ***********************************************************************************************************************************************<\/span><\/p>\n

ok: <\/span>nicktestvm<\/span>]<\/span><\/p>\n

.<\/span><\/span><\/p>\n

TASK [<\/span>AddTomCatSystemD<\/span> : get service facts] ***************************************************************************************************************************************************************<\/span><\/p>\n

ok: <\/span>nicktestvm<\/span>]<\/span><\/p>\n

.<\/span><\/span><\/p>\n

TASK [<\/span>AddTomCatSystemD<\/span> : Check to see if tomcat is running] ***********************************************************************************************************************************************<\/span><\/p>\n

ok: <\/span>nicktestvm<\/span>] => {<\/span><\/p>\n

“<\/span>ansible_<\/span>facts.services<\/span>[\\”<\/span>tomcat.service<\/span>\\”]”: {<\/span><\/p>\n

“name”: “<\/span>tomcat.service<\/span>“,<\/span><\/p>\n

“source”: “<\/span>systemd<\/span>“,<\/span><\/p>\n

“state”: “running”,<\/span><\/p>\n

“status”: “enabled”<\/span><\/p>\n

}<\/span><\/p>\n

}<\/span><\/p>\n

.<\/span><\/span><\/p>\n

PLAY RECAP ************************************************************************************************************************************************************************************************<\/span><\/p>\n

nicktestvm<\/span> :<\/span> ok=7 changed=4 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0<\/span><\/p>\n

.<\/span><\/span><\/p>\n

.<\/span><\/span><\/p>\n

.<\/span><\/span><\/p>\n

==========================<\/p>\n

[root@nicktestvm ~]# cat \/etc\/systemd\/system\/tomcat.service<\/p>\n

# BEGIN ANSIBLE MANAGED BLOCK<\/strong><\/p>\n

[Unit]<\/p>\n

Description=Apache Tomcat Web Application Container<\/p>\n

After=syslog.target network.target<\/p>\n

.<\/span><\/span><\/p>\n

[Service]<\/p>\n

Type=forking<\/p>\n

.<\/span><\/span><\/p>\n

Environment=JAVA_HOME=\/opt\/tomcat<\/p>\n

Environment=CATALINA_PID=\/opt\/tomcat\/temp\/tomcat.pid<\/p>\n

Environment=CATALINA_HOME=\/opt\/tomcat<\/p>\n

Environment=CATALINA_BASE=\/opt\/tomcat<\/p>\n

Environment=’CATALINA_OPTS=-Xms512M -Xmx1024M -server -XX:+UseParallelGC’<\/p>\n

Environment=’JAVA_OPTS=-Djava.awt.headless=true -Djava.security.egd=file:\/dev\/.\/urandom’<\/p>\n

.<\/span><\/span><\/p>\n

ExecStart=\/opt\/tomcat\/bin\/startup.sh<\/p>\n

ExecStop=\/bin\/kill -15 $MAINPID<\/p>\n

.<\/span><\/span><\/p>\n

User=tomcat<\/p>\n

Group=tomcat<\/p>\n

UMask=0028<\/p>\n

RestartSec=10<\/p>\n

Restart=always<\/p>\n

.<\/span><\/span><\/p>\n

[Install]<\/p>\n

WantedBy=multi-user.target<\/p>\n

# END ANSIBLE MANAGED BLOCK<\/strong><\/p>\n

.<\/span><\/span><\/p>\n

.<\/span><\/span><\/p>\n

SystemD<\/span> Status:<\/span><\/strong><\/p>\n

.<\/span><\/span><\/p>\n

root@nicktestvm ~]# systemctl status tomcat<\/p>\n

\u25cf <\/span>tomcat.service – Apache Tomcat Web Application Container<\/p>\n

Loaded: loaded (\/etc\/systemd\/system\/tomcat.service; enabled; vendor preset: disabled)<\/p>\n

Active: active <\/span>(running) since Thu 2020-12-24 05:11:21 GMT; 21h ago<\/p>\n

Process: 6333 ExecStop=\/bin\/kill -15 $MAINPID (code=exited, status=0\/SUCCESS)<\/p>\n

Process: 6353 ExecStart=\/opt\/tomcat\/bin\/startup.sh (code=exited, status=0\/SUCCESS)<\/p>\n

Main PID: 6363 (java)<\/p>\n

   CGroup: \/system.slice\/tomcat.service<\/p>\n

\u2514\u25006363 \/usr\/local\/java\/java -Djava.util.logging.config.file=\/opt\/tomcat\/conf\/logging.properties -Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager -server -Xms1…<\/p>\n

.<\/span><\/span><\/p>\n

Dec 24 05:11:21 nicktestvm systemd[1]: Starting Apache Tomcat Web Application Container…<\/p>\n

Dec 24 05:11:21 nicktestvm startup.sh[6353]: Existing PID file found during start.<\/p>\n

Dec 24 05:11:21 nicktestvm startup.sh[6353]: Removing\/clearing stale PID file.<\/p>\n

Dec 24 05:11:21 nicktestvm systemd[1]: Started Apache Tomcat Web Application Container.<\/p>\n

.<\/span><\/span><\/p>\n

.<\/span><\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

Okay so say you have a custom install of tomcat and java, which is what a lot of people do because java update and tomcat updates can bring things down. So things need to be tested before updates and standard patch cycles can end up affecting the environment. But you want to handle the startup and stopping via systemd toRead More …<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[51,58,138],"tags":[],"class_list":["post-1217","post","type-post","status-publish","format-standard","hentry","category-ansible","category-centos","category-linux"],"_links":{"self":[{"href":"https:\/\/nicktailor.com\/tech-blog\/wp-json\/wp\/v2\/posts\/1217","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/nicktailor.com\/tech-blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/nicktailor.com\/tech-blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/nicktailor.com\/tech-blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/nicktailor.com\/tech-blog\/wp-json\/wp\/v2\/comments?post=1217"}],"version-history":[{"count":13,"href":"https:\/\/nicktailor.com\/tech-blog\/wp-json\/wp\/v2\/posts\/1217\/revisions"}],"predecessor-version":[{"id":1590,"href":"https:\/\/nicktailor.com\/tech-blog\/wp-json\/wp\/v2\/posts\/1217\/revisions\/1590"}],"wp:attachment":[{"href":"https:\/\/nicktailor.com\/tech-blog\/wp-json\/wp\/v2\/media?parent=1217"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/nicktailor.com\/tech-blog\/wp-json\/wp\/v2\/categories?post=1217"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/nicktailor.com\/tech-blog\/wp-json\/wp\/v2\/tags?post=1217"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}