From 1ef4420c537570206780757fa5b78aa6895f5829 Mon Sep 17 00:00:00 2001
From: Matthias Stecher <matthiasstecher@gmx.de>
Date: Thu, 27 Aug 2020 19:46:09 +0200
Subject: [PATCH] __netbox_uwsgi: new type to handle uwsgi for netbox

---
 type/__netbox/gencode-remote                  |  2 +-
 type/__netbox/man.rst                         |  2 +-
 type/__netbox_gunicorn/gencode-remote         |  5 +-
 type/__netbox_gunicorn/man.rst                |  2 +-
 type/__netbox_uwsgi/explorer/installed        |  4 +
 type/__netbox_uwsgi/explorer/upgradeable      |  4 +
 type/__netbox_uwsgi/files/netbox.service      | 23 ++++++
 type/__netbox_uwsgi/files/uwsgi.ini.sh        | 22 ++++++
 type/__netbox_uwsgi/gencode-remote            | 35 +++++++++
 type/__netbox_uwsgi/man.rst                   | 75 +++++++++++++++++++
 type/__netbox_uwsgi/manifest                  | 18 +++++
 type/__netbox_uwsgi/parameter/default/bind-to |  1 +
 .../parameter/optional_multiple               |  1 +
 13 files changed, 188 insertions(+), 6 deletions(-)
 create mode 100755 type/__netbox_uwsgi/explorer/installed
 create mode 100755 type/__netbox_uwsgi/explorer/upgradeable
 create mode 100644 type/__netbox_uwsgi/files/netbox.service
 create mode 100755 type/__netbox_uwsgi/files/uwsgi.ini.sh
 create mode 100755 type/__netbox_uwsgi/gencode-remote
 create mode 100644 type/__netbox_uwsgi/man.rst
 create mode 100755 type/__netbox_uwsgi/manifest
 create mode 100644 type/__netbox_uwsgi/parameter/default/bind-to
 create mode 100644 type/__netbox_uwsgi/parameter/optional_multiple

diff --git a/type/__netbox/gencode-remote b/type/__netbox/gencode-remote
index af4d8c8..0153579 100755
--- a/type/__netbox/gencode-remote
+++ b/type/__netbox/gencode-remote
@@ -89,7 +89,7 @@ EOF
     fi
 
     # meta
-    printf "configuration\n" >> "$__messages_out"
+    printf "configured\n" >> "$__messages_out"
     changes=yes
 fi
 
diff --git a/type/__netbox/man.rst b/type/__netbox/man.rst
index 2af2bef..6bb1e36 100644
--- a/type/__netbox/man.rst
+++ b/type/__netbox/man.rst
@@ -176,7 +176,7 @@ MESSAGES
 installed $VERSION
     Netbox was fresh installed or updated. The new version number is appended.
 
-configuration
+configured
     Some configuration files got updated and therefore the service was
     restarted. This message will not be echoed if configuration got updated due
     a standard installation.
diff --git a/type/__netbox_gunicorn/gencode-remote b/type/__netbox_gunicorn/gencode-remote
index 6958976..e424c22 100755
--- a/type/__netbox_gunicorn/gencode-remote
+++ b/type/__netbox_gunicorn/gencode-remote
@@ -16,7 +16,7 @@ fi
 # configuration changes
 if grep -q "^__file/opt/netbox/gunicorn.py:" "$__messages_in"; then
     do_restart=yes
-    printf "configuration\n" >> "$__messages_out"
+    printf "configured\n" >> "$__messages_out"
 fi
 
 # application
@@ -27,10 +27,9 @@ fi
 
 
 # restart gunicorn
-if [ "$do_restart"]; then
+if [ "$do_restart" ]; then
     cat << EOF
 # Restart service
 service gunicorn-netbox restart
 EOF
-    echo restarted >> "$__messages_out"
 fi
