Merge pull request #5 from edx/huniafatima/migrate-dockerfile-setup

feat: added dockerfile and workflow for registrar

.github/workflows/push-registrar-image.yaml

@@ -0,0 +1,64 @@
+name: Build and Push Docker Images
+
+on:
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: "Target branch from which the source dockerfile from image will be sourced"
+
+#  Added for testing purposes. Will remove once the PR is finalised
+  pull_request:
+    branches:
+      - '**'
+
+  schedule:
+    - cron: "0 4 * * 1-5"  # UTC Time
+
+jobs:
+  build-and-push-docker-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/registrar.Dockerfile
+          push: true
+          target: dev
+          tags: edxops/registrar-dev:${{ 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 registrar
+          # Currently using this email for testing purposes. Will change it once finalised
+          to: [email protected]
+          from: github-actions <[email protected]>
+          body: Push Image to docker.io/edxops for registrar failed! For details see "github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"

.gitignore

@@ -0,0 +1 @@
+.idea

dockerfiles/registrar.Dockerfile

@@ -0,0 +1,92 @@
+FROM ubuntu:focal as app
+
+# 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
+
+# System requirements.
+RUN apt-get update
+RUN apt-get install -qy \
+	git-core \
+	language-pack-en \
+	build-essential \
+	# libmysqlclient-dev header files needed to use native C implementation for MySQL-python for performance gains.
+	libmysqlclient-dev \
+	# mysqlclient wont install without libssl-dev
+	libssl-dev \
+	# mysqlclient>=2.2.0 requires pkg-config (https://github.com/PyMySQL/mysqlclient/issues/620)
+	pkg-config \
+	curl \
+	python3-pip \
+	python${PYTHON_VERSION} \
+	python${PYTHON_VERSION}-dev \
+	python${PYTHON_VERSION}-distutils
+
+# 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
+
+# delete apt package lists because we do not need them inflating our image
+RUN rm -rf /var/lib/apt/lists/*
+
+# Python is Python3.
+RUN ln -s /usr/bin/python3 /usr/bin/python
+
+# Setup zoneinfo for Python 3.12
+RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
+
+# Use UTF-8.
+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
+
+ARG COMMON_CFG_DIR="/edx/etc"
+ARG COMMON_APP_DIR="/edx/app"
+ARG REGISTRAR_APP_DIR="${COMMON_APP_DIR}/registrar"
+ARG REGISTRAR_VENV_DIR="${COMMON_APP_DIR}/venvs/registrar"
+ARG REGISTRAR_CODE_DIR="${REGISTRAR_APP_DIR}"
+
+ENV PATH="$REGISTRAR_VENV_DIR/bin:$PATH"
+ENV REGISTRAR_APP_DIR ${REGISTRAR_APP_DIR}
+ENV REGISTRAR_CODE_DIR ${REGISTRAR_CODE_DIR}
+
+# Working directory will be root of repo.
+WORKDIR ${REGISTRAR_CODE_DIR}
+
+# cloning git repo
+RUN curl -L https://github.com/edx/registrar/archive/refs/heads/master.tar.gz | tar -xz --strip-components=1
+
+
+RUN virtualenv -p python${PYTHON_VERSION} --always-copy ${REGISTRAR_VENV_DIR}
+
+RUN pip install --upgrade pip setuptools
+
+ENV REGISTRAR_CFG="${COMMON_CFG_DIR}/registrar.yml"
+
+# Expose ports.
+EXPOSE 18734
+EXPOSE 18735
+
+FROM app as dev
+
+RUN pip install --no-cache-dir -r requirements/devstack.txt
+
+ENV DJANGO_SETTINGS_MODULE registrar.settings.devstack
+
+CMD while true; do python ./manage.py runserver 0.0.0.0:18734; sleep 2; done
+
+FROM app as prod
+
+RUN pip install  --no-cache-dir -r ${REGISTRAR_CODE_DIR}/requirements/production.txt
+
+ENV DJANGO_SETTINGS_MODULE registrar.settings.production
+
+CMD ["gunicorn", "--workers=2", "--name", "registrar", "-c", "/edx/app/registrar/registrar/docker_gunicorn_configuration.py", "--max-requests=1000", "registrar.wsgi:application"]