From 3493d5b26cacd94c1bb50e3ff6235ac7f3fe77ef Mon Sep 17 00:00:00 2001 From: Bilal Qamar <59555732+BilalQamar95@users.noreply.github.com> Date: Tue, 5 Nov 2024 16:24:31 +0500 Subject: [PATCH 1/3] feat: added dockerfile and docker image push workflow for license-manager --- .../workflows/push-license-manager-image.yaml | 64 +++++++++ dockerfiles/license-manager.Dockerfile | 129 ++++++++++++++++++ 2 files changed, 193 insertions(+) create mode 100644 .github/workflows/push-license-manager-image.yaml create mode 100644 dockerfiles/license-manager.Dockerfile diff --git a/.github/workflows/push-license-manager-image.yaml b/.github/workflows/push-license-manager-image.yaml new file mode 100644 index 0000000..02d91e4 --- /dev/null +++ b/.github/workflows/push-license-manager-image.yaml @@ -0,0 +1,64 @@ +name: Build and Push License Manager 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 + +# Added for testing purposes. Will remove once the PR is finalised + pull_request: + branches: + - '**' + +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/license-manager.Dockerfile + push: true + target: app + tags: edxops/license-manager:${{ steps.get-tag-name.outputs.result }} + + # Commenting the notification section temporarily as we don't have the owning team email for titans yet. + # - 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 License Manager Coordinator + # to: team-titans@edx.org + # from: github-actions + # body: Push Image to docker.io/edxops for License Manager Coordinator failed! For details see "github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" diff --git a/dockerfiles/license-manager.Dockerfile b/dockerfiles/license-manager.Dockerfile new file mode 100644 index 0000000..3c43a57 --- /dev/null +++ b/dockerfiles/license-manager.Dockerfile @@ -0,0 +1,129 @@ +FROM ubuntu:focal as app +MAINTAINER devops@edx.org + + +# Packages installed: +# git; Used to pull in particular requirements from github rather than pypi, +# and to check the sha of the code checkout. + +# 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 + +# libssl-dev; # mysqlclient wont install without this. + +# pkg-config +# mysqlclient>=2.2.0 requires this (https://github.com/PyMySQL/mysqlclient/issues/620) + +# libmysqlclient-dev; to install header files needed to use native C implementation for +# MySQL-python for performance gains. + +# wget to download a watchman binary archive + +# unzip to unzip a watchman binary archive + +# If you add a package here please include a comment above describing what it is used for + +# 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 + +RUN apt-get update && apt-get -qy install --no-install-recommends \ + language-pack-en \ + locales \ + pkg-config \ + libmysqlclient-dev \ + libssl-dev \ + build-essential \ + git \ + wget \ + unzip \ + curl \ + libffi-dev \ + libsqlite3-dev \ + python3-pip \ + python${PYTHON_VERSION} \ + python${PYTHON_VERSION}-dev \ + python${PYTHON_VERSION}-distutils + +# 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 + +ENV VIRTUAL_ENV=/edx/app/license-manager/venvs/license-manager +RUN virtualenv -p python${PYTHON_VERSION} $VIRTUAL_ENV +ENV PATH="$VIRTUAL_ENV/bin:$PATH" + +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 license_manager.settings.production + +EXPOSE 18170 +EXPOSE 18171 +RUN useradd -m --shell /bin/false app + +# Install watchman +RUN wget https://github.com/facebook/watchman/releases/download/v2023.11.20.00/watchman-v2023.11.20.00-linux.zip +RUN unzip watchman-v2023.11.20.00-linux.zip +RUN mkdir -p /usr/local/{bin,lib} /usr/local/var/run/watchman +RUN cp watchman-v2023.11.20.00-linux/bin/* /usr/local/bin +RUN cp watchman-v2023.11.20.00-linux/lib/* /usr/local/lib +RUN chmod 755 /usr/local/bin/watchman +RUN chmod 2777 /usr/local/var/run/watchman + +# Now install license-manager +WORKDIR /edx/app/license_manager + +RUN mkdir -p requirements + +# Install production requirements +RUN curl -L -o requirements/pip.txt https://raw.githubusercontent.com/edx/license-manager/master/requirements/pip.txt +RUN pip install --no-cache-dir -r requirements/pip.txt + +RUN curl -L -o requirements/production.txt https://raw.githubusercontent.com/edx/license-manager/master/requirements/production.txt +RUN pip install --no-cache-dir -r requirements/production.txt + +RUN curl -L https://github.com/edx/license-manager/archive/refs/heads/master.tar.gz | tar -xz --strip-components=1 + +RUN mkdir -p /edx/var/log + +# 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 license_manager -c /edx/app/license_manager/license_manager/docker_gunicorn_configuration.py --log-file - --max-requests=1000 license_manager.wsgi:application + + +FROM app as newrelic +RUN pip install newrelic +CMD newrelic-admin run-program gunicorn --workers=2 --name license_manager -c /edx/app/license_manager/license_manager/docker_gunicorn_configuration.py --log-file - --max-requests=1000 license_manager.wsgi:application + + +FROM app as devstack +USER root +RUN pip install -r /edx/app/license_manager/requirements/dev.txt +USER app +CMD gunicorn --reload --workers=2 --name license_manager -c /edx/app/license_manager/license_manager/docker_gunicorn_configuration.py --log-file - --max-requests=1000 license_manager.wsgi:application + + +FROM app as legacy_devapp +# Dev ports +EXPOSE 18170 +EXPOSE 18171 +USER root +RUN pip install -r /edx/app/license_manager/requirements/dev.txt +USER app +CMD gunicorn --reload --workers=2 --name license_manager -c /edx/app/license_manager/license_manager/docker_gunicorn_configuration.py --log-file - --max-requests=1000 license_manager.wsgi:application From 4cf336f8faa8955f6bbc54588d1da257d5d74655 Mon Sep 17 00:00:00 2001 From: Bilal Qamar <59555732+BilalQamar95@users.noreply.github.com> Date: Tue, 5 Nov 2024 16:59:01 +0500 Subject: [PATCH 2/3] chore: Remove pull_request trigger from workflow --- .github/workflows/push-license-manager-image.yaml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.github/workflows/push-license-manager-image.yaml b/.github/workflows/push-license-manager-image.yaml index 02d91e4..dafb76b 100644 --- a/.github/workflows/push-license-manager-image.yaml +++ b/.github/workflows/push-license-manager-image.yaml @@ -9,11 +9,6 @@ on: schedule: - cron: "0 4 * * 1-5" # UTC Time -# Added for testing purposes. Will remove once the PR is finalised - pull_request: - branches: - - '**' - jobs: build-and-push-image: runs-on: ubuntu-latest From bdcaefaaa139ab8d78b63c78c25f8d7c294a94b3 Mon Sep 17 00:00:00 2001 From: Bilal Qamar <59555732+BilalQamar95@users.noreply.github.com> Date: Tue, 5 Nov 2024 17:12:46 +0500 Subject: [PATCH 3/3] chore: update Docker image tag in workflow --- .github/workflows/push-license-manager-image.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/push-license-manager-image.yaml b/.github/workflows/push-license-manager-image.yaml index dafb76b..c6d91fd 100644 --- a/.github/workflows/push-license-manager-image.yaml +++ b/.github/workflows/push-license-manager-image.yaml @@ -42,7 +42,7 @@ jobs: file: ./dockerfiles/license-manager.Dockerfile push: true target: app - tags: edxops/license-manager:${{ steps.get-tag-name.outputs.result }} + tags: edxops/license-manager-dev:${{ steps.get-tag-name.outputs.result }} # Commenting the notification section temporarily as we don't have the owning team email for titans yet. # - name: Send failure notification