diff --git a/type/__netbox_gunicorn/man.rst b/type/__netbox_gunicorn/man.rst
index 38ac4a5..43f5864 100644
--- a/type/__netbox_gunicorn/man.rst
+++ b/type/__netbox_gunicorn/man.rst
@@ -34,7 +34,7 @@ MESSAGES
 updated $old to $new
     The version of the gunicorn software was updated from `$old` to `$new`.
 
-configuration
+configured
     Configuration for gunicorn changed.
 
 In both cases, and at messages from the `__netbox` type, it restarts the
diff --git a/type/__netbox_uwsgi/explorer/installed b/type/__netbox_uwsgi/explorer/installed
new file mode 100755
index 0000000..a2393d0
--- /dev/null
+++ b/type/__netbox_uwsgi/explorer/installed
@@ -0,0 +1,4 @@
+#!/bin/sh -e
+
+# print version if available
+/opt/netbox/venv/bin/pip3 show uwsgi | awk '/Version:/{print $2}'
diff --git a/type/__netbox_uwsgi/explorer/upgradeable b/type/__netbox_uwsgi/explorer/upgradeable
new file mode 100755
index 0000000..f4b0a22
--- /dev/null
+++ b/type/__netbox_uwsgi/explorer/upgradeable
@@ -0,0 +1,4 @@
+#!/bin/sh -e
+
+# print latest version if availble
+/opt/netbox/venv/bin/pip3 list --outdated | awk '$1 == "uwsgi" {print $3}'
diff --git a/type/__netbox_uwsgi/files/netbox.service b/type/__netbox_uwsgi/files/netbox.service
new file mode 100644
index 0000000..cfce752
--- /dev/null
+++ b/type/__netbox_uwsgi/files/netbox.service
@@ -0,0 +1,23 @@
+[Unit]
+Description=Netbox uWSGI WSGI Service
+Documentation=https://netbox.readthedocs.io/en/stable/
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+Type=simple
+
+User=netbox
+Group=netbox
+PIDFile=/var/tmp/netbox.pid
+WorkingDirectory=/opt/netbox
+
+ExecStart=/opt/netbox/venv/bin/uwsgi --master --wsgi-file netbox/netbox/wsgi.py uwsgi.ini
+
+Restart=on-failure
+RestartSec=30
+PrivateTmp=true
+
+[Install]
+Alias=netbox.service
+WantedBy=multi-user.target
diff --git a/type/__netbox_uwsgi/files/uwsgi.ini.sh b/type/__netbox_uwsgi/files/uwsgi.ini.sh
new file mode 100755
index 0000000..557a5fa
--- /dev/null
+++ b/type/__netbox_uwsgi/files/uwsgi.ini.sh
@@ -0,0 +1,22 @@
+#!/bin/sh -e
+
+# Generates uwsgi config
+# see https://uwsgi-docs.readthedocs.io/en/latest/Options.html
+
+# fix missing $__explorer
+# see https://code.ungleich.ch/ungleich-public/cdist/-/issues/834
+__explorer="$__global/explorer"
+
+# size workes by cpu
+cores="$(cat "$__explorer/cpu_cores")"
+
+
+cat << EOF
+[uwsgi]
+; socket to bind
+socket = $HOST
+
+; processes and threads
+processes = $(( 2*cores + 1 ))
+threads = 2
+EOF
diff --git a/type/__netbox_uwsgi/gencode-remote b/type/__netbox_uwsgi/gencode-remote
new file mode 100755
index 0000000..5cc82d1
--- /dev/null
+++ b/type/__netbox_uwsgi/gencode-remote
@@ -0,0 +1,35 @@
+#!/bin/sh -e
+
+# not installed
+if ! [ -s "$__object/explorer/installed" ]; then
+    echo "/opt/netbox/venv/bin/pip3 install uwsgi"
+    do_restart=yes
+    printf "installed\n" >> "$__messages_out"
+
+# updates available
+elif [ -s "$__object/explorer/upgradeable" ]; then
+    echo "/opt/netbox/venv/bin/pip3 install --upgrade uwsgi"
+    do_restart=yes
+    printf "upgraded\n" >> "$__messages_out"
+fi
+
+# changed configuration
+if grep -q "^__file/opt/netbox/uwsgi.ini:" "$__messages_in"; then
+    do_restart=yes
+    printf "configured\n" >> "$__messages_out"
+fi
+
+# application
+if grep -q "^__netbox:" "$__messages_in"; then
+    do_restart=yes
+    # no messages cause this is obvious
+fi
+
+
+# restart uwsgi
+if [ "$do_restart" ]; then
+    cat << EOF
+# Restart service
+service uwsgi-netbox restart
+EOF
+fi
diff --git a/type/__netbox_uwsgi/man.rst b/type/__netbox_uwsgi/man.rst
new file mode 100644
index 0000000..5bf3160
--- /dev/null
+++ b/type/__netbox_uwsgi/man.rst
@@ -0,0 +1,75 @@
+cdist-type__netbox_uwsgi(7)
+===========================
+
+NAME
+----
+cdist-type__netbox_uwsgi - run netbox with uwsgi
+
+
+DESCRIPTION
+-----------
+This space intentionally left blank.
+
+
+REQUIRED PARAMETERS
+-------------------
+None.
+
+
+OPTIONAL PARAMETERS
+-------------------
+bind-to
+    The socket uwsgi should bind to. Must be UNIX/TCP for the uwsgi protocol.
+    Defaults to ``127.0.0.1:3031``.
+
+
+BOOLEAN PARAMETERS
+------------------
+None.
+
+
+MESSAGES
+--------
+installed
+    The uwsgi service was installed.
+
+upgraded
+    The uwsgi service was upgraded.
+
+configured
+    The uwsgi configuration got updated.
+
+In both cases, and at messages from the `__netbox` type, it restarts the
+service to using the up-to-date version.
+
+
+EXAMPLES
+--------
+
+.. code-block:: sh
+
+    # simple
+    __netbox $args
+    require="__netbox" __netbox_uwsgi
+
+    # with special bind
+    require="__netbox" __netbox_uwsgi --bind-to 0.0.0.0:3032 \
+                                      --bind-to 0.0.0.0:3033
+
+
+SEE ALSO
+--------
+:strong:`TODO`\ (7)
+
+
+AUTHORS
+-------
+Matthias Stecher <matthiasstecher@gmx.de>
+
+
+COPYING
+-------
+Copyright \(C) 2020 Matthias Stecher. You can redistribute it
+and/or modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
diff --git a/type/__netbox_uwsgi/manifest b/type/__netbox_uwsgi/manifest
new file mode 100755
index 0000000..779f93b
--- /dev/null
+++ b/type/__netbox_uwsgi/manifest
@@ -0,0 +1,18 @@
+#!/bin/sh -e
+
+HOST="$__object/parameter/bind-to"
+export HOST
+
+# process template
+mkdir "$__object/files"
+"$__type/files/uwsgi.ini.sh" > "$__object/files/uwsgi.ini"
+
+# uwsgi config file
+# TODO maybe patching with __key_value cause of .ini ?
+__file /opt/netbox/uwsgi.ini \
+    --mode 644 --source "$__object/files/uwsgi.ini"
+
+# install service file
+__systemd_unit uwsgi-netbox.service \
+    --source "$__type/files/netbox.service" \
+    --enablement-state enabled --restart
diff --git a/type/__netbox_uwsgi/parameter/default/bind-to b/type/__netbox_uwsgi/parameter/default/bind-to
new file mode 100644
index 0000000..c696456
--- /dev/null
+++ b/type/__netbox_uwsgi/parameter/default/bind-to
@@ -0,0 +1 @@
+127.0.0.1:3031
diff --git a/type/__netbox_uwsgi/parameter/optional_multiple b/type/__netbox_uwsgi/parameter/optional_multiple
new file mode 100644
index 0000000..331c077
--- /dev/null
+++ b/type/__netbox_uwsgi/parameter/optional_multiple
@@ -0,0 +1 @@
+bind-to