Systemd service improvements

README.md

@@ -119,6 +119,7 @@ PyHSS uses a queued microservices model. Each service performs a specific set of
 
 The following services make up PyHSS:
  - diameterService.py: Handles receiving and sending of diameter messages, and diameter client connection state.
+ - gsupService.py: Handles receiving and sending of GSUP messages to interact with 2G/3G Osmocom components.
  - hssService.py: Provides decoding and encoding of diameter requests and responses, as well as logic to perform as a HSS.
  - apiService.py: Provides the API, to allow management of PyHSS.
  - georedService.py: Sends georaphic redundancy messages to geored peers when defined. Also handles webhook messages.

debian/pyhss.install

@@ -3,6 +3,7 @@
 # * pyhss_geored.service: disabled in the default config
 # * pyhss_log.service: using systemd's journal instead
 # * pyhss.service: meta-service making assumptions about what services are used
+/systemd/pyhss_api.service /lib/systemd/system/
 /systemd/pyhss_diameter.service /lib/systemd/system/
 /systemd/pyhss_gsup.service /lib/systemd/system/
 /systemd/pyhss_hss.service /lib/systemd/system/

systemd/pyhss.service

@@ -1,3 +1,7 @@
+# Legacy meta-service with possibly outdated assumptions on which database
+# (mysql, default is now sqlite and postgres is also supported) and services
+# (log and geored are typically not needed) are being used. Consider running
+# individual services that you actually want to have in your setup instead.
 [Unit]
 Description=PyHSS
 After=network-online.target mysql.service

systemd/pyhss_api.service

@@ -1,6 +1,9 @@
+# Optional HTTP server providing an API for managing PyHSS.
 [Unit]
 Description=PyHSS API Service
 After=network.target
+Requires=pyhss_hss.service
+After=pyhss_hss.service
 
 [Service]
 Environment="PYTHONUNBUFFERED=1"

systemd/pyhss_database.service

@@ -1,3 +1,5 @@
+# Optional legacy service that may get removed in the future:
+# https://github.com/nickvsnetworking/pyhss/issues/264
 [Unit]
 Description=PyHSS Database Service
 PartOf=pyhss.service

systemd/pyhss_diameter.service

@@ -1,6 +1,10 @@
+# Handling of receiving and sending of diameter messages, and diameter client
+# connection state.
 [Unit]
 Description=PyHSS Diameter Service
 PartOf=pyhss.service
+Requires=pyhss_hss.service
+After=pyhss_hss.service
 
 [Service]
 Environment="PYTHONUNBUFFERED=1"

systemd/pyhss_geored.service

@@ -1,3 +1,5 @@
+# Optional geographic redundancy service that may get removed in the future:
+# https://github.com/nickvsnetworking/pyhss/issues/334
 [Unit]
 Description=PyHSS Geored Service
 PartOf=pyhss.service

systemd/pyhss_gsup.service

@@ -1,6 +1,9 @@
+# Optional GSUP message handler for interacting with 2G/3G Osmocom components.
 [Unit]
 Description=PyHSS GSUP Service
 PartOf=pyhss.service
+Requires=pyhss_hss.service
+After=pyhss_hss.service
 
 [Service]
 Environment="PYTHONUNBUFFERED=1"

systemd/pyhss_hss.service

@@ -1,6 +1,11 @@
+# The main PyHSS service: Initializes the database, provides decoding and
+# encoding of diameter requests and responses, as well as logic to perform as a
+# HSS.
 [Unit]
 Description=PyHSS HSS Service
 PartOf=pyhss.service
+Requires=redis-server.service
+After=redis-server.service
 
 [Service]
 Environment="PYTHONUNBUFFERED=1"

systemd/pyhss_log.service

@@ -1,3 +1,5 @@
+# Optional service for writing to log files. Consider reading logs through
+# journalctl instead.
 [Unit]
 Description=PyHSS Log Service
 PartOf=pyhss.service

systemd/pyhss_metric.service

@@ -1,6 +1,9 @@
+# Optional service for exposing prometheus metrics.
 [Unit]
 Description=PyHSS Metric Service
 PartOf=pyhss.service
+Requires=pyhss_hss.service
+After=pyhss_hss.service
 
 [Service]
 Environment="PYTHONUNBUFFERED=1"