polycubed: provide systemd integration (#177)

This commit provides an easy way to manage polycubed by using systemd.

Signed-off-by: Mauricio Vasquez B <mauriciovasquezbernal@gmail.com>

Author: mauriciovasquezbernal

Documentation/polycubed/polycubed.rst

@@ -13,6 +13,31 @@ It exposes a configuration mechanism of the different service instances through
 It requires root privileges and only an instance can be launched system wide.
 
 
+Systemd integration
+^^^^^^^^^^^^^^^^^^^
+
+``polycubed`` can be managed as a systemd service.
+
+::
+
+    # start the service
+    sudo systemctl start polycubed
+
+    # stop the service
+    sudo systemctl stop polycubed
+
+    # restart the service
+    sudo systemctl reload-or-restart polycubed
+
+    # enable the service to be started at boot time
+    sudo systemctl enable polycubed
+
+    # see service status
+    sudo systemctl status polycubed
+
+    # check logs
+    journalctl -u polycubed // '-f' can be used to see a live version
+
 Usage
 ^^^^^
 
@@ -35,7 +60,6 @@ Usage
     -h, --help: print this message
 
 
-
 Configuration file
 ^^^^^^^^^^^^^^^^^^
 

Documentation/quickstart.rst

@@ -46,15 +46,16 @@ Bare Metal
 This is a more elaborated way only recommended for advance users.
 Please the :doc:`installation guide <installation>` to get detailed information about how to compile and install ``polycube`` and its dependencies.
 
-Once you have ``polcyube`` installed in your system, you can launch ``polycubed`` (the polycube daemon):
+Once you have ``polcyube`` installed in your system, you can start the ``polycubed`` service:
 
 ::
 
-    # Launch in attached mode (you'll be able to see the log directly in te terminal)
-    sudo polycubed
-    # Launch in detached mode (logs will be saved on files)
-    sudo polycubed -d
+    # start polycubed service
+    # (sudo service start polycubed will work in many distros as well)
+    sudo systemctl start polycubed
 
+    # check service status
+    sudo systemctl status polycubed
 
 Start interacting with the framework by using ``polycubectl``. Refer to :doc:`polycubectl CLI <polycubectl/polycubectl>`.
 
@@ -63,8 +64,8 @@ Start interacting with the framework by using ``polycubectl``. Refer to :doc:`po
     polycubectl --help
 
 
-In order to stop ``polycubed`` you can press ``Ctrl+C`` on the terminal it is running (if running in attached mode). You can also send the ``SIGTERM`` signal to the process:
+To stop the ``polycubed`` service use:
 
 ::
 
-    sudo pkill -SIGTERM polycubed
+    sudo systemctl stop polycubed

src/polycubed/CMakeLists.txt

@@ -2,5 +2,6 @@ set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 add_subdirectory(src)
+add_subdirectory(systemdservice)
 
 set(CMAKE_CXX_STANDARD 11)

src/polycubed/systemdservice/CMakeLists.txt

@@ -0,0 +1,48 @@
+# Copyright (c) 2018, Intel Corporation
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+include(FindPkgConfig)
+include(GNUInstallDirs)
+
+pkg_check_modules(SYSTEMD "systemd")
+
+if (SYSTEMD_FOUND AND "${SYSTEMD_SERVICES_INSTALL_DIR}" STREQUAL "")
+    execute_process(COMMAND ${PKG_CONFIG_EXECUTABLE}
+        --variable=systemdsystemunitdir systemd
+        OUTPUT_VARIABLE SYSTEMD_SERVICES_INSTALL_DIR)
+    string(REGEX REPLACE "[ \t\n]+" "" SYSTEMD_SERVICES_INSTALL_DIR
+            "${SYSTEMD_SERVICES_INSTALL_DIR}")
+    configure_file(polycubed.service.in
+            ${CMAKE_BINARY_DIR}/polycubed.service
+            @ONLY)
+    install(FILES ${CMAKE_BINARY_DIR}/polycubed.service DESTINATION
+            ${SYSTEMD_SERVICES_INSTALL_DIR} COMPONENT cp)
+
+elseif (NOT SYSTEMD_FOUND AND SYSTEMD_SERVICES_INSTALL_DIR)
+    message (FATAL_ERROR "Variable SYSTEMD_SERVICES_INSTALL_DIR is\
+        defined, but we can't find systemd using pkg-config")
+endif()
+
+if (SYSTEMD_FOUND)
+    set(WITH_SYSTEMD "ON")
+    message(STATUS "systemd services install dir: ${SYSTEMD_SERVICES_INSTALL_DIR}")
+else()
+    set(WITH_SYSTEMD "OFF")
+endif (SYSTEMD_FOUND)

src/polycubed/systemdservice/polycubed.service.in

@@ -0,0 +1,9 @@
+[Unit]
+Description=polycube service
+
+[Service]
+Type=simple
+ExecStart=@CMAKE_INSTALL_FULL_BINDIR@/polycubed
+
+[Install]
+WantedBy=multi-user.target