Running an edx-platform fork from a local repository

rohano · May 7, 2022, 7:02pm

Is it possible to build a custom openedx image from a local copy of a modified edx-platform?

I.e. I tried:

tutor images build openedx --build-arg EDX_PLATFORM_REPOSITORY=/home/tutor/edx-platform --build-arg EDX_PLATFORM_VERSION=open-release/lilac.3

But it didn’t seem to like EDX_PLATFORM_REPOSITORY being a local checked out repository instead of a remote one…

Also, I noticed in the documentation here that it says “Do not try to run a fork from an older (pre-Maple) version of edx-platform: this will simply not work.”. Does this mean it’s not possible to run a fork with Lilac? I see other people having successfully run forks with Juniper, so maybe that’s just a recommendation under the assumption someone is on the latest tutor (which I’m not)?

uetuluk · May 9, 2022, 3:22am

Take a look at the Dockerfile to see how the openedx image is being created.

github.com

overhangio/tutor/blob/b55df07ebae774655c3407ff59c89eaadb228bdf/tutor/templates/build/openedx/Dockerfile#L38


      
          RUN dockerize_url="https://github.com/powerman/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-$(uname -m | sed 's@aarch@arm@')" \
              && echo "Downloading dockerize from $dockerize_url" \
              && curl --fail --location --output /usr/local/bin/dockerize $dockerize_url \
              && chmod a+x /usr/local/bin/dockerize
          
          ###### Checkout edx-platform code
          FROM minimal as code
          ARG EDX_PLATFORM_REPOSITORY={{ EDX_PLATFORM_REPOSITORY }}
          ARG EDX_PLATFORM_VERSION={{ EDX_PLATFORM_VERSION }}
          RUN mkdir -p /openedx/edx-platform && \
              git clone $EDX_PLATFORM_REPOSITORY --branch $EDX_PLATFORM_VERSION --depth 1 /openedx/edx-platform
          WORKDIR /openedx/edx-platform
          
          # Identify tutor user to cherry-pick commits
          RUN git config --global user.email "tutor@overhang.io" \
            && git config --global user.name "Tutor"
          
          {%- if patch("openedx-dockerfile-git-patches-default") %}
          # Custom edx-platform patches
          {{ patch("openedx-dockerfile-git-patches-default") }}
          {%- else %}

You can see how the git clone command runs and how the variables EDX_PLATFORM_REPOSITORY and EDX_PLATFORM_VERSION are used.

This refers to the building process being designed specifically for that version.
You can check the history for this file to find the Tutor version that matches your edx-platform version.

github.com

overhangio/tutor/blob/b55df07ebae774655c3407ff59c89eaadb228bdf/tutor/templates/config/defaults.yml#L51


      
          MONGODB_PASSWORD: ""
          OPENEDX_AWS_ACCESS_KEY: ""
          OPENEDX_AWS_SECRET_ACCESS_KEY: ""
          OPENEDX_CACHE_REDIS_DB: 1
          OPENEDX_CELERY_REDIS_DB: 0
          OPENEDX_CMS_UWSGI_WORKERS: 2
          OPENEDX_LMS_UWSGI_WORKERS: 2
          OPENEDX_MYSQL_DATABASE: "openedx"
          OPENEDX_CSMH_MYSQL_DATABASE: "{{ OPENEDX_MYSQL_DATABASE }}_csmh"
          OPENEDX_MYSQL_USERNAME: "openedx"
          OPENEDX_COMMON_VERSION: "open-release/maple.3"
          OPENEDX_EXTRA_PIP_REQUIREMENTS:
            - "openedx-scorm-xblock<14.0.0,>=13.0.0"
          MYSQL_HOST: "mysql"
          MYSQL_PORT: 3306
          MYSQL_ROOT_USERNAME: "root"
          NPM_REGISTRY: "https://registry.npmjs.org/"
          PLATFORM_NAME: "My Open edX"
          PREVIEW_LMS_HOST: "preview.{{ LMS_HOST }}"
          REDIS_HOST: "redis"
          REDIS_PORT: 6379

You should also be careful about these patch lines in the Dockerfile if you are working from an edx-platform fork since the build will fail it cannot apply the cherry-pick.

github.com

overhangio/tutor/blob/b55df07ebae774655c3407ff59c89eaadb228bdf/tutor/templates/build/openedx/Dockerfile#L45-L65


      
          {%- if patch("openedx-dockerfile-git-patches-default") %}
          # Custom edx-platform patches
          {{ patch("openedx-dockerfile-git-patches-default") }}
          {%- else %}
          # Patch edx-platform
          # Fix forum notification for questions
          # https://github.com/openedx/edx-platform/pull/29611
          RUN git fetch --depth=2 https://github.com/open-craft/edx-platform/ 03731f19459e558f188c06aac5cc9ca1bbc675c2 && git cherry-pick 03731f19459e558f188c06aac5cc9ca1bbc675c2
          # SAML security fix
          # https://github.com/overhangio/edx-platform/tree/overhangio/sec-fix-saml-vulnerability
          RUN git fetch --depth=2 https://github.com/overhangio/edx-platform/ 3b985f207853e88090d68a81acd52866b71f5af7 && git cherry-pick 3b985f207853e88090d68a81acd52866b71f5af7
          # Rate limiting security fix
          # https://github.com/overhangio/edx-platform/tree/overhangio/sec-rate-limiting
          RUN git fetch --depth=2 https://github.com/overhangio/edx-platform/ b5723e416e628cac4fa84392ca13e1b72817674f && git cherry-pick b5723e416e628cac4fa84392ca13e1b72817674f
          # Fix studio-frontend by pinning the installed version
          # https://github.com/openedx/edx-platform/pull/30309
          RUN git fetch --depth=2 https://github.com/uetuluk/edx-platform/ 53ea60eee86e094f35815ac1c4114d6811f4d458 && git cherry-pick 53ea60eee86e094f35815ac1c4114d6811f4d458
          {%- endif %}
          
          {# Example: RUN git fetch --depth=2 https://github.com/openedx/edx-platform <GITSHA1> && git cherry-pick <GITSHA1> #}
          {{ patch("openedx-dockerfile-post-git-checkout") }}

system · August 7, 2022, 3:23am

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.