From 11277d2275836d7b13d776b1c1e7b3490bc7003f Mon Sep 17 00:00:00 2001 From: Bilal Qamar <59555732+BilalQamar95@users.noreply.github.com> Date: Tue, 22 Oct 2024 17:02:18 +0500 Subject: [PATCH] feat: added dockerfile and docker image push workflow for edx-analytics-dashboard (#34) * feat: added dockerfile and docker image push workflow for edx-analytics-dashboard --- .../push-edx-analytics-dashboard-image.yaml | 58 +++++++++++ .../edx-analytics-dashboard.Dockerfile | 98 +++++++++++++++++++ 2 files changed, 156 insertions(+) create mode 100644 .github/workflows/push-edx-analytics-dashboard-image.yaml create mode 100644 dockerfiles/edx-analytics-dashboard.Dockerfile diff --git a/.github/workflows/push-edx-analytics-dashboard-image.yaml b/.github/workflows/push-edx-analytics-dashboard-image.yaml new file mode 100644 index 0000000..6bf61fa --- /dev/null +++ b/.github/workflows/push-edx-analytics-dashboard-image.yaml @@ -0,0 +1,58 @@ +name: Build and Push Analytics Dashboard 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-analytics-dashboard.Dockerfile + push: true + target: dev + tags: edxops/edx-analytics-dashboard-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 Analytics Dashboard + to: team-cosmonauts@edx.org + from: github-actions + body: Push Image to docker.io/edxops for Analytics Dashboard failed! For details see "github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" diff --git a/dockerfiles/edx-analytics-dashboard.Dockerfile b/dockerfiles/edx-analytics-dashboard.Dockerfile new file mode 100644 index 0000000..6dd5d8c --- /dev/null +++ b/dockerfiles/edx-analytics-dashboard.Dockerfile @@ -0,0 +1,98 @@ +FROM ubuntu:focal as app + +ENV DEBIAN_FRONTEND noninteractive + +ARG PYTHON_VERSION=3.8 + +# Packages installed: + +# pkg-config; mysqlclient>=2.2.0 requires pkg-config (https://github.com/PyMySQL/mysqlclient/issues/620) + +RUN apt-get update && \ + apt-get install -y software-properties-common && \ + apt-add-repository -y ppa:deadsnakes/ppa && \ + apt-get install --no-install-recommends -qy \ + language-pack-en \ + build-essential \ + python${PYTHON_VERSION}-dev \ + python${PYTHON_VERSION}-distutils \ + libmysqlclient-dev \ + pkg-config \ + libssl-dev \ + # needed by phantomjs + libfontconfig \ + # needed by i18n tests in CI + gettext \ + # needed by a11y tests script + curl \ + # needed to install github based dependency + git && \ + rm -rf /var/lib/apt/lists/* + +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 variables lifetime is bound to the container whereas ARGS variables lifetime is bound to the image building process only +# Also ARGS provide us an option of compatibility of Path structure for Tutor and other OpenedX installations +ARG COMMON_CFG_DIR "/edx/etc" +ARG COMMON_APP_DIR="/edx/app" +ARG INSIGHTS_APP_DIR="${COMMON_APP_DIR}/insights" +ARG INSIGHTS_VENV_DIR="${COMMON_APP_DIR}/insights/venvs/insights" +ARG INSIGHTS_CODE_DIR="${INSIGHTS_APP_DIR}/edx_analytics_dashboard" +ARG INSIGHTS_NODEENV_DIR="${COMMON_APP_DIR}/insights/nodeenvs/insights" + +ENV PATH "${INSIGHTS_VENV_DIR}/bin:${INSIGHTS_NODEENV_DIR}/bin:$PATH" +ENV INSIGHTS_APP_DIR ${INSIGHTS_APP_DIR} +ENV THEME_SCSS "sass/themes/open-edx.scss" +ENV PYTHON_VERSION "${PYTHON_VERSION}" + +RUN curl -sS https://bootstrap.pypa.io/get-pip.py | python${PYTHON_VERSION} +RUN pip install virtualenv + +# No need to activate insights virtualenv as it is already activated by putting in the path +RUN virtualenv -p python${PYTHON_VERSION} --always-copy ${INSIGHTS_VENV_DIR} + +ENV PATH="${INSIGHTS_CODE_DIR}/node_modules/.bin:$PATH" + +WORKDIR ${INSIGHTS_CODE_DIR}/ + +# Create required directories for requirements +RUN mkdir -p requirements + +# insights service config commands below +RUN curl -L -o requirements/production.txt https://raw.githubusercontent.com/edx/edx-analytics-dashboard/master/requirements/production.txt +RUN pip install --no-cache-dir -r requirements/production.txt + +RUN curl -L https://github.com/edx/edx-analytics-dashboard/archive/refs/heads/master.tar.gz | tar -xz --strip-components=1 + +RUN nodeenv ${INSIGHTS_NODEENV_DIR} --node=18.20.2 --prebuilt \ + && npm install -g npm@10.5.x + +RUN npm set progress=false && npm ci + +EXPOSE 8110 +EXPOSE 18110 + +FROM app as dev + +RUN pip install --no-cache-dir -r requirements/local.txt + +ENV DJANGO_SETTINGS_MODULE "analytics_dashboard.settings.devstack" + +# Backwards compatibility with devstack +RUN touch "${INSIGHTS_APP_DIR}/insights_env" + +CMD while true; do python ./manage.py runserver 0.0.0.0:8110; sleep 2; done + +FROM app as prod + +ENV DJANGO_SETTINGS_MODULE "analytics_dashboard.settings.production" + +CMD gunicorn \ + --pythonpath=/edx/app/insights/edx_analytics_dashboard/analytics_dashboard \ + --timeout=300 \ + -b 0.0.0.0:8110 \ + -w 2 \ + - analytics_dashboard.wsgi:application