From f0ccb9f3668c9cc6bc70ddc8aa410154d11c2b73 Mon Sep 17 00:00:00 2001 From: Mohammad Ahtasham ul Hassan <60315450+aht007@users.noreply.github.com> Date: Thu, 3 Nov 2022 16:09:58 +0500 Subject: [PATCH] build: native Dockerfile (#1333) --- .dockerignore | 1 + .github/workflows/push-docker-images.yml | 49 ++++++++++++++ Dockerfile | 84 ++++++++++++++++++------ 3 files changed, 113 insertions(+), 21 deletions(-) create mode 100644 .dockerignore create mode 100644 .github/workflows/push-docker-images.yml diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 000000000..94143827e --- /dev/null +++ b/.dockerignore @@ -0,0 +1 @@ +Dockerfile diff --git a/.github/workflows/push-docker-images.yml b/.github/workflows/push-docker-images.yml new file mode 100644 index 000000000..657231c64 --- /dev/null +++ b/.github/workflows/push-docker-images.yml @@ -0,0 +1,49 @@ +name: Build and Push Docker Images + +on: + push: + branches: + - master + tags: + - open-release/* +jobs: + push: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v2 + + # Use the release name as the image tag if we're building an open release tag. + # Examples: if we're building 'open-release/maple.1', tag the image as 'maple.1'. + # Otherwise, we must be building from a push to master, so use 'latest'. + - name: Get tag name + id: get-tag-name + uses: actions/github-script@v5 + with: + script: | + const releasePrefix = 'refs/tags/open-release/'; + const tagName = context.ref.split(releasePrefix)[1] || 'latest'; + console.log('Will use tag: ' + tagName); + return tagName; + result-encoding: string + + - name: Build and push Dev Docker image + uses: docker/build-push-action@v1 + with: + push: true + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_PASSWORD }} + target: dev + repository: edxops/insights-dev + tags: ${{ steps.get-tag-name.outputs.result }},${{ github.sha }} + + # - name: Build and push prod Docker image + # uses: docker/build-push-action@v1 + # with: + # push: true + # username: ${{ secrets.DOCKERHUB_USERNAME }} + # password: ${{ secrets.DOCKERHUB_PASSWORD }} + # target: prod + # repository: edxops/insights + # tags: ${{ steps.get-tag-name.outputs.result }},${{ github.sha }} diff --git a/Dockerfile b/Dockerfile index deab74346..b7ddae608 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,33 +1,75 @@ -FROM ubuntu:xenial as openedx - -RUN apt update && \ - apt-get install -y software-properties-common && \ - apt-add-repository -y ppa:deadsnakes/ppa && apt-get update && \ - apt-get install -y curl && \ - apt-get upgrade -qy && \ - apt install -y git-core language-pack-en build-essential python3.8-dev python3.8-distutils libmysqlclient-dev && \ - curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py && \ - python3.8 get-pip.py && python3.8 -m pip install --upgrade pip setuptools && \ +FROM ubuntu:focal as app + +ENV DEBIAN_FRONTEND noninteractive + +RUN apt-get update && apt-get install --no-install-recommends -qy \ + language-pack-en \ + build-essential \ + python3.8-dev \ + python3-virtualenv \ + python3.8-distutils \ + libmysqlclient-dev \ + libssl-dev && \ 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 ANALYTICS_DASHBOARD_CFG /edx/etc/insights.yml -WORKDIR /edx/app/analytics_dashboard -COPY requirements /edx/app/analytics_dashboard/requirements -RUN python3.8 -m pip install -r requirements/production.txt +# 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" + +# No need to activate insights virtualenv as it is already activated by putting in the path +RUN virtualenv -p python3.8 --always-copy ${INSIGHTS_VENV_DIR} + +COPY requirements ${INSIGHTS_CODE_DIR}/requirements + +ENV PATH="${INSIGHTS_CODE_DIR}/node_modules/.bin:$PATH" + +WORKDIR ${INSIGHTS_CODE_DIR}/ + +# insights service config commands below +RUN pip install --no-cache-dir -r ${INSIGHTS_CODE_DIR}/requirements/production.txt + +RUN nodeenv ${INSIGHTS_NODEENV_DIR} --node=16.14.0 --prebuilt \ + && npm install -g npm@8.5.x + +# Tried to cache the dependencies by copying related files after the npm install step but npm post install fails in that case. +COPY . ${INSIGHTS_CODE_DIR}/ +RUN npm set progress=false && npm ci EXPOSE 8110 -CMD gunicorn -b 127.0.0.1:8110 --workers 2 --timeout=300 analytics_dashboard.wsgi:application +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 -RUN useradd -m --shell /bin/false app -USER app -COPY . /edx/app/analytics_dashboard +FROM app as prod -FROM openedx as edx.org -RUN python3.8 -m pip install newrelic -CMD newrelic-admin run-program gunicorn -b 127.0.0.1:8110 --workers 2 --timeout=300 analytics_dashboard.wsgi:application +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