From 54215bab6c1c420bc284160c6c4633e0ab2e8ff2 Mon Sep 17 00:00:00 2001
From: "Joshua M. Boniface" <joshua@boniface.me>
Date: Sat, 4 Nov 2023 12:46:34 -0400
Subject: [PATCH] Switch to ZK+PG over Redis for Celery queue

Redis did not provide a distributed solution for the worker, which
precluded several important planned functions. So instead, move to using
Zookeeper + PostgreSQL as the broker and result backend respectively.

Should be a seamless drop-in change but for future uses requires the
database host to be the primary coordinator IP rather than localhost, so
that writes can occur to the database from non-primary hosts.
---
 api-daemon/pvcapid.sample.yaml | 12 ++----------
 api-daemon/pvcapid/Daemon.py   |  3 ---
 api-daemon/pvcapid/flaskapi.py | 25 +++++++++++++++++++++----
 debian/control                 |  2 +-
 4 files changed, 24 insertions(+), 18 deletions(-)

diff --git a/api-daemon/pvcapid.sample.yaml b/api-daemon/pvcapid.sample.yaml
index e8fadf90..4d280c78 100644
--- a/api-daemon/pvcapid.sample.yaml
+++ b/api-daemon/pvcapid.sample.yaml
@@ -45,8 +45,8 @@ pvc:
     provisioner:
         # database: Backend database configuration
         database:
-            # host: PostgreSQL hostname, usually 'localhost'
-            host: localhost
+            # host: PostgreSQL hostname, the primary coordinator floating IP in the cluster network
+            host: pvchvP
             # port: PostgreSQL port, invariably '5432'
             port: 5432
             # name: PostgreSQL database name, invariably 'pvcapi'
@@ -55,14 +55,6 @@ pvc:
             user: pvcapi
             # pass: PostgreSQL user password, randomly generated
             pass: pvcapi
-        # queue: Celery backend queue using the PVC Zookeeper cluster
-        queue:
-            # host: Redis hostname, usually 'localhost'
-            host: localhost
-            # port: Redis port, invariably '6279'
-            port: 6379
-            # path: Redis queue path, invariably '/0'
-            path: /0
         # ceph_cluster: Information about the Ceph storage cluster
         ceph_cluster:
             # storage_hosts: The list of hosts that the Ceph monitors are valid on; if empty (the default),
diff --git a/api-daemon/pvcapid/Daemon.py b/api-daemon/pvcapid/Daemon.py
index 2429d98a..6e763465 100755
--- a/api-daemon/pvcapid/Daemon.py
+++ b/api-daemon/pvcapid/Daemon.py
@@ -90,9 +90,6 @@ try:
         "database_name": o_config["pvc"]["provisioner"]["database"]["name"],
         "database_user": o_config["pvc"]["provisioner"]["database"]["user"],
         "database_password": o_config["pvc"]["provisioner"]["database"]["pass"],
-        "queue_host": o_config["pvc"]["provisioner"]["queue"]["host"],
-        "queue_port": o_config["pvc"]["provisioner"]["queue"]["port"],
-        "queue_path": o_config["pvc"]["provisioner"]["queue"]["path"],
         "storage_hosts": o_config["pvc"]["provisioner"]["ceph_cluster"][
             "storage_hosts"
         ],
diff --git a/api-daemon/pvcapid/flaskapi.py b/api-daemon/pvcapid/flaskapi.py
index 795db33a..fee4933a 100755
--- a/api-daemon/pvcapid/flaskapi.py
+++ b/api-daemon/pvcapid/flaskapi.py
@@ -38,12 +38,27 @@ from flask_sqlalchemy import SQLAlchemy
 
 # Create Flask app and set config values
 app = flask.Flask(__name__)
-app.config["CELERY_BROKER_URL"] = "redis://{}:{}{}".format(
-    config["queue_host"], config["queue_port"], config["queue_path"]
+
+# Set up Celery queue
+# Default Zookeeper port; not configurable
+queue_port = 2181
+# Default Zookeeper path, not configurable
+queue_path = "/apibroker"
+# Join the coordinator hostnames with the queue port, semicolon separated for Celery
+queue_hostport_pairs = ";".join([f"{h}:{queue_port}" for h in config["coordinators"]])
+app.config["CELERY_BROKER_URL"] = "zookeeper://{}{}".format(
+    queue_hostport_pairs, queue_path
 )
-app.config["CELERY_RESULT_BACKEND"] = "redis://{}:{}{}".format(
-    config["queue_host"], config["queue_port"], config["queue_path"]
+app.config["CELERY_RESULT_BACKEND"] = "db+postgresql://{}:{}@{}:{}/{}".format(
+    config["database_user"],
+    config["database_password"],
+    config["database_host"],
+    config["database_port"],
+    config["database_name"],
 )
+app.config.database_engine_options = {"echo": True}
+
+# Set up SQLAlchemy backend
 app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
 app.config["SQLALCHEMY_DATABASE_URI"] = "postgresql://{}:{}@{}:{}/{}".format(
     config["database_user"],
@@ -53,11 +68,13 @@ app.config["SQLALCHEMY_DATABASE_URI"] = "postgresql://{}:{}@{}:{}/{}".format(
     config["database_name"],
 )
 
+# Set up debugging
 if config["debug"]:
     app.config["DEBUG"] = True
 else:
     app.config["DEBUG"] = False
 
+# Set up authentication
 if config["auth_enabled"]:
     app.config["SECRET_KEY"] = config["auth_secret_key"]
 
diff --git a/debian/control b/debian/control
index 26edb9ac..b5a26545 100644
--- a/debian/control
+++ b/debian/control
@@ -16,7 +16,7 @@ Description: Parallel Virtual Cluster node daemon (Python 3)
 
 Package: pvc-daemon-api
 Architecture: all
-Depends: systemd, pvc-daemon-common, python3-yaml, python3-flask, python3-flask-restful, python3-celery, python-celery-common, python3-distutils, redis, python3-redis, python3-lxml, python3-flask-migrate, fio
+Depends: systemd, pvc-daemon-common, python3-yaml, python3-flask, python3-flask-restful, python3-celery, python-celery-common, python3-distutils, python3-lxml, python3-flask-migrate, fio
 Description: Parallel Virtual Cluster API daemon (Python 3)
  A KVM/Zookeeper/Ceph-based VM and private cloud manager
  .