Merge pull request #1 from simonsobs/koopman/dockerize-server

Create Dockerfile and workflow to build and push images

Author: BrianJKoopman

.gitattributes

@@ -0,0 +1 @@
+src/scheduler_server/_version.py export-subst

.github/workflows/build.yaml

@@ -0,0 +1,49 @@
+name: Publish Images to Container Registries
+
+on:
+  release:
+    types: [ released ]
+  pull_request:
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Determine Docker tag
+        run: |
+          DOCKER_TAG=`git describe --tags --always`
+          echo "docker_tag=${DOCKER_TAG}" >> "$GITHUB_ENV"
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: |
+            simonsobs/scheduler-server:latest
+            simonsobs/scheduler-server:${{ env.docker_tag }}
+            ghcr.io/simonsobs/scheduler-server:latest
+            ghcr.io/simonsobs/scheduler-server:${{ env.docker_tag }}
+

Dockerfile

@@ -0,0 +1,32 @@
+# scheduler-server
+
+# Use ubuntu base image
+FROM ubuntu:22.04
+
+WORKDIR /app
+
+# Ensure we're set to UTC
+ENV TZ=Etc/UTC
+RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
+
+# Install python
+RUN apt-get update && apt-get install -y python3 \
+    python3-pip \
+    git
+
+# Install dumb-init
+RUN pip install dumb-init
+
+# Copy in and install requirements
+# This will leverage the cache for rebuilds when modifying the code, avoiding
+# downloading all the requirements again
+COPY requirements.txt /app/requirements.txt
+RUN pip3 install -r requirements.txt
+
+# Install schedlib
+COPY . .
+RUN pip install .
+
+# Run server
+EXPOSE 8010
+ENTRYPOINT ["dumb-init", "gunicorn", "--bind", "0.0.0.0:8010", "scheduler_server.app:app"]

readme.md

@@ -3,13 +3,21 @@
 ## Installation
 First clone this repository, and then install it with
 ```bash
+pip install -r requirements.txt
 pip install -e .
 ```
 ## Launch
 Launching it requires `gunicorn` to be available. If we are inside this directory, run
 ```bash
 gunicorn --bind localhost:8010 scheduler_server.app:app
 ```
+
+### Docker
+Alternatively, you can launch the server in a docker container:
+```bash
+docker run --rm -p 8010:8010 scheduler-server
+```
+
 ## Schedule API
 The API is temporarily hosted here: https://scheduler-uobd.onrender.com
 

requirements.txt

@@ -1,5 +1,7 @@
 flask
 flask_cors
 gunicorn
+numpy
 pyyaml
 pandas
+schedlib @ git+https://github.com/simonsobs/scheduler.git@main

setup.cfg

@@ -0,0 +1,7 @@
+[versioneer]
+VCS = git
+style = pep440
+versionfile_source = src/scheduler_server/_version.py
+versionfile_build = scheduler_server/_version.py
+tag_prefix = v
+parentdir_prefix = scheduler-server-

setup.py

@@ -1,15 +1,20 @@
 import setuptools
 
+import versioneer
+
 setuptools.setup(
     name="scheduler_server",
-    version="0.1.0",
+    version=versioneer.get_version(),
+    cmdclass=versioneer.get_cmdclass(),
     author="Yilun Guan",
     author_email="yilun.guan@utoronto.ca",
     description="scheduler server",
     packages=setuptools.find_packages(where="src"),
     package_dir={"": "src"},
     package_data={
-        "scheduler_server": ["config.yaml", "*.txt"],
+        "scheduler_server": [
+            "configs/*.txt",
+        ],
     },
     classifiers=[
         "Development Status :: 3 - Alpha",

src/scheduler_server/__init__.py

@@ -0,0 +1,3 @@
+
+from . import _version
+__version__ = _version.get_versions()['version']