issue2551163 Docker/containerization support

New multi-stage build including drivers for mysql and postgresql
along with brotli and zstd HTTP compression methods.

Documentation in installation.txt.

Author: rouilj

CHANGES.txt

@@ -56,6 +56,8 @@ Features:
   faster response/loading. Also eliminates stalls when the front end web
   server uses http 1.1 but the roundup-server uses 1.0. New option
   "-V HTTP/1.0" can turn it off. (John Rouillard)
+- issue2551163 - add scripts/Dockerfile to provide basic support for
+  containerization. See installation.txt for details. (John Rouillard)
 
 2021-07-13 2.1.0
 

doc/installation.txt

@@ -216,6 +216,70 @@ base directory, if you do not want to use administrator rights. If you
 choose to do this, you may have to change Python's search path (sys.path)
 yourself.
 
+Creating a Docker Container
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you don't want to install it natively, you can create a Docker
+container.  This uses the Dockerfile in the scripts directory. The
+roundup code in the distribuion and any changes will be used. The
+build command is::
+
+     docker build -t roundup-app --rm -f scripts/Dockerfile .
+
+It supports the following backends: anydbm, sqlite, mysql and
+postgresql. Mysql and postgresql support hasn't been tested, but the
+Python modules are built and available.  See scripts/requirement.txt
+for the additional modules that are installed.
+
+If you want to build a docker from the latest release on PyPI, you can
+use::
+
+     docker build -t roundup-app --build-arg="source=pypi" \
+          --rm -f scripts/Dockerfile .
+
+Once the docker is created, run it with::
+
+    docker run --rm -p 9017:8080 \
+         -v /.../issue.tracker:/usr/src/app/tracker \
+         roundup-app:latest
+
+This will make the tracker available at:
+``http://yourhost:9017/issues/``.
+
+The ``-p`` option maps an external port (9017) to proxy the roundup
+server running at port 8080 to the outside. The ``-v`` option maps a
+directory from the host into the docker container. It should be a
+tracker home directory. Note that uid 1000 is used by roundup. So the
+uid of the directory must be 1000.
+
+If you want to run multiple trackers, create a subdirectory for each
+tracker home under the volume mount point. Then invoke ``docker run``
+passing the roundup-server tracker specifications like::
+
+    docker run --rm -p 9017:8080 \
+        -v /.../issue.tracker:/usr/src/app/tracker \
+        roundup-app:latest tracker1=tracker1_home  tracker2=tracker2_home
+
+
+This will set up two trackers that can be reached at
+``http://yourhost:9017/tracker1/`` and ``http://yourhost:9017/tracker2/``.
+
+If you need to install and initialize the trackers, you can get a
+shell without starting the roundup-server using::
+
+    docker run -it \
+        -v /.../issue.tracker:/usr/src/app/tracker \
+        --entrypoint sh roundup-app:latest
+
+Now you can configure your tracker using ``roundup-admin -i tracker``
+using the directions below.
+
+If you need to access your container while the server is running you
+can use::
+
+   docker exec -it c0d5 sh
+
+where ``c0d5`` is the id prefix for the running container.
 
 Configuring your first tracker
 ------------------------------

scripts/Dockerfile

@@ -1,23 +1,44 @@
 # build in root dir using:
-#     docker build -t roundup-app --rm -f Dockerfile ..
+#
+#     docker build -t roundup-app --rm -f scripts/Dockerfile .
 #
 # run using:
-#    docker run --rm -v /home/rouilj/develop/roundup.sysadmin/issue.tracker:/usr/src/app/tracker -p 9017:8080 roundup-app:latest
+#
+#    docker run --rm -v /.../issue.tracker:/usr/src/app/tracker \
+#           -p 9017:8080 roundup-app:latest
 
-FROM python:3-alpine
 
-ENV appdir=/usr/src/app
-WORKDIR $appdir
+# Global vars for all build stages
 
-# allow roundup install from local directory or from pypi
+# application directory
+ARG appdir=/usr/src/app
+
+# support roundup install from 'local' directory or from 'pypi'
 ARG source=local
 
