First version of the uffd collection

Signed-off-by: Nis Wechselberg <enbewe@enbewe.de>

roles/build/defaults/main.yml

@@ -0,0 +1,7 @@
+---
+uffd_build_tempdir: '/tmp/podman-uffd-build'
+# We build with Debian bullseye, even though bookworm is out.
+# uffd throws some errors with bookworm python, so some programs fail
+uffd_build_debian_version: 'bullseye'
+uffd_build_force_rebuild: false
+uffd_build_tag_latests: true

roles/build/files/cccv-archive-key.asc

@@ -0,0 +1,41 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQGNBGEXIFwBDADRhAYP8td+AVcnbMkswu3SaF1FzqVldwQSHA0tVXpAw7wUtE9s
+QEnbLE3cD//SEMQGzwr8LsMpnuWImcS5nk9gIc5p9M076tgyAeS4NFzbvaIpOZJL
+V0VK2Q+o6fyaAriY5lb88pU3cR6uTJInwR5MgEki7RLCIjOPW/Nzvw8LdBhgtbJv
+jW04IPI1gAiqSfPCjXY8z81JOSLhsk1ED8zrJ/kTWm4yIBbVLMhFu7Snz9UbbF2n
+40dA9VydoxlVdjzH+AM7+Ga8FTYu4UivGO+5WFp+iWcoXLqmECSvW+H+Evy8ES9M
+7QIkgGTXWsL3YrjrxcwOAu/dXhQVV9woDXWWQRwILNG2poSLUjmVuXMPKnofJpMO
+34+n3dvaiPTp31YxTWhOSXdbO3e6Abpd+PKoXqaRy/HrulBuBRf+5/edDKLNVUC/
+tPqs61AL9cw6Jxx1vFdmmZm6RWK2CgVWPc9e3GPGfbZYuUBgOphhkJ+3yXRcc1sN
+VRyc3Ve87OG6GiUAEQEAAbQgcGFja2FnZXMuY2Njdi5kZSA8aW5mcmFAY2Njdi5k
+ZT6JAdQEEwEIAD4CGwMFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AWIQRVPlzDYknN
+/1ubu7WpKBpvpuSJcQUCZPjPbAUJDUdK5QAKCRCpKBpvpuSJcVuFC/45TV/8Dvt8
+VTS2yoFUjpy0las7qm0fPNkazSVpMhQkxcEz/LysEr5sbc0jZIQZ1zD+rm0RfahM
+g7vytTs/xqplgmIXOEPub6CPr+G1ZHgU5pHAc2DqFUR4z3pp37RNtFuhi0TyK0Pp
+qVJgAg6/Hf9dkEIwI5orUTTDWhAvxz7wo7/3tb4fqkrWk/Fp0qM8kMEjYyh9/PSb
+V4HfhJauXxzBx8T/Wc7TveGyRGVMYH29bK0SssDDvzGJD3Mxd/dXV4JYTk8sw//k
+zQwN3lZ7SfsZR5rddRr/BpghdR1k451FdCj9iWF3v3p1TwN93AL6TQ6AF2aFykkB
+1JWxockDlGrlRkk+0WiEOYvDUaBo3ppz4QhrO8TFrluGyifv2BNSFMKHdhkvF2IE
+DRQles45+CmhgPxVw7qc69pLsXRxN/0BE5P6wNl8DGnk2ZYDlYW/vcosHYbeeRCp
+OUpsKF6OSHXjCfMObuG6wYulFhMqrDHtLiD0e6fxWjATqoj+F6TX7Te5AY0EYRcg
+XAEMAKNhLd8nN2AYPdqn/9OfTzXOFEoHMGFKVH9E9LRFEp7SXI0Phr+2gPsBEP13
+In0dGbvABRvywtTRih+3Jg/5QxyEDcVB0bbWK44XZLmShm9TYmJSqrW8sgOh2Nqi
+2LcGroWg2crrd6t+HDmXFZVtiBRy/5Y7s5mqTM/byEvMnReczeTSlwmJHNLTOmME
+tganIwmQxfbit99gxjjoz/sGqVxf59/Ytq8P6J+3LMt9ApmPFgK6wB0BAtTJGaOJ
+rgSIVdNQ082laXQlHXKMguVKk8ivErzwsCs7ukxSVhIvfwgbM7WZfdM7l6h1ZhDr
+mBBGGj+9Ag0mPHF3ycrh9fW43r8KYONbzQq0xtsE+WeOKPaFhMQ/dwv6d4Sn0gTV
+crV++l6ut1DLlGHCZtSsB0z1LBUu4jMvpHwVfCeqZ4f5Al27oUhjTh3eoe184+VG
+/M3nkh9C1wyvLBFo69AS+9VQSwnsWu/CXnWrzPZeX0KmbezNeNvwCbYgXIrEEWhy
+XJgYLQARAQABiQG8BBgBCAAmAhsMFiEEVT5cw2JJzf9bm7u1qSgab6bkiXEFAmT4
+z18FCQ1HSukACgkQqSgab6bkiXFVagv+LFrGoHKm4woVvlWHWfanok/YsPyGFsvL
+Ogz6U0nhRB5f3wSq9kl0t1esdyNsFGfz+E0fCzyAyML6dBzKv9uHp2+TtcdKLTQ1
+kSo/JdbMsva+/e8Y9OHmmv7pAFatLln7XXwa2cPiFRg0VkOQgByR1yEiGAyMIYL8
+VLAqdE6fywGLXE5k91+XZCFqKu90+XrtiJo2xy4RQ8C5u2WQWI0k5V/oGgTxOh/J
+uhXzmU1Goeie4ukjZYdzwZjzzm2vY9LWfZRaRtkJ0itxNezYCtWEOKHvto5PqtT4
+thSsNuC9qQruh3itVykI7lZ9yxkOyuzqjFGKQDNcUlvnZHqdoKuW121/cgMXbAvz
+HWHdY4cbc74obm8V8Gx4dX/GNFL868twzMVoBoEgQVA1PURz5Xu73RvWcBpOpYj0
+GP3nLdP3s2J9rAhrzS6K+MIHeEUnPi1MavRd4bROpnbJ32yvkSGWR55mWCpdCepj
+JRWMzY9EoBOHB1PubZuzUNIUQeui1vyX
+=uRc5
+-----END PGP PUBLIC KEY BLOCK-----

