feat(worker): rename service and package to libretime-worker (#2065)

BREAKING CHANGE: The `libretime-celery` python package and service was renamed to `libretime-worker`. Make sure to remove the old python package and service.

docs/admin-manual/setup/configuration.md

@@ -31,10 +31,10 @@ general:
 In order to apply the changes made in this section, please restart the following services:
 
 ```
-libretime-api
 libretime-analyzer
-libretime-celery
+libretime-api
 libretime-playout
+libretime-worker
 ```
 
 ## Database
@@ -110,10 +110,10 @@ rabbitmq:
 In order to apply the changes made in this section, please restart the following services:
 
 ```
-libretime-api
 libretime-analyzer
-libretime-celery
+libretime-api
 libretime-playout
+libretime-worker
 ```
 
 ## Playout

docs/admin-manual/setup/upgrade.md

@@ -20,9 +20,9 @@ sudo systemctl stop libretime.target
 # Or
 sudo systemctl stop libretime-analyzer.service
 sudo systemctl stop libretime-api.service
-sudo systemctl stop libretime-celery.service
 sudo systemctl stop libretime-liquidsoap.service
 sudo systemctl stop libretime-playout.service
+sudo systemctl stop libretime-worker.service
 ```
 
 ## Make a backup

docs/admin-manual/troubleshooting.md

@@ -23,7 +23,7 @@ If a service isn't running, you should search for details using the tool running
 On a common setup, you should use the systemd service status:
 
 ```bash
-sudo systemctl status libretime-celery
+sudo systemctl status libretime-worker
 ```
 
 :::note
@@ -51,6 +51,7 @@ On a common setup, to access LibreTime specific logs you should search for the f
 - The `/var/log/libretime/legacy.log` file contains logs from the legacy app,
 - The `/var/log/libretime/liquidsoap.log` file contains logs from liquidsoap,
 - The `/var/log/libretime/playout.log` file contains logs from playout.
+- The `/var/log/libretime/worker.log` file contains logs from the worker.
 
 For some LibreTime services, you can set a higher log level using the `LIBRETIME_LOG_LEVEL` environment variable, or by running the service by hand and using a command line flag:
 

docs/admin-manual/uninstall.md

@@ -78,9 +78,10 @@ sudo pip3 uninstall \
     libretime-analyzer \
     libretime-api \
     libretime-api-client \
+    libretime-celery \
     libretime-playout \
     libretime-shared \
-    libretime-celery
+    libretime-worker
 
 # Check if we forgot old python packages.
 # Remove packages that show up with this commands.

docs/releases/unreleased.md

@@ -38,6 +38,18 @@ Along with the Debian Buster deprecation, the following dependencies versions ar
 
 ## :arrow_up: Upgrading
 
+### Worker python package and service
+
+The `libretime-celery` python package and service was renamed to `libretime-worker`. Make sure to remove the old python package and service using the following command:
+
+```bash
+sudo pip3 uninstall libretime-celery
+
+sudo rm -f \
+    /etc/systemd/system/libretime-celery.service \
+    /usr/lib/systemd/system/libretime-celery.service
+```
+
 ## :warning: Known issues
 
 The following issues may need a workaround for the time being. Please search the [issues](https://github.com/libretime/libretime/issues) before reporting problems not listed below.

install

@@ -591,10 +591,10 @@ section "Worker"
 
 install_python_app "$SCRIPT_DIR/worker"
 
-info "creating libretime-celery working directory"
+info "creating libretime-worker working directory"
 mkdir_and_chown "$LIBRETIME_USER" "$WORKING_DIR/worker"
 
-install_service "libretime-celery.service" "$SCRIPT_DIR/worker/install/systemd/libretime-celery.service"
+install_service "libretime-worker.service" "$SCRIPT_DIR/worker/install/systemd/libretime-worker.service"
 
 # Install Legacy
 ########################################################################################

installer/systemd/libretime.target

@@ -2,9 +2,9 @@
 Description=LibreTime Services
 Wants=libretime-analyzer.service
 Wants=libretime-api.service
-Wants=libretime-celery.service
 Wants=libretime-liquidsoap.service
 Wants=libretime-playout.service
+Wants=libretime-worker.service
 
 [Install]
 WantedBy=multi-user.target

legacy/application/check.php

@@ -150,13 +150,13 @@ function checkLiquidsoapService()
 }
 
 /**
- * Check if libretime-celery is currently running.
+ * Check if libretime-worker is currently running.
  *
- * @return bool true if libretime-celery is running
+ * @return bool true if libretime-worker is running
  */
 function checkCeleryService()
 {
-    exec('systemctl is-active libretime-celery --quiet', $out, $status);
+    exec('systemctl is-active libretime-worker --quiet', $out, $status);
 
     return $status == 0;
 }

legacy/application/configs/config-check.php

@@ -243,10 +243,10 @@ $result = $r1 && $r2;
                         <?php
                     } else {
                         ?>">
-                        <?php echo _('Check that the libretime-celery service is installed correctly in '); ?><code>/etc/systemd/system/</code>,
+                        <?php echo _('Check that the libretime-worker service is installed correctly in '); ?><code>/etc/systemd/system/</code>,
                         <?php echo _(" and ensure that it's running with "); ?>
-                        <br /><code>systemctl status libretime-celery</code><br />
-                        <?php echo _('If not, try '); ?><br /><code>sudo systemctl restart libretime-celery</code>
+                        <br /><code>systemctl status libretime-worker</code><br />
+                        <?php echo _('If not, try '); ?><br /><code>sudo systemctl restart libretime-worker</code>
                     <?php
                     }
                     ?>

legacy/application/views/scripts/systemstatus/index.phtml

@@ -169,10 +169,10 @@ $result = $r1 && $r2;
                 <?php
                                 } else {
                 ?>">
-                <?php echo _("Check that the libretime-celery service is installed correctly in ") ?><code>/etc/systemd/system/</code>,
+                <?php echo _("Check that the libretime-worker service is installed correctly in ") ?><code>/etc/systemd/system/</code>,
                 <?php echo _(" and ensure that it's running with ") ?>
-                <br /><code>systemctl status libretime-celery</code><br />
-                <?php echo _("If not, try ") ?><br /><code>sudo systemctl restart libretime-celery</code>
+                <br /><code>systemctl status libretime-worker</code><br />
+                <?php echo _("If not, try ") ?><br /><code>sudo systemctl restart libretime-worker</code>
             <?php
                                 }
             ?>

worker/setup.py

@@ -1,9 +1,9 @@
 from setuptools import find_packages, setup
 
 setup(
-    name="libretime-celery",
+    name="libretime-worker",
     version="0.1",
-    description="LibreTime Celery",
+    description="LibreTime Worker",
     author="LibreTime Contributors",
     url="https://github.com/libretime/libretime",
     project_urls={