Create custom service linux

How to create a systemd service in Linux

Learn the steps for creating systemd services in Linux with the practical example demonstrated in this tutorial.

Since its introduction in March 2010, people have had various opinions about systemd. But one thing that you cannot deny is that systemd is now present in almost all Linux distributions!

Sure, there are Linux distributions that explicitly advertise usage of a different init system other than systemd, but those are very rare. Ubuntu, Fedora, RHEL, Debian, Pop!_OS, openSUSE, Arch – all of them ship with systemd by default.

Since systemd is used so widely, it is worth taking a look at and learning about how to create a systemd services.

What is a systemd service?

Simply put, a service is a «background process» that is started or stopped based on certain circumstances. You are not required to manually start and/or stop it. A ‘systemd service file’ is a file that is written in a format such that systemd is able to parse and understand it, and later on do what you told it to do.

Technically what I am referring to as ‘systemd service file’ is actually called a ‘systemd unit’ file, but since this tutorial is about creating a service, I will continue referring to this as ‘systemd service file’.

Understanding the basic structure of a systemd service file

The systemd service file has three important and necessary sections. They are [Unit] , [Service] and [Install] sections. The systemd service file’s extension is .service and we use the pound/hash symbol ( # ) for single line comments.

Below is an example of a systemd service file. Please note that this is NOT an actual systemd service file. I have modified it so that it helps you understand.

[Unit] Description=Apache web server After=network.target Before=nextcloud-web.service [Service] ExecStart=/usr/local/apache2/bin/httpd -D FOREGROUND -k start ExecReload=/usr/local/apache2/bin/httpd -k graceful Type=notify Restart=always [Install] WantedBy=default.target RequiredBy=network.target

This is the most basic structure of a systemd service file. Let us understand what each of these words mean.

The [Unit] section

The Unit section contains details and description about the unit itself. In our case, it contains details about the service. Details like ‘what is its description’, ‘what are its dependencies’ and more.

Below are the fields the Unit section has:

• Description :- Human-readable title of the systemd service.
• After :- Set dependency on a service. For example, if you are configuring Apache web server, you want the server to start after the network is online. This typically includes targets or other services.
• Before :- Start current service before specified service. In this example, I tell that «I want Apache web server running before the service for Nextcloud is started». This is because, in my case, Nextcloud server depends on the Apache web server. This too, like After , includes targets or other services.

The [Service] section

The Service section contains details about the execution and termination of service.

Below are the fields the Service section has:

• ExecStart :- The command that needs to be executed when the service starts. In our case, we want the Apache server to start.
• ExecReload :- This is an optional field. It specifies how a service is restarted. For services that perform disk I/O (especially writing to disk, like a database), it is best to gracefully kill them and start again. Use this field in case you wish to have a specific restart mechanism.
• Type :- This indicates the start-up type of a process for a given systemd service. Options are simple , exec , forking , oneshot , dbus , notify and idle . (more info here)
• Restart :- This is another optional field but one that you will very likely use. This specifies if a service should be restarted—depending on circumstances—or not. The available options are no , on-success , on-failure , on-abnormal , on-watchdog , on-abort and always .

The [Install] section

The Install section, as the name says, handles the installation of a systemd service/unit file. This is used when you run either systemctl enable and systemctl disable command for enabling or disabling a service.

Below are the fields the Install section has:

• WantedBy :- This is similar to the After and Before fields, but the main difference is that this is used to specify systemd-equivalent «runlevels». The default.target is when all the system initialization is complete—when the user is asked to log in. Most user-facing services (like Apache, cron, GNOME-stuff, etc.) use this target.
• RequiredBy :- This field might feel very similar to WantedBy , but the main difference is that this field specifies hard dependencies. Meaning, if a dependency, this service will fail.

What I have listed above, is only a minimal example. There are loads of knobs that you can turn to customize your service depending on your environment and needs.

For a complete documentation about systemd, please refer to this page. This literally has everything documented!

Creating your own systemd service

Now that you know the structure of a basic systemd service file let us dive into creating your own systemd service.

For this example, I will create two systemd services. One that needs superuser privileges and other that is executed as a normal user.

The primary difference between a service being executed by root and a normal user is the location of the systemd service file.

Systemd service for root user

I have written a script, that I want to run at the time of system boot, as the root user. The script is called sys-update.sh , and it’s absolute file path is /root/.scripts/sys-update.sh ; Below is the script:

#!/usr/bin/env bash if [ $ -ne 0 ] then exit 1 # this is meant to be run as root fi apt-get update 1>/dev/null 2>>/root/logs/sys-update.log

Let us first understand what this script does. First, it will check if the user is root or not. If the user is the root user, then the apt-get update command will be executed. Any errors from the output of that command will be appended to the /root/logs/sys-update.log file. And any additional output will be redirected to the /dev/null file.

Let us create a systemd service file for this. But before that is done, one must konw where to place the ‘systemd service file’ that needs superuser privileges.

Usually, it is considered a good practice to put these systemd service files inside the /etc/systemd/system/ directory.

Therefore, I will create a file update-on-boot.service ; its full path being /etc/systemd/system/update-on-boot.service . Below are the contents of this service file:

[Unit] Description=Keeping my sources fresher than Arch Linux After=multi-user.target [Service] ExecStart=/usr/bin/bash /root/.scripts/sys-update.sh Type=simple [Install] WantedBy=multi-user.target

This is a very simple systemd service file. All it does is use the bash interpreter to interpret the /root/.script/sys-update.sh script and execute it.

Enabling the service

Now that the systemd service file is ready and placed under the /etc/systemd/system/ directory, let us look at how to enable it.

To tell systemd to read our service file, we need to issue the following command:

sudo systemctl daemon-reload

Doing so will make systemd aware of our newly created systemd service file.

Now, we can enable our systemd service. The syntax to do so is as following:

sudo systemctl enable SERVICE-NAME.service

In our case, the service is named update-on-boot.service , so I will run the following command:

sudo systemctl enable update-on-boot.service

Our service is now enabled. But how can we verify that? Below is the syntax for checking the status of a systemd service:

sudo systemctl is-enabled SERVICE-NAME.service

Since the service is named update-on-boot.service , I will change it accordingly. Below is the output of checking the status of the service:

$ sudo systemctl is-enabled update-on-boot.service enabled

As the output suggests, our service— update-on-boot.service —is enabled. Whoo!

Systemd service for a normal user

Now that we just saw how to create a service that gets executed by the superuser and the process to enable it, let us do the same for a service that gets executed by a normal user.

Since the previous service starts at system start-up, let’s create a script intended to run before a shutdown. I created a script named big-uptime.sh , its full path being /home/pratham/.scripts/big-uptime.sh and following are its contents:

#!/usr/bin/env bash uptime | tee -a /home/pratham/logs/uptime.log

This is a simple script that appends the system uptime to the /home/pratham/logs/uptime.log file. A handy scoreboard!

Okay, now let’s create a systemd service file for it. But before that is done, one must know where to place a normal user’s systemd service (unit) files. Systemd service files belonging to a normal user go inside the ~/.config/systemd/user/ directory.

Usually, the ~/.config/systemd/user/ directory will not exist, so it needs to be created. Do so with the following command:

mkdir -p ~/.config/systemd/user

Now that our systemd user directory is created, let’s create a service too.

Below are the contents of my systemd service file for user pratham :

[Unit] Description=Log uptime in scoreboard DefaultDependencies=no Before=shutdown.target [Service] Type=oneshot ExecStart=/usr/bin/bash /home/pratham/.scripts/big-uptime.sh TimeoutStartSec=0 [Install] WantedBy=shutdown.target

There are a few key differences between this systemd service file and the previous ones. The biggest one being the Type of this systemd service being «oneshot«. This is best explained here, but the TL;DR is that if the Type is «oneshot«, systemd makes sure that no services are being started/stopped until our service is fully initialized or until our service has started.

I will save this systemd service file as ~/.config/systemd/user/scoreboard.service .

Enabling the service

Now that our service file is placed inside the ~/.config/systemd/user/ directory, let us enable it.

But before we enable our service, just like we did with the systemd root service, we need to reload systemd in a way that it is made aware of our newly created systemd service file. That will be done by running the following command:

systemctl --user daemon-reload

This time, we don’t need the sudo command, since we don’t need superuser privileges. But what we need is the —user option. Below is the syntax to enable a user service:

systemctl --user enable SERVICE-NAME.service

I will use the above command and modify it accordingly to enable the scoreboard.service service.

systemctl --user enable scoreboard.service

Now that the service is enabled, let’s verify it! The syntax to check the status of a systemd user service is:

systemctl --user is-enabled SERVICE-NAME.service

Using that syntax, I get the following output as the status of my service:

$ systemctl --user is-enabled scoreboard.service enabled

As evident from the output, it is verified that the systemd user service is enabled. Yayyy.

Conclusion

This article discusses some key aspects of creating your own systemd service: the anatomy of a systemd service file, where to place it, reloading systemd to make it aware of your newly created service, enabling the service and finally, checking it’s status.

Источник

What is systemd and systemctl?

systemd is a Linux initialization system and service manager. systemd provides a logging daemon and other tools and utilities to help with common system administration tasks.

Its primary component is a «system and service manager» — an init system used to bootstrap user space and manage user processes.

systemctl — is a controlling interface and inspection tool for the systemd. You use this tool to perform administrative tasks and interact with systemd.

Prerequisites:

For demo purposes use the following Vagrantfile to create an Ubuntu-based machine:

Vagrant.configure("2") do |config| # VM machine configuration config.vm.provider :virtualbox do |v| v.customize ["modifyvm", :id, "--memory", 2048] # v.customize ["modifyvm", :id, "--cpus", 2] end # Ubuntu worker node config.vm.define "ubuntu" do |ubuntu| ubuntu.vm.box = "ubuntu/bionic64" ubuntu.vm.hostname = "ubuntu" end end 

 vagrant global-status --prune 

Create custom Linux service:

 DATE=`date '+%Y-%m-%d %H:%M:%S'` echo "Custom service started at $ " | systemd-cat -p info while : do echo "Looping. "; sleep 30; done 

 sudo mv custom_service.sh /usr/bin/custom_service.sh sudo chmod +x /usr/bin/custom_service.sh 

 [Unit] Description=Custom systemd service. [Service] Type=simple ExecStart=/bin/bash /usr/bin/custom_service.sh [Install] WantedBy=multi-user.target 

 sudo mv .service /etc/systemd/system/.service sudo chmod 644 /etc/systemd/system/.service 

 sudo systemctl stop sudo systemctl restart

References:

Источник