roles/build/files/entrypoint.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+
+echo "Copying static files ..."
+cp -r /usr/share/uffd/uffd/static /var/www/uffd
+
+db_ready="false"
+count=0
+while [ $count -lt 4 ] && [ "$db_ready" != "true" ] ;do
+  if uffd-admin db current >> /dev/null 2>&1 ;then
+    db_ready="true"
+  else
+    echo "Waiting for db to become ready..."
+    ((duration=2**$count))
+    sleep $duration
+    ((count=$count+1))
+  fi
+done
+
+if [ "$db_ready" == "true" ] ;then
+  echo "Running datbase migrations ..."
+  uffd-admin db upgrade
+
+  if [ -n "$UFFD_INITIAL_ADMIN_PW" ] && [ "$(uffd-admin user list)" == "" ]; then
+    echo "Creating groups and roles for initial admin user ..."
+    if ! uffd-admin group show 'uffd_admin' >> /dev/null 2>&1 ;then
+      uffd-admin group create 'uffd_admin'
+    fi
+    if ! uffd-admin group show 'uffd_access' >> /dev/null 2>&1 ;then
+      uffd-admin group create 'uffd_access'
+    fi
+    if ! uffd-admin role show 'uffd_admin' >> /dev/null 2>&1 ;then
+      uffd-admin role create 'uffd_admin' --add-group 'uffd_admin' --add-group 'uffd_access'
+    fi
+    if [ -z "$UFFD_INITIAL_ADMIN_USER" ] ;then
+      UFFD_INITIAL_ADMIN_USER='uffd_admin'
+    fi
+    if [ -z "$UFFD_INITIAL_ADMIN_MAIL" ] ;then
+      UFFD_INITIAL_ADMIN_MAIL='uffd_admin@localhost'
+    fi
+    echo "Creating initial admin user ..."
+    uffd-admin user create "$UFFD_INITIAL_ADMIN_USER" --password "$UFFD_INITIAL_ADMIN_PW" --mail "$UFFD_INITIAL_ADMIN_MAIL" --add-role 'uffd_admin'
+  fi
+else
+  echo "WARNING: Database is not ready yet, skipping migration and initialization"
+fi
+
+echo "Starting server ..."
+runuser --preserve-environment -u uffd -- \
+ uwsgi --ini /etc/uwsgi/apps-enabled/uffd.ini --socket 0.0.0.0:3031 --master --stats 0.0.0.0:9191

