From 971562bea4a773340c46808be923f000d8e89f4b Mon Sep 17 00:00:00 2001 From: Muhammad Umar Khan <42294172+mumarkhan999@users.noreply.github.com> Date: Wed, 23 Oct 2024 17:36:45 +0500 Subject: [PATCH] feat: add workflow and dockerfile for edx-exams (#32) --- .github/workflows/push-edx-exams-image.yaml | 58 +++++++++++ dockerfiles/edx-exams.Dockerfile | 103 ++++++++++++++++++++ 2 files changed, 161 insertions(+) create mode 100644 .github/workflows/push-edx-exams-image.yaml create mode 100644 dockerfiles/edx-exams.Dockerfile diff --git a/.github/workflows/push-edx-exams-image.yaml b/.github/workflows/push-edx-exams-image.yaml new file mode 100644 index 0000000..451e7d4 --- /dev/null +++ b/.github/workflows/push-edx-exams-image.yaml @@ -0,0 +1,58 @@ +name: Build and Push Edx Exams Image + +on: + workflow_dispatch: + inputs: + branch: + description: "Target branch from which the source dockerfile from image will be sourced" + + schedule: + - cron: "0 4 * * 1-5" # UTC Time + +jobs: + build-and-push-image: + runs-on: ubuntu-latest + + steps: + - name: Get tag name + id: get-tag-name + uses: actions/github-script@v5 + with: + script: | + const tagName = "${{ github.event.inputs.branch }}" || 'latest'; + console.log('Will use tag: ' + tagName); + return tagName; + result-encoding: string + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + + - name: Login to DockerHub + uses: docker/login-action@v3 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_PASSWORD }} + + - name: Build and push Dev Docker image + uses: docker/build-push-action@v6 + with: + file: ./dockerfiles/edx-exams.Dockerfile + push: true + target: app + tags: edxops/edx_exams:${{ steps.get-tag-name.outputs.result }} + + - name: Send failure notification + if: failure() + uses: dawidd6/action-send-mail@v3 + with: + server_address: email-smtp.us-east-1.amazonaws.com + server_port: 465 + username: ${{secrets.edx_smtp_username}} + password: ${{secrets.edx_smtp_password}} + subject: Push Image to docker.io/edxops failed in edx-exams + to: team-cosmonauts@edx.org + from: github-actions + body: Push Image to docker.io/edxops for edx-exams failed! For details see "github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" diff --git a/dockerfiles/edx-exams.Dockerfile b/dockerfiles/edx-exams.Dockerfile new file mode 100644 index 0000000..2b8f298 --- /dev/null +++ b/dockerfiles/edx-exams.Dockerfile @@ -0,0 +1,103 @@ +FROM ubuntu:focal as app +LABEL org.opencontainers.image.authors="sre@edx.org" + + +# Packages installed: + +# language-pack-en locales; ubuntu locale support so that system utilities have a consistent +# language and time zone. + +# python; ubuntu doesnt ship with python, so this is the python we will use to run the application + +# python3-pip; install pip to install application requirements.txt files + +# libmysqlclient-dev; to install header files needed to use native C implementation for +# MySQL-python for performance gains. + +# pkg-config; mysqlclient>=2.2.0 requires pkg-config (https://github.com/PyMySQL/mysqlclient/issues/620) + +# libssl-dev; # mysqlclient wont install without this. + +# python3-dev; to install header files for python extensions; much wheel-building depends on this + +# gcc; for compiling python extensions distributed with python packages like mysql-client + +# make; necessary to provision the container + +# ENV variables for Python 3.12 support +ARG PYTHON_VERSION=3.12 +ENV TZ=UTC +ENV TERM=xterm-256color +ENV DEBIAN_FRONTEND=noninteractive + +# software-properties-common is needed to setup Python 3.12 env +RUN apt-get update && \ + apt-get install -y software-properties-common && \ + apt-add-repository -y ppa:deadsnakes/ppa + +# If you add a package here please include a comment above describing what it is used for +RUN apt-get update && apt-get -qy install --no-install-recommends \ + build-essential \ + language-pack-en \ + locales \ + libmysqlclient-dev \ + pkg-config \ + libssl-dev \ + gcc \ + make \ + git \ + curl \ + python3-pip \ + python${PYTHON_VERSION} \ + python${PYTHON_VERSION}-dev \ + python${PYTHON_VERSION}-distutils + +RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone + +RUN pip install --upgrade pip setuptools +# delete apt package lists because we do not need them inflating our image +RUN rm -rf /var/lib/apt/lists/* + +# need to use virtualenv pypi package with Python 3.12 +RUN curl -sS https://bootstrap.pypa.io/get-pip.py | python${PYTHON_VERSION} +RUN pip install virtualenv + +# Create virtual environment with Python 3.12 +ENV VIRTUAL_ENV=/edx/venvs/edx-exams +RUN virtualenv -p python${PYTHON_VERSION} $VIRTUAL_ENV +ENV PATH="$VIRTUAL_ENV/bin:$PATH" + +# python is python3 +RUN ln -s /usr/bin/python3 /usr/bin/python + +RUN locale-gen en_US.UTF-8 +ENV LANG en_US.UTF-8 +ENV LANGUAGE en_US:en +ENV LC_ALL en_US.UTF-8 +ENV DJANGO_SETTINGS_MODULE edx_exams.settings.production + +EXPOSE 18740 +RUN useradd -m --shell /bin/false app + +WORKDIR /edx/app/edx-exams + +RUN mkdir -p requirements +# Copy the requirements explicitly even though we copy everything below +# this prevents the image cache from busting unless the dependencies have changed. +RUN curl -L -o requirements/production.txt https://raw.githubusercontent.com/edx/edx-exams/main/requirements/production.txt + +# Dependencies are installed as root so they cannot be modified by the application user. +RUN pip install -r requirements/production.txt + +RUN mkdir -p /edx/var/log + +# This line is after the requirements so that changes to the code will not +# bust the image cache +RUN curl -L https://github.com/edx/edx-exams/archive/refs/heads/main.tar.gz | tar -xz --strip-components=1 + +# Code is owned by root so it cannot be modified by the application user. +# So we copy it before changing users. +USER app + +# Gunicorn 19 does not log to stdout or stderr by default. Once we are past gunicorn 19, the logging to STDOUT need not be specified. +CMD gunicorn --workers=2 --name edx-exams -c /edx/app/edx-exams/edx_exams/docker_gunicorn_configuration.py --log-file - --max-requests=1000 edx_exams.wsgi:application