From 94e71a5b8ba2915ffaec1700e2eb45c823a1aabd Mon Sep 17 00:00:00 2001 From: Bilal Qamar <59555732+BilalQamar95@users.noreply.github.com> Date: Tue, 22 Oct 2024 17:29:53 +0500 Subject: [PATCH] feat: added dockerfile and docker image push workflow for commerce-coordinator (#40) * feat: added dockerfile and docker image push workflow for commerce-coordinator --- .../push-commerce-coordinator-image.yaml | 59 +++++++++++++++++ dockerfiles/commerce-coordinator.Dockerfile | 66 +++++++++++++++++++ 2 files changed, 125 insertions(+) create mode 100644 .github/workflows/push-commerce-coordinator-image.yaml create mode 100644 dockerfiles/commerce-coordinator.Dockerfile diff --git a/.github/workflows/push-commerce-coordinator-image.yaml b/.github/workflows/push-commerce-coordinator-image.yaml new file mode 100644 index 0000000..db561ac --- /dev/null +++ b/.github/workflows/push-commerce-coordinator-image.yaml @@ -0,0 +1,59 @@ +name: Build and Push Commerce Coordinator 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/commerce-coordinator.Dockerfile + push: true + target: app + tags: edxops/commerce-coordinator-dev:${{ steps.get-tag-name.outputs.result }} + + # Commenting the notification section temporarily as we don't have the owning team email for red-ventures 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 Commerce Coordinator + # to: team-cosmonauts@edx.org + # from: github-actions + # body: Push Image to docker.io/edxops for Commerce Coordinator failed! For details see "github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" diff --git a/dockerfiles/commerce-coordinator.Dockerfile b/dockerfiles/commerce-coordinator.Dockerfile new file mode 100644 index 0000000..0058554 --- /dev/null +++ b/dockerfiles/commerce-coordinator.Dockerfile @@ -0,0 +1,66 @@ +FROM ubuntu:focal as app +MAINTAINER sre@edx.org + + +# Packages installed: + +# gcc; for compiling python extensions distributed with python packages like mysql-client +# git; for pulling requirements from GitHub. +# language-pack-en locales; ubuntu locale support so that system utilities have a consistent language and time zone. +# libmysqlclient-dev; to install header files needed to use native C implementation for MySQL-python for performance gains. +# libssl-dev; # mysqlclient wont install without this. +# pkg-config is now required for libmysqlclient-dev and its python dependencies +# python3-dev; to install header files for python extensions; much wheel-building depends on this +# python3-pip; install pip to install application requirements.txt files +# python; ubuntu doesnt ship with python, so this is the python we will use to run the application + +# 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 \ + gcc \ + curl \ + git \ + language-pack-en \ + libmysqlclient-dev \ + libssl-dev \ + locales \ + pkg-config \ + python3-dev \ + python3-pip \ + python3.8 + + +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/* + +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 commerce_coordinator.settings.production + +EXPOSE 8140 + +RUN useradd -m --shell /bin/false app + +WORKDIR /edx/app/commerce-coordinator + +RUN mkdir -p requirements + +RUN curl -L -o requirements/production.txt https://raw.githubusercontent.com/edx/commerce-coordinator/main/requirements/production.txt +RUN pip install -r requirements/production.txt + +RUN mkdir -p /edx/var/log + +RUN curl -L https://github.com/edx/commerce-coordinator/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 commerce-coordinator -c /edx/app/commerce-coordinator/commerce_coordinator/docker_gunicorn_configuration.py --log-file - --max-requests=1000 commerce-coordinator.wsgi:application