roles/build/tasks/main.yml

@@ -0,0 +1,74 @@
+---
+- name: 'Install required software'
+  become: true
+  ansible.builtin.apt:
+    name: 'podman'
+    state: 'present'
+
+# Build image to run uffd in
+- name: 'Create temporary build directory'
+  become: true
+  ansible.builtin.file:
+    path: '{{ uffd_build_tempdir }}'
+    state: 'directory'
+    mode: 'u=rwx,g=rx,o=rx'
+
+- name: 'Copy static files for image'
+  become: true
+  ansible.builtin.copy:
+    src: '{{ item.file }}'
+    dest: '{{ uffd_build_tempdir }}/{{ item.file }}'
+    owner: 'root'
+    group: 'root'
+    mode: '{{ item.mode }}'
+  loop:
+    - file: 'cccv-archive-key.asc'
+      mode: 'u=rw,g=r,o=r'
+    - file: 'entrypoint.sh'
+      mode: 'u=rwx,g=rx,o=rx'
+    - file: 'uffd_2.3.1+git20241021T122809-98fe5690_all.deb'
+      mode: 'u=rw,g=r,o=r'
+
+- name: 'Copy templates for image'
+  become: true
+  ansible.builtin.template:
+    src: '{{ item.file }}'
+    dest: '{{ uffd_build_tempdir }}/{{ item.file }}'
+    owner: 'root'
+    group: 'root'
+    mode: '{{ item.mode }}'
+  loop:
+    - file: 'cccv-archive.list'
+      mode: 'u=rw,g=r,o=r'
+    - file: 'Containerfile'
+      mode: 'u=rw,g=r,o=r'
+
+- name: 'Create recent uffd image'
+  become: true
+  containers.podman.podman_image:
+    build:
+      cache: false
+      force_rm: true
+      rm: true
+    pull: false
+    push: false
+    force: '{{ uffd_build_force_rebuild }}'
+    name: 'uffd'
+    path: '{{ uffd_build_tempdir }}'
+    tag: '{{ ansible_date_time.iso8601_basic_short }}'
+  register: 'created_image_data'
+
+- name: 'Tag image as latest'
+  when: '{{ uffd_build_tag_latest }}'
+  become: true
+  containers.podman.podman_tag:
+    image: '{{ created_image_data.image[0].NamesHistory[0] }}'
+    target_names:
+      - 'uffd:latest'
+  register: 'created_image_data'
+
+- name: 'Cleanup temporary build directory'
+  become: true
+  ansible.builtin.file:
+    state: 'absent'
+    path: '{{ uffd_build_tempdir }}'

roles/build/templates/Containerfile