-LABEL "org.roundup-tracker.vendor"="Roundup Issue Tracker Team" \
-      "org.roundup-tracker.description"="Roundup Issue Tracker using sqlite" \
-      "version"="2.1.0 $source"
+FROM python:3-alpine as build
+
+# Inherit global values https://github.com/moby/moby/issues/37345
+ARG appdir
+
+WORKDIR $appdir
+
+# Add packages needed to compile mysql, pgsql and other python modules.
+# Can't use apk to add them as that installs a 3.9 python version.
+#        g++ installs cc1plus needed by pip install
+RUN apk add \
+    g++ \
+    gcc \
+    gpgme-dev \
+    linux-headers \
+    musl-dev \
+    mysql-dev \
+    postgresql-dev \
+    swig
 
-# add requirements for pip here, e.g. pytz or other modules
-#  ignore warnings from pip to use virtualenv
+# add requirements for pip here, e.g. Whoosh, gpg, zstd or other
+#   modules not installed in the base library.
+# ignore warnings from pip to use virtualenv
 COPY scripts/requirements.txt .
 RUN pip install --no-cache-dir -r requirements.txt
 
@@ -32,15 +53,39 @@ COPY share install/share/
 # verify source has one of two valid values then
 # install in python3 standard directories from local copy
 # or install in python3 standard directories from pypi using pip
-
-RUN if [ "$source" == "local" ] || [ "$source" == "pypi" ]; then :; \
+# import from global/command line
+ARG source
+RUN set -xv && if [ "$source" = "local" ] || [ "$source" = "pypi" ]; then :; \
            else echo "invalid value for source: $source"; \
                 echo "must be local or pypi"; exit 1; fi; \
-    if [ "$source" == "local" ]; then cd install && ./setup.py install; fi; \
-    if [ "$source" == "pypi" ]; then pip install roundup; fi
+    if [ "$source" = "local" ]; then cd install && ./setup.py install; fi; \
+    if [ "$source" = "pypi" ]; then pip install roundup; fi
 
-# delete source files
-RUN rm -rf install
+# build a new smaller docker image for execution. Build image above
+# is 1G in size.
+FROM python:3-alpine
+
+# import from global
+ARG appdir
+
+WORKDIR $appdir
+
+# add libraries needed to run gpg/mysql/pgsql/brotli
+RUN apk add \
+     gpgme \
+     mariadb-connector-c \
+     libpq \
+     libstdc++
+
+ARG source
+LABEL "org.roundup-tracker.vendor"="Roundup Issue Tracker Team" \
+      "org.roundup-tracker.description"="Roundup Issue Tracker using sqlite" \
+      "version"="2.1.0 $source"
+
+# pull over built assets
+COPY --from=build /usr/local/lib/python3.10/site-packages /usr/local/lib/python3.10/site-packages/
+COPY --from=build /usr/local/bin/roundup* /usr/local/bin/
+COPY --from=build /usr/local/share /usr/local/share/
 
 # map port 8080 to your local port
 EXPOSE 8080/tcp
@@ -50,11 +95,12 @@ RUN mkdir tracker
 VOLUME $appdir/tracker
 
 # do not run roundup as root
-RUN adduser -D roundup
-
-# run the server
+RUN adduser -D -h /usr/src/app roundup
 USER roundup
-ENTRYPOINT [ "roundup-server", "-L", "-n", "0.0.0.0" ]
+
+# run the server, disable output buffering so we can see logs.
+ENV PYTHONUNBUFFERED=1
+ENTRYPOINT [ "roundup-server", "-n", "0.0.0.0" ]
 
 # allow the invoker to override cmd with multiple trackers
 # in each subdirectory under $appdir/tracker. E.G.

scripts/requirements.txt

@@ -2,14 +2,13 @@
 pytz
 # indexer
 Whoosh
-# databases - need devel and other files installed to be built.
-#psycopg2==2.7.4
-#mysqlclient==1.3.10
-# encryption - need additional packages
-#gpg==1.10.0
+# extra database support
+psycopg2
+mysqlclient
+# encryption
+gpg
 # java web tokens
-PyJWT==1.7.1
-# extra compression support - build needs gcc
-#Brotli==1.0.4
-#zstd==1.5.0.2
-
+PyJWT
+# extra HTTP compression methods
+Brotli
+zstd