@@ -0,0 +1,39 @@
+FROM docker.io/library/debian:{{ uffd_build_debian_version }}-slim
+# Disable interactivity for debconf
+ENV DEBIAN_FRONTEND=noninteractive
+# Configure uwsgi parameters for running uffd as an app in there
+ENV UWSGI_DEB_CONFNAMESPACE="app"
+ENV UWSGI_DEB_CONFNAME="uffd"
+# Prepare the package sources and install needed software
+RUN apt-get -qq update && \
+    apt-get -qq dist-upgrade && \
+    apt-get -qq install ca-certificates
+# Place the pacakge sources data in the image to download uffd
+COPY cccv-archive-key.asc /etc/apt/trusted.gpg.d/
+COPY cccv-archive.list /etc/apt/sources.list.d/
+COPY uffd_2.3.1+git20241021T122809-98fe5690_all.deb /tmp/
+
+# Install uffd from (new) package sources
+RUN apt-get -qq update && \
+    apt-get -qq install --no-install-recommends /tmp/uffd_2.3.1+git20241021T122809-98fe5690_all.deb && \
+# Create a "new" config from the inital config without the preset secret key
+    cat /etc/uffd/uffd.cfg | grep -v "SECRET_KEY=" > /etc/uffd/uffd.cfg.tmp && \
+    mv /etc/uffd/uffd.cfg.tmp /etc/uffd/uffd.cfg && \
+# Create the needed paths for the app
+    mkdir --parents /var/www/uffd && \
+    mkdir -p /run/uwsgi/app/uffd && \
+    chown root:uffd /var/www/uffd
+
+COPY entrypoint.sh /entrypoint.sh
+
+USER uffd
+USER root
+
+# Uffd application is exposed on port 3031
+EXPOSE 3031/tcp
+# Statistics are exposed on port 9191
+EXPOSE 9191/tcp
+
+CMD bash /entrypoint.sh
+
+LABEL project="https://git.cccv.de/uffd/uffd"

roles/build/templates/cccv-archive.list

@@ -0,0 +1 @@
+deb [signed-by=/etc/apt/trusted.gpg.d/cccv-archive-key.asc] https://packages.cccv.de/uffd {{ uffd_build_debian_version }} main

roles/uffd/defaults/main.yml

@@ -0,0 +1,8 @@
+---
+uffd_podman_network: 'uffd-net'
+
+uffd_conf_dir: '/etc/uffd'
+uffd_static_files_volume: 'uffd-static-files'
+uffd_data_volume: 'uffd-data'
+
+uffd_image_name: 'localhost/uffd:latest'

roles/uffd/handlers/main.yml

@@ -0,0 +1,46 @@
+---
+- name: 'Reload uffd services'
+  become: true
+  ansible.builtin.service:
+    daemon_reload: true
+
+- name: 'Restart uffd network'
+  become: true
+  ansible.builtin.service:
+    name: '{{ uffd_podman_network }}-network'
+    state: 'restarted'
+  notify:
+    - 'Restart uffd container'
+
+- name: 'Restart uffd volumes'
+  become: true
+  ansible.builtin.service:
+    name: '{{ item }}-volume'
+    state: 'restarted'
+  loop:
+    - '{{ uffd_static_files_volume }}'
+    - '{{ uffd_data_volume }}'
+  notify:
+    - 'Restart uffd container'
+
+- name: 'Restart uffd container'
+  become: true
+  ansible.builtin.service:
+    name: 'uffd-app'
+    state: 'restarted'
+  notify:
+    - 'Restart uffd-nginx container'
+
+- name: 'Restart uffd-nginx image'
+  become: true
+  ansible.builtin.service:
+    name: 'uffd-nginx-image.service'
+    state: 'restarted'
+  notify:
+    - 'Restart uffd-nginx container'
+
+- name: 'Restart uffd-nginx container'
+  become: true
+  ansible.builtin.service:
+    name: 'uffd-nginx'
+    state: 'restarted'

roles/uffd/tasks/main.yml

@@ -0,0 +1,116 @@
+---
+- name: 'Install required software'
+  become: true
+  ansible.builtin.apt:
+    name: 'podman'
+    state: 'present'
+
+- name: 'Prepare uffd network'
+  become: true
+  containers.podman.podman_network:
+    name: '{{ uffd_podman_network }}'
+    state: 'quadlet'
+  notify:
+    - 'Reload uffd services'
+    - 'Restart uffd network'
+
+- name: 'Prepare uffd volumes'
+  become: true
+  containers.podman.podman_volume:
+    name: '{{ item }}'
+    state: 'quadlet'
+  loop:
+    - '{{ uffd_static_files_volume }}'
+    - '{{ uffd_data_volume }}'
+  notify:
+    - 'Reload uffd services'
+    - 'Restart uffd volumes'
+
+- name: 'Create uffd config directory'
+  become: true
+  ansible.builtin.file:
+    path: '{{ uffd_conf_dir }}'
+    state: 'directory'
+    mode: 'u=rwx,g=rx,o=rx'
+
+- name: 'Generate uffd configuration'
+  become: true
+  ansible.builtin.template:
+    src: 'uffd.cfg.j2'
+    dest: '{{ uffd_conf_dir }}/uffd.cfg'
+    owner: 'root'
+    group: 'root'
+    mode: 'u=rw,g=r,o=r'
+  notify: 'Restart uffd container'
+
+- name: 'Create uffd container'
+  become: true
+  containers.podman.podman_container:
+    name: 'uffd-app'
+    image: '{{ uffd_image_name }}'
+    network: '{{ uffd_podman_network }}.network'
+    state: 'quadlet'
+    volume:
+      - '{{ uffd_static_files_volume }}.volume:/var/www/uffd'
+      - '{{ uffd_data_volume }}.volume:/var/lib/uffd'
+      - '{{ uffd_conf_dir }}/uffd.cfg:/etc/uffd/uffd.cfg:ro'
+    env:
+      UFFD_INITIAL_ADMIN_USER: '{{ uffd_initial_admin_user }}'
+      UFFD_INITIAL_ADMIN_PW: '{{ uffd_initial_admin_pw }}'
+      UFFD_INITIAL_ADMIN_MAIL: '{{ uffd_initial_admin_mail }}'
+    ports: []
+    quadlet_options: |
+      [Install]
+      WantedBy=default.target
+      [Unit]
+      Requires={{ uffd_podman_network }}-network.service
+      Requires={{ uffd_static_files_volume }}-volume.service
+      Requires={{ uffd_data_volume }}-volume.service
+      After={{ uffd_podman_network }}-network.service
+      After={{ uffd_static_files_volume }}-volume.service
+      After={{ uffd_data_volume }}-volume.service
+  notify:
+    - 'Reload uffd services'
+    - 'Restart uffd container'
+
+- name: 'Define uffd-nginx image'
+  become: true
+  containers.podman.podman_image:
+    name: 'docker.io/library/nginx:latest'
+    quadlet_filename: 'uffd-nginx'
+    state: 'quadlet'
+  notify:
+    - 'Reload uffd services'
+    - 'Restart uffd-nginx image'
+
+- name: 'Write uffd-nginx config'
+  become: true
+  ansible.builtin.template:
+    src: 'nginx.conf.j2'
+    dest: '{{ uffd_conf_dir }}/nginx.conf'
+    owner: 'root'
+    group: 'root'
+    mode: 'u=rw,g=r,o=r'
+  notify:
+    - 'Restart uffd-nginx container'
+
+- name: 'Create uffd-nginx container'
+  become: true
+  containers.podman.podman_container:
+    name: 'uffd-nginx'
+    image: 'uffd-nginx.image'
+    network: '{{ uffd_podman_network }}.network'
+    state: 'quadlet'
+    volume:
+      - '{{ uffd_static_files_volume }}.volume:/var/www/uffd'
+      - '{{ uffd_conf_dir }}/nginx.conf:/etc/nginx/conf.d/default.conf:ro'
+    ports: []
+    quadlet_options: |
+      [Install]
+      WantedBy=default.target
+      [Unit]
+      Requires=uffd-app.service
+      After=uffd-app.service
+  notify:
+    - 'Reload uffd services'
+    - 'Restart uffd-nginx container'

roles/uffd/templates/nginx.conf.j2

@@ -0,0 +1,13 @@
+server {
+    listen          80;
+    server_name     _;
+
+    location / {
+        uwsgi_pass  uffd-app:3031;
+        include     uwsgi_params;
+    }
+
+    location /static {
+        alias       /var/www/uffd/static;
+    }
+}

roles/uffd/templates/uffd.cfg.j2

@@ -0,0 +1,3 @@
+FLASK_ENV="production"
+SQLALCHEMY_DATABASE_URI="sqlite:////var/lib/uffd/db.sqlite"
+SECRET_KEY="{{ uffd_secret_key }}"