feat: Dockerfile optimizations

fix: fixed dependency error
feat: add dependency of lms to discovery
2023-05-25 10:50:53 +02:00 · 2023-05-25 12:06:35 +05:00 · 2023-05-25 11:55:26 +05:00 · 2023-05-24 18:16:38 +05:00
33 changed files with 187 additions and 748 deletions
--- a/.github/workflows/auto-add-to-project.yml
+++ b/.github/workflows/auto-add-to-project.yml
@ -1,20 +0,0 @@
-name: Auto Add Issues and Pull Requests to Project
-
-on:
-  issues:
-    types:
-      - opened
-  pull_request_target:
-    types:
-      - opened
-
-jobs:
-  # https://github.com/actions/add-to-project
-  add-to-project:
-    name: Add issue and bugs to project
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/add-to-project@v1.0.2
-        with:
-          project-url: https://github.com/orgs/overhangio/projects/4
-          github-token: ${{ secrets.GH_PROJECT_PERSONAL_ACCESS_TOKEN }}
--- a/.github/workflows/sync.yml
+++ b/.github/workflows/sync.yml
@ -2,16 +2,16 @@ name: Sync with private repo

 on:
  push:
-    branches: [ release, main ]
+    branches: [ master ]

 jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Add remote
        run: git remote add overhangio https://${{ secrets.GIT_USERNAME }}:${{ secrets.GIT_PASSWORD }}@git.overhang.io/core/tutor-discovery.git
      - name: Push
-        run: git push overhangio $GITHUB_REF
+        run: git push overhangio master
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@ -1,25 +0,0 @@
-name: Run tests
-
-on:
-  pull_request:
-    branches: [release, main]
-  push:
-    branches: [release, main]
-
-jobs:
-  tests:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.9', '3.12']
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          pip install .[dev]
-      - name: Test lint, types, and format
-        run: make test
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@ -2,6 +2,7 @@ variables:
    TUTOR_PLUGIN: discovery
    TUTOR_IMAGES: discovery
    TUTOR_PYPI_PACKAGE: tutor-discovery
+    OPENEDX_RELEASE: palm
    GITHUB_REPO: overhangio/tutor-discovery

 include:
--- a/.hatch_build.py
+++ b/.hatch_build.py
@ -1,22 +0,0 @@
-# https://hatch.pypa.io/latest/how-to/config/dynamic-metadata/
-import os
-import typing as t
-
-from hatchling.metadata.plugin.interface import MetadataHookInterface
-
-HERE = os.path.dirname(__file__)
-
-
-class MetaDataHook(MetadataHookInterface):
-    def update(self, metadata: dict[str, t.Any]) -> None:
-        about = load_about()
-        metadata["version"] = about["__version__"]
-
-
-def load_about() -> dict[str, str]:
-    about: dict[str, str] = {}
-    with open(
-        os.path.join(HERE, "tutordiscovery", "__about__.py"), "rt", encoding="utf-8"
-    ) as f:
-        exec(f.read(), about)
-    return about
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -19,73 +19,3 @@ instructions, because git commits are used to generate release notes:

 <!-- scriv-insert-here -->

-<a id='changelog-20.0.0'></a>
-## v20.0.0 (2025-06-05)
-
- [Bugfix] Add support to consume events from event bus in discovery. Explanation can be viewed here: https://github.com/openedx/event-bus-redis/blob/main/docs/tutor_installation.rst. (by @Faraz32123)
-
- [Feature] Introduced a new environment variable to enable or disable programs. (by @Faraz32123)
-  - This aligns with the frontend, which now also utilizes this environment variable. To view the frontend related changes, click here: https://github.com/openedx/frontend-app-learner-dashboard/pull/506/files.
-  - Additionally, it automates the enabling of programs in the "programapiconfig" model on the LMS admin panel through init tasks.
-
- [Improvement] Migrate packaging from setup.py/setuptools to pyproject.toml/hatch. (by @Faraz32123)
-  - For more details view tutor core PR: https://github.com/overhangio/tutor/pull/1163
-
- [Improvement] Add hatch_build.py in sdist target to fix the installation issues (by @dawoudsheraz)
-
- [Improvement] Replace site-configuration script with create_or_update_site_configuration management command in the init task. (by @Danyal-Faheem)
-
- 💥[Feature] Upgrade to Teak. (by @mlabeeb03)
-
-<a id='changelog-19.0.0'></a>
-## v19.0.0 (2024-10-23)
-
- 💥[Feature] Upgrade to Sumac. (by @Faraz32123)
- [Feature] Add Elasticsearch support in tutor-discovery. As Tutor and Open edX have shifted to Meilisearch, and course-discovery still depends on Elasticsearch, running the Elasticsearch container with tutor-discovery will facilitate smoother operation for the course-discovery service. (by @Faraz32123)
-  - Please see related tutor core PR for context https://github.com/overhangio/tutor/pull/1141
- 💥 [Deprecation] Drop support for python 3.8 and set Python 3.9 as the minimum supported python version. (by @Faraz32123)
- 💥[Improvement] Rename Tutor's two branches (by @DawoudSheraz):
-  * Rename **master** to **release**, as this branch runs the latest official Open edX release tag.
-  * Rename **nightly** to **main**, as this branch runs the Open edX master branches, which are the basis for the next Open edX release.
- [Improvement] Move is_docker_rootless method related to elasticsearch from tutor core to tutor-discovery. (by @Faraz32123)
- 💥[Feature] Update Course Discovery Image to use Ubuntu 22.04 as base OS. (by @hinakhadim)
- [Bugfix] Fix catalog_service_user permissions and 403 while fetching pathways (by @dyudyunov)
- [BugFix] Fix images(media) persistance issue by mounting media directory in volumes through patches. (by @Faraz32123)
- [Bugfix] Fix legacy warnings during Docker build. (by @regisb)
-
-
-<a id='changelog-18.0.0'></a>
-## v18.0.0 (2024-05-14)
-
- 💥[Feature] Upgrade to Redwood. (by @Faraz32123)
- 💥[Feature] Upgrade Python version to 3.12.2. (by @Faraz32123)
- [BugFix] Fix wrong mime type by adding mime-support dependency. (by @Faraz32123)
-
-<a id='changelog-17.0.1'></a>
-## v17.0.1 (2024-04-25)
-
- [Bugfix] Make plugin compatible with Python 3.12 by removing dependency on `pkg_resources`. (by @regisb)
- [Feature] Make it possible to use mounts for a local development. (by @cmltawt0)
- [Bugfix] Fix volumes empty list error during tutor dev launch. (by @Faraz32123)
- [Bugfix] Fix the docker image to allow media files to be served by uwsgi. (by @angonz)
-
-<a id='changelog-17.0.0'></a>
-## v17.0.0 (2023-12-09)
-
- 💥 [Feature] Upgrade to Quince. (by @ziafazal)
- [Bugfix] Fix missing pkg-config during image build. (by @regisb)
- [Feature] Pull translations via `atlas` during Docker build. (by @OmarIthawi)
-
-<a id='changelog-16.0.2'></a>
-## v16.0.2 (2023-12-09)
-
- [Improvement] Added Typing to code, Makefile and test action to the repository and formatted code with Black and isort. (by @CodeWithEmad)
- [Improvement] Introduced Course Discovery Repository and Version settings. (by @Faraz32123)
- [BugFix] Fix base url for discovery media files, including program banner images. (by @Faraz32123)
-
-<a id='changelog-16.0.1'></a>
-## v16.0.1 (2023-11-08)
-
- [Improvement] Add a scriv-compliant changelog. (by @regisb)
- [BugFix] Corrected variable name for installing extra pip requirements. (by @Faraz32123)
-
--- a/MANIFEST.in
+++ b/MANIFEST.in
@ -0,0 +1,2 @@
+recursive-include tutordiscovery/patches *
+recursive-include tutordiscovery/templates *
--- a/45
+++ b/45
@ -1,45 +0,0 @@
-.DEFAULT_GOAL := help
-.PHONY: docs
-SRC_DIRS = ./tutordiscovery ./tests
-
-# Warning: These checks are run on every PR.
-test: test-lint test-types test-format test-unit test-pythonpackage  # Run some static checks.
-
-test-format: ## Run code formatting tests.
-	ruff format --check --diff ${SRC_DIRS}
-
-test-lint: ## Run code linting tests
-	ruff check ${SRC_DIRS}
-
-test-types: ## Run type checks.
-	mypy --exclude=templates --ignore-missing-imports --implicit-reexport --strict ${SRC_DIRS}
-
-test-unit: ## Run unit tests
-	python -m unittest discover tests
-
-build-pythonpackage: ## Build the "tutor-discovery" python package for upload to pypi
-	python -m build --sdist
-
-test-pythonpackage: build-pythonpackage ## Test that package can be uploaded to pypi
-	twine check dist/tutor_discovery-$(shell make version).tar.gz
-
-format: ## Format code automatically.
-	ruff format ${SRC_DIRS}
-
-fix-lint: ## Fix lint errors automatically
-	ruff check --fix ${SRC_DIRS}
-
-changelog-entry: ## Create a new changelog entry.
-	scriv create
-
-changelog: ## Collect changelog entries in the CHANGELOG.md file.
-	scriv collect
-
-version: ## Print the current tutor-discovery version
-	@python -c 'import io, os; about = {}; exec(io.open(os.path.join("tutordiscovery", "__about__.py"), "rt", encoding="utf-8").read(), about); print(about["__version__"])'
-
-ESCAPE = 
-help: ## Print this help.
-	@grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \
-		| sed 's/######* \(.*\)/@               $(ESCAPE)[1;31m\1$(ESCAPE)[0m/g' | tr '@' '\n' \
-		| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'
--- a/README.rst
+++ b/README.rst
@ -1,36 +1,28 @@
-Course Discovery plugin for `Tutor`_
-====================================
+Course Discovery plugin for `Tutor <https://docs.tutor.overhang.io>`_
+=====================================================================

-This is a plugin for `Tutor`_ that integrates the `Course Discovery`_ application in an Open edX platform.
-it is useful for integration with, for example, `Ecommerce`_ or an external course catalog.
-
-
-.. _Tutor: https://docs.tutor.edly.io
-.. _Course Discovery: https://github.com/edx/course-discovery/
-.. _Ecommerce: https://github.com/edx/ecommerce
+This is a plugin for `Tutor <https://docs.tutor.overhang.io>`_ that integrates the `Course Discovery <https://github.com/edx/course-discovery/>`__ application in an Open edX platform. it is useful for integration with, for example, `Ecommerce <https://github.com/edx/ecommerce>`__ or an external course catalog.

 Installation
 ------------

-This plugin requires ``tutor>=3.6.0``. If you have installed tutor from a pre-compiled binary,
-it already comes bundled with the discovery plugin. Otherwise:
-
-.. code-block:: bash
-
+This plugin requires tutor>=3.6.0. If you have installed tutor from a pre-compiled binary, it already comes bundled with the discovery plugin. Otherwise::

    tutor plugins install discovery

-Then, to enable this plugin, run:
-
-.. code-block:: bash
+Then, to enable this plugin, run::

    tutor plugins enable discovery

-Restart and initialize your platform with:
+You will have to re-generate the environment::

-.. code-block:: bash
+    tutor config save

-    tutor dev|local|k8s launch
+Then, run migrations::
+
+    tutor local init
+
+This last step is unnecessary if you run instead ``tutor local launch``.

 Operations
 ----------
@ -38,31 +30,19 @@ Operations
 Creating a user
 ~~~~~~~~~~~~~~~

-The discovery user interface will be available at http://discovery.local.openedx.io for a local test instance,
-and at ``DISCOVERY_HOST`` (by default: http(s)://discovery.<your lms host>) in production. To run
-commands from the UI, a user must be created:
-
-.. code-block:: bash
+The discovery user interface will be available at http://discovery.local.overhang.io for a local test instance, and at ``DISCOVERY_HOST`` (by default: http(s)://discovery.<your lms host>) in production. In order to run commands from the UI, a user must be created::

    tutor local run discovery ./manage.py createsuperuser

-Then, you must log in with this user at http://discovery.local.openedx.io/admin.
+Then, you must login with this user at http://discovery.local.overhang.io/admin.

-Using SSO with LMS
-~~~~~~~~~~~~~~~~~~
-
-If you want to log in using Single Sign-On (SSO) with the LMS, ensure that the superuser you created 
-above in discovery has the same username and email as an existing admin user in the LMS/CMS. You can 
-then access the discovery interface via `http(s)://discovery.<your lms host>/login`. Make sure that 
-the proper domain names are configured and point to the production server.
+Alternatively, you can login with oauth2 using a pre-existing user created on the LMS/CMS by accessing http(s)://discovery.<your lms host>/login. To do so, the proper domain names must exist and point to the production server.

 Index configuration
 ~~~~~~~~~~~~~~~~~~~

-Discovery uses separate indices for different models (the names are: course, course_run, person, and
-program by default). And you can overwrite these names by configuring ``DISCOVERY_INDEX_OVERRIDES``:
-
-.. code-block:: yml
+Discovery uses separate indices for different models (the names are: course, course_run, person and program by default). And you can overwrite theses
+names by configuring ``DISCOVERY_INDEX_OVERRIDES``::

    DISCOVERY_INDEX_OVERRIDES:
      course_discovery.apps.course_metadata.search_indexes.documents.course: your-course-index-name
@ -73,179 +53,74 @@ program by default). And you can overwrite these names by configuring ``DISCOVER
 Re-indexing courses
 ~~~~~~~~~~~~~~~~~~~

-While running tutor in production mode:
-
-.. code-block:: bash
+::

    tutor local run discovery ./manage.py refresh_course_metadata --partner_code=openedx
    tutor local run discovery ./manage.py update_index --disable-change-limit

-While running tutor in development mode:
-
-.. code-block:: bash
-
-    tutor dev run discovery ./manage.py refresh_course_metadata --partner_code=dev
-    tutor dev run discovery ./manage.py update_index --disable-change-limit
-
 Caching programs
 ~~~~~~~~~~~~~~~~

-To cache programs in the LMS, you will need to manually create a catalog integration.
-Make sure you use staff user for the below command. If ``lms_catalog_service_user`` is not a staff user,
-then make it a staff user in your LMS User model. This step should be performed just once:
-
-.. code-block:: bash
+In order to cache programs in the LMS, you will need to manually create a catalog integration. This step should be performed just once::

    tutor local run lms ./manage.py lms create_catalog_integrations --enabled \
        --internal_api_url="" \
        --service_username=lms_catalog_service_user

-Then run the below command, this command will cause errors every time it tries to cache programs
-from all sites that are added to your LMS sites model:
-
-.. code-block:: bash
+Then::

    tutor local run lms ./manage.py lms cache_programs

-The above command will give some errors as it tries to cache programs for all sites. So make use of an
-extra argument to the command. i.e. ``--domain``. While running tutor in production mode:
-
-.. code-block:: bash
-
-    tutor local run lms ./manage.py lms cache_programs --domain="local.openedx.io"
-
-While running tutor in development mode:
-
-.. code-block:: bash
-
-    tutor dev run lms ./manage.py lms cache_programs --domain="local.openedx.io:8000"
-
 This last step should be performed every time you create new or make changes to existing programs.

-Show Programs Tab
-~~~~~~~~~~~~~~~~~
-
-By default, the **Programs** tab is available in the LMS dashboard. Users can enable or disable this tab as needed.
-To Disable Programs, run the following command:
-
-.. code-block:: bash
-
-    tutor config save --set ENABLE_PROGRAMS=False
-
-To Enable Programs, run the following command:
-
-.. code-block:: bash
-
-    tutor config save --set ENABLE_PROGRAMS=True
-
-Only programs in which learners are registered will appear on this page. If a learner is enrolled in any course that is part of a program, that program will be displayed here.
-
-.. image:: https://github.com/overhangio/tutor-discovery/assets/122095701/e0224011-adc0-41e4-a104-af4cb0c24b82
-    :alt: Programs Tab on LMS dashboard
-
-In the image above, the **Explore Programs** button points to http://localhost:8080/programs by default. This link does not exist, so users can change it to their custom-built marketing site URL to display all programs.
-To Modify the Link:
-
-1. Go to the **Site Configurations** model in the LMS Admin Panel: `http://local.openedx.io/admin/site_configuration/siteconfiguration/`
-2. Open the respective LMS site configuration.
-3. Add the following dictionary in the **site values** field like in the below image:
-
-.. code-block:: python
-
-    "MKTG_URLS": {
-        "ROOT": "https://custom-marketing-site-here.com"
-    }
-
-.. image:: https://github.com/overhangio/tutor-discovery/assets/122095701/2d588ea9-a830-40b6-9845-8fab56d7cb5a
-    :alt: Add Custom Site for Explore Programs
-
-By following above instructions, this link (https://custom-marketing-site-here.com) will be replaced by http://localhost:8080. Additionally, users can also replace "/programs" by following these below steps:
-
-1. Go to: `http://local.openedx.io/admin/programs/programsapiconfig/`
-2. Add **Marketing path** equal to "/programs" or your desired marketing site path and enable it.
-
 Install extra requirements
 ~~~~~~~~~~~~~~~~~~~~~~~~~~

-To install extra requirements, use ``DISCOVERY_EXTRA_PIP_REQUIREMENTS`` and re-build the docker image.
+In order to install extra requirements, use DISCOVERY_EXTRA_PIP_REQUIREMENTS and re-build the docker image.::

-.. code-block:: bash
+  tutor config save \
+    --set 'DISCOVERY_EXTRA_PIP_REQUIREMENTS=["git+https://github.com/myusername/myplugin"]'

-  tutor config save --set 'DISCOVERY_EXTRA_PIP_REQUIREMENTS=["git+https://github.com/myusername/myplugin"]'
-
-Then, build the image, pointing to your fork if necessary:
-
-.. code-block:: bash
+Then, build the image, pointing to your fork if necessary::

  tutor images build discovery

 Debugging
 ---------

-To debug the course discovery service, you are encouraged to mount the course-discovery repo from the host
-in the development container:
-
-.. code-block:: bash
+To debug the course discovery service, you are encouraged to mount the course-discovery repo from the host in the development container:

    tutor dev start --mount /path/to/course-discovery/ discovery

-You can then access the development server at http://discovery.local.openedx.io:8381. Feel free to add breakpoints
-(``import pdb; pdb.set_trace()``) anywhere in your source code to debug your application.
+You can then access the development server at http://discovery.local.overhang.io:8381. Feel free to add breakpoints (``import pdb; pdb.set_trace()``) anywhere in your source code to debug your application.

-Once a local repository is mounted in the image, you will have to install nodejs dependencies and collect static assets:
-
-.. code-block:: bash
+Once a local repository is mounted in the image, you will have to install nodejs dependencies and collect static assets::

    tutor dev run discovery npm install --development
    tutor dev run discovery make static.dev

+Troubleshooting
+---------------
+
+This Tutor plugin is maintained by Régis Behmo from `Overhang.IO <https://overhang.io>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.overhang.io/troubleshooting.html>`__ section from the Tutor documentation.
+

 `Max retries exceeded with url`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 When running in production with HTTPS enabled, you may face this error during the `init` phase of `tutor local launch`:

-.. code-block:: log
+```
+requests.exceptions.ConnectionError: HTTPSConnectionPool(host='<LMS_HOST>', port=443): Max retries exceeded with url: /api/courses/v1/courses/?page=1&page_size=10&username=discovery
+```

-    requests.exceptions.ConnectionError: HTTPSConnectionPool(host='<LMS_HOST>', port=443): Max retries exceeded with url: /api/courses/v1/courses/?page=1&page_size=10&username=discovery
-
-This error may be due to an incorrect DNS resolution of the LMS DNS record. With some cloud providers
-(for instance: `DigitalOcean`_) the `/etc/hosts` file on the host automatically
-contains the following entry:
-
-.. code-block:: bash
+This error may be due to an incorrect DNS resolution of the LMS DNS record. With some cloud providers (for instance: [DigitalOcean](https://digitalocean.com/)) the `/etc/hosts` file on the host automatically contains the following entry::

    127.0.1.1 <LMS HOST>

 This entry may be present if you named your server with the LMS hostname.

-.. _DigitalOcean: https://digitalocean.com/
-
-
-Using event-bus with tutor-discovery
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Although tutor-discovery does not start event bus consumption by default, it supports running it. To consume events from event bus with tutor-discovery, follow these `instructions`_ provided by `event-bus-redis`_.
-
-.. _instructions: https://github.com/openedx/event-bus-redis/blob/main/docs/tutor_installation.rst
-.. _event-bus-redis: https://github.com/openedx/event-bus-redis
-
-
-Troubleshooting
---------------
-
-This Tutor plugin is maintained by Muhammad Labeeb from `Edly`_.
-Community support is available from the official `Open edX forum`_.
-Do you need help with this plugin? See the `troubleshooting`_
-section from the Tutor documentation.
-
-.. _Edly: https://edly.io/
-.. _Open edX forum: https://discuss.openedx.org
-.. _troubleshooting: https://docs.tutor.edly.io/troubleshooting.html
-
 License
 -------

-This work is licensed under the terms of the `GNU Affero General Public License (AGPL)`_.
-
-.. _GNU Affero General Public License (AGPL): https://github.com/overhangio/tutor/blob/release/LICENSE.txt
+This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor/blob/master/LICENSE.txt>`_.
--- a/changelog.d/20230519_161836_regis.md
+++ b/changelog.d/20230519_161836_regis.md
@ -0,0 +1 @@
+- [Improvement] Add a scriv-compliant changelog. (by @regisb)
--- a/changelog.d/20250808_142901_muhammad.labeeb_release.md
+++ b/changelog.d/20250808_142901_muhammad.labeeb_release.md
@ -1,2 +0,0 @@
- [Improvement] Migrate from pylint and black to ruff. (by @mlabeeb03)
- [Improvement] Test python package distribution build when running make test. (by @mlabeeb03)
--- a/pyproject.toml
+++ b/pyproject.toml
@ -1,84 +1,2 @@
-# https://packaging.python.org/en/latest/tutorials/packaging-projects/
-# https://hatch.pypa.io/latest/config/build/
-
-[project]
-name = "tutor-discovery"
-license = { text = "AGPL-3.0-only" }
-authors = [
-  {name = "Edly"},
-  {email = "hello@edly.io"},
-]
-maintainers = [
-  {name = "Muhammad Labeeb"},
-  {email = "muhammad.labeeb@arbisoft.com"},
-]
-description="A Tutor plugin for course discovery, the Open edX service for providing access to consolidated course and program metadata"
-readme = {file = "README.rst", content-type = "text/x-rst"}
-requires-python = ">= 3.9"
-classifiers = [
-    "Development Status :: 5 - Production/Stable",
-    "Intended Audience :: Developers",
-    "License :: OSI Approved :: GNU Affero General Public License v3",
-    "Operating System :: OS Independent",
-    "Programming Language :: Python",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-]
-dependencies = [
-  "tutor>=20.0.0,<21.0.0",
-]
-# these fields will be set by hatch_build.py
-dynamic = ["version"]
-
-[project.optional-dependencies]
-dev = [
-  "tutor[dev]>=20.0.0,<21.0.0", 
-  "ruff", 
-]
-
-# https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels
-[project.urls]
-Homepage = "https://docs.tutor.edly.io/"
-Documentation = "https://docs.tutor.edly.io/"
-Source = "https://github.com/overhangio/tutor-discovery"
-Issues = "https://github.com/overhangio/tutor-discovery/issues"
-Changelog = "https://github.com/overhangio/tutor-discovery/blob/release/CHANGELOG.md"
-Community = "https://discuss.openedx.org/tag/tutor"
-
-# hatch-specific configuration
-[tool.hatch.metadata.hooks.custom]
-path = ".hatch_build.py"
-
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[tool.hatch.build.targets.sdist]
-# Disable strict naming, otherwise twine is not able to detect name/version
-strict-naming = false
-include = [ "/tutordiscovery", ".hatch_build.py"]
-exclude = ["tests*"]
-
-[tool.hatch.build.targets.wheel]
-packages = ["tutordiscovery"]
-
-[tool.ruff]
-exclude = ["templates", "docs/_ext"]
-
-[tool.ruff.lint]
-# E: pycodestyle errors
-# I: isort
-# N: pep8-naming
-select = ["E", "I", "N"]
-
-# F401: unused-import
-# F841: unused-variable
-# W292: missing-newline-at-end-of-file
-extend-select = ["F401", "F841", "W292"]
-
-[tool.ruff.format]
-
-[project.entry-points."tutor.plugin.v1"]
-discovery = "tutordiscovery.plugin"
+requires = ["setuptools", "wheel"]
--- a/setup.py
+++ b/setup.py
@ -0,0 +1,51 @@
+import io
+import os
+from setuptools import setup, find_packages
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+with io.open(os.path.join(here, "README.rst"), "rt", encoding="utf8") as f:
+    readme = f.read()
+
+about = {}
+with io.open(
+    os.path.join(here, "tutordiscovery", "__about__.py"), "rt", encoding="utf-8"
+) as f:
+    exec(f.read(), about)
+
+
+setup(
+    name="tutor-discovery",
+    version=about["__version__"],
+    url="https://docs.tutor.overhang.io/",
+    project_urls={
+        "Documentation": "https://docs.tutor.overhang.io/",
+        "Code": "https://github.com/overhangio/tutor-discovery",
+        "Issue tracker": "https://github.com/overhangio/tutor-discovery/issues",
+        "Community": "https://discuss.openedx.org",
+    },
+    license="AGPLv3",
+    author="Overhang.IO",
+    author_email="contact@overhang.io",
+    maintainer="Overhang.IO",
+    maintainer_email="regis@overhang.io",
+    description="A Tutor plugin for course discovery, the Open edX service for providing access to consolidated course and program metadata",
+    long_description=readme,
+    long_description_content_type="text/x-rst",
+    packages=find_packages(exclude=["tests*"]),
+    include_package_data=True,
+    install_requires=["tutor>=16.0.0,<17.0.0"],
+    python_requires=">=3.8",
+    entry_points={"tutor.plugin.v1": ["discovery = tutordiscovery.plugin"]},
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: GNU Affero General Public License v3",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+    ],
+)
--- a/tests/init.py
+++ b/tests/init.py
--- a/tests/test_utils.py
+++ b/tests/test_utils.py
@ -1,26 +0,0 @@
-import subprocess
-import unittest
-from unittest.mock import MagicMock, patch
-
-from tutordiscovery import utils
-
-
-class UtilsTests(unittest.TestCase):
-    @patch("subprocess.run")
-    def test_is_docker_rootless(self, mock_run: MagicMock) -> None:
-        # Mock rootless `docker info` output
-        utils.is_docker_rootless.cache_clear()
-        mock_run.return_value.stdout = "some prefix\n rootless foo bar".encode("utf-8")
-        self.assertTrue(utils.is_docker_rootless())
-
-        # Mock regular `docker info` output
-        utils.is_docker_rootless.cache_clear()
-        mock_run.return_value.stdout = "some prefix, regular docker".encode("utf-8")
-        self.assertFalse(utils.is_docker_rootless())
-
-    @patch("subprocess.run")
-    def test_is_docker_rootless_podman(self, mock_run: MagicMock) -> None:
-        """Test the `is_docker_rootless` when podman is used or any other error with `docker info`"""  # noqa: E501
-        utils.is_docker_rootless.cache_clear()
-        mock_run.side_effect = subprocess.CalledProcessError(1, "docker info")
-        self.assertFalse(utils.is_docker_rootless())
--- a/tutordiscovery/about.py
+++ b/tutordiscovery/about.py
@ -1 +1 @@
-__version__ = "20.0.0"
+__version__ = "16.0.0"
--- a/tutordiscovery/patches/discovery-common-settings
+++ b/tutordiscovery/patches/discovery-common-settings
@ -1 +0,0 @@
-DISCOVERY_RUN_ELASTICSEARCH = {{ DISCOVERY_RUN_ELASTICSEARCH }}
--- a/tutordiscovery/patches/k8s-deployments
+++ b/tutordiscovery/patches/k8s-deployments
@ -15,8 +15,8 @@ spec:
        app.kubernetes.io/name: discovery
    spec:
      securityContext:
-        runAsUser: {{ APP_USER_ID }}
-        runAsGroup: {{ APP_USER_ID }}
+        runAsUser: 1000
+        runAsGroup: 1000
      containers:
        - name: discovery
          image: {{ DISCOVERY_DOCKER_IMAGE }}
@ -32,54 +32,3 @@ spec:
        - name: settings
          configMap:
            name: discovery-settings
-
-{% if DISCOVERY_RUN_ELASTICSEARCH %}
---
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: elasticsearch
-  labels:
-    app.kubernetes.io/name: elasticsearch
-spec:
-  selector:
-    matchLabels:
-      app.kubernetes.io/name: elasticsearch
-  strategy:
-    type: Recreate
-  template:
-    metadata:
-      labels:
-        app.kubernetes.io/name: elasticsearch
-    spec:
-      securityContext:
-        runAsUser: {{ APP_USER_ID }}
-        runAsGroup: {{ APP_USER_ID }}
-        fsGroup: {{ APP_USER_ID }}
-        fsGroupChangePolicy: "OnRootMismatch"
-      containers:
-        - name: elasticsearch
-          image: {{ DISCOVERY_DOCKER_IMAGE_ELASTICSEARCH }}
-          env:
-            - name: cluster.name
-              value: "openedx"
-            - name: bootstrap.memory_lock
-              value: "true"
-            - name: discovery.type
-              value: "single-node"
-            - name: ES_JAVA_OPTS
-              value: "-Xms{{ DISCOVERY_ELASTICSEARCH_HEAP_SIZE }} -Xmx{{ DISCOVERY_ELASTICSEARCH_HEAP_SIZE }}"
-            - name: TAKE_FILE_OWNERSHIP
-              value: "1"
-          ports:
-            - containerPort: 9200
-          securityContext:
-            allowPrivilegeEscalation: false
-          volumeMounts:
-            - mountPath: /usr/share/elasticsearch/data
-              name: data
-      volumes:
-        - name: data
-          persistentVolumeClaim:
-            claimName: elasticsearch
-{% endif %}
--- a/tutordiscovery/patches/k8s-jobs
+++ b/tutordiscovery/patches/k8s-jobs
@ -23,3 +23,4 @@ spec:
        - name: settings
          configMap:
            name: discovery-settings
+
--- a/tutordiscovery/patches/k8s-services
+++ b/tutordiscovery/patches/k8s-services
@ -10,19 +10,3 @@ spec:
      protocol: TCP
  selector:
    app.kubernetes.io/name: discovery
-{% if DISCOVERY_RUN_ELASTICSEARCH %}
---
-apiVersion: v1
-kind: Service
-metadata:
-  name: elasticsearch
-  labels:
-    app.kubernetes.io/name: elasticsearch
-spec:
-  type: ClusterIP
-  ports:
-    - port: 9200
-      protocol: TCP
-  selector:
-    app.kubernetes.io/name: elasticsearch
-{% endif %}
--- a/tutordiscovery/patches/k8s-volumes
+++ b/tutordiscovery/patches/k8s-volumes
@ -1,16 +0,0 @@
-{% if DISCOVERY_RUN_ELASTICSEARCH %}
---
-apiVersion: v1
-kind: PersistentVolumeClaim
-metadata:
-  name: elasticsearch
-  labels:
-    app.kubernetes.io/component: volume
-    app.kubernetes.io/name: elasticsearch
-spec:
-  accessModes:
-    - ReadWriteOnce
-  resources:
-    requests:
-      storage: 2Gi
-{% endif %}
--- a/tutordiscovery/patches/local-docker-compose-dev-services
+++ b/tutordiscovery/patches/local-docker-compose-dev-services
@ -4,23 +4,9 @@ discovery:
  command: ./manage.py runserver 0.0.0.0:8381
  stdin_open: true
  tty: true
-  volumes:
-    - ../../data/discovery/media:/openedx/discovery/course_discovery/media
-  {%- for mount in iter_mounts(MOUNTS, "discovery") %}
-    - {{ mount }}
-  {%- endfor %}
  ports:
    - "8381:8381"
  networks:
    default:
      aliases:
        - "{{ DISCOVERY_HOST }}"
-
-{% if DISCOVERY_RUN_ELASTICSEARCH and is_docker_rootless() %}
-  elasticsearch:
-    ulimits:
-      memlock:
-        # Fixes error setting rlimits for ready process in rootless docker
-        soft: 0  # zero means "unset" in the memlock context
-        hard: 0
-  {% endif %}
--- a/tutordiscovery/patches/local-docker-compose-permissions-command
+++ b/tutordiscovery/patches/local-docker-compose-permissions-command
@ -1 +0,0 @@
-{% if DISCOVERY_RUN_ELASTICSEARCH %}setowner {{ APP_USER_ID }} /mounts/elasticsearch{% endif %}
--- a/tutordiscovery/patches/local-docker-compose-permissions-volumes
+++ b/tutordiscovery/patches/local-docker-compose-permissions-volumes
@ -1 +0,0 @@
-{% if DISCOVERY_RUN_ELASTICSEARCH %}- ../../data/elasticsearch:/mounts/elasticsearch{% endif %}
--- a/tutordiscovery/patches/local-docker-compose-services
+++ b/tutordiscovery/patches/local-docker-compose-services
@ -5,29 +5,7 @@ discovery:
  restart: unless-stopped
  volumes:
    - ../plugins/discovery/apps/settings/tutor:/openedx/discovery/course_discovery/settings/tutor:ro
-    - ../../data/discovery/media:/openedx/discovery/course_discovery/media
-    {% if DISCOVERY_RUN_ELASTICSEARCH %}- ../../data/elasticsearch:/mounts/elasticsearch{% endif %}
  depends_on: 
    - lms
    {% if RUN_MYSQL %}- mysql{% endif %}
-    {% if DISCOVERY_RUN_ELASTICSEARCH %}- elasticsearch{% endif %}
-
-{% if DISCOVERY_RUN_ELASTICSEARCH -%}
-  elasticsearch:
-    image: {{ DISCOVERY_DOCKER_IMAGE_ELASTICSEARCH }}
-    environment:
-      - cluster.name=openedx
-      - bootstrap.memory_lock=true
-      - discovery.type=single-node
-      - "ES_JAVA_OPTS=-Xms{{ DISCOVERY_ELASTICSEARCH_HEAP_SIZE }} -Xmx{{ DISCOVERY_ELASTICSEARCH_HEAP_SIZE }}"
-    ulimits:
-      memlock:
-        soft: -1
-        hard: -1
-    restart: unless-stopped
-    user: "{{ APP_USER_ID }}:{{ APP_USER_ID }}"
-    volumes:
-      - ../../data/elasticsearch:/usr/share/elasticsearch/data
-    depends_on:
-      - permissions
-{%- endif %}
+    {% if RUN_ELASTICSEARCH %}- elasticsearch{% endif %}
--- a/tutordiscovery/patches/mfe-lms-common-settings
+++ b/tutordiscovery/patches/mfe-lms-common-settings
@ -1 +0,0 @@
-MFE_CONFIG["ENABLE_PROGRAMS"] = {{ ENABLE_PROGRAMS }}
--- a/tutordiscovery/plugin.py
+++ b/tutordiscovery/plugin.py
@ -1,28 +1,27 @@
 from __future__ import annotations

-import os
-import typing as t
 from glob import glob
+import os
+import pkg_resources
+import typing as t

-import importlib_resources
 from tutor import hooks as tutor_hooks
-from tutor.__about__ import __version_suffix__

 from .__about__ import __version__
-from .utils import is_docker_rootless
-
-# Handle version suffix in main mode, just like tutor core
-if __version_suffix__:
-    __version__ += "-" + __version_suffix__

 HERE = os.path.abspath(os.path.dirname(__file__))
-REPO_NAME = "course-discovery"
-APP_NAME = "discovery"

-config: t.Dict[str, t.Dict[str, t.Any]] = {
+
+config = {
+    "unique": {
+        "MYSQL_PASSWORD": "{{ 8|random_string }}",
+        "SECRET_KEY": "{{ 20|random_string }}",
+        "OAUTH2_SECRET": "{{ 8|random_string }}",
+        "OAUTH2_SECRET_SSO": "{{ 8|random_string }}",
+    },
    "defaults": {
        "VERSION": __version__,
-        "DOCKER_IMAGE": "{{ DOCKER_REGISTRY}}overhangio/openedx-discovery:{{ DISCOVERY_VERSION }}",  # noqa: E501
+        "DOCKER_IMAGE": "{{ DOCKER_REGISTRY}}overhangio/openedx-discovery:{{ DISCOVERY_VERSION }}",
        "HOST": "discovery.{{ LMS_HOST }}",
        "INDEX_OVERRIDES": {},
        "MYSQL_DATABASE": "discovery",
@ -32,26 +31,7 @@ config: t.Dict[str, t.Dict[str, t.Any]] = {
        "OAUTH2_KEY_SSO": "discovery-sso",
        "OAUTH2_KEY_SSO_DEV": "discovery-sso-dev",
        "CACHE_REDIS_DB": "{{ OPENEDX_CACHE_REDIS_DB }}",
-        "ATLAS_PULL": False,
-        "DEFAULT_PRODUCT_SOURCE_SLUG": "edx",
        "EXTRA_PIP_REQUIREMENTS": [],
-        "REPOSITORY": "https://github.com/openedx/course-discovery.git",
-        "REPOSITORY_VERSION": "{{ OPENEDX_COMMON_VERSION }}",
-        "RUN_ELASTICSEARCH": True,
-        "DOCKER_IMAGE_ELASTICSEARCH": "docker.io/elasticsearch:7.17.13",
-        "ELASTICSEARCH_HOST": "elasticsearch",
-        "ELASTICSEARCH_PORT": 9200,
-        "ELASTICSEARCH_SCHEME": "http",
-        "ELASTICSEARCH_HEAP_SIZE": "1g",
-    },
-    "unique": {
-        "MYSQL_PASSWORD": "{{ 8|random_string }}",
-        "SECRET_KEY": "{{ 20|random_string }}",
-        "OAUTH2_SECRET": "{{ 8|random_string }}",
-        "OAUTH2_SECRET_SSO": "{{ 8|random_string }}",
-    },
-    "overrides": {
-        "ENABLE_PROGRAMS": True,
    },
 }

@ -60,7 +40,7 @@ init_tasks = ("mysql", "lms", "discovery")
 for service in init_tasks:
    with open(
        os.path.join(
-            str(importlib_resources.files("tutordiscovery") / "templates"),
+            pkg_resources.resource_filename("tutordiscovery", "templates"),
            "discovery",
            "tasks",
            service,
@ -100,29 +80,16 @@ tutor_hooks.Filters.IMAGES_PUSH.add_item(

 # Automount /openedx/discovery folder from the container
@tutor_hooks.Filters.COMPOSE_MOUNTS.add()
-def _mount_course_discovery(
-    mounts: list[tuple[str, str]], name: str
-) -> list[tuple[str, str]]:
-    if name == REPO_NAME:
-        mounts.append((APP_NAME, "/openedx/discovery"))
-    return mounts
-
-
-# Bind-mount repo at build-time, both for prod and dev images
-@tutor_hooks.Filters.IMAGES_BUILD_MOUNTS.add()
-def _mount_course_discovery_on_build(
-    mounts: list[tuple[str, str]], host_path: str
-) -> list[tuple[str, str]]:
-    path_basename = os.path.basename(host_path)
-    if path_basename == REPO_NAME:
-        mounts.append((APP_NAME, f"{APP_NAME}-src"))
-        mounts.append((f"{APP_NAME}-dev", f"{APP_NAME}-src"))
+def _mount_course_discovery(mounts, name):
+    if name == "course-discovery":
+        mounts.append(("discovery", "/openedx/discovery"))
    return mounts


+####### Boilerplate code
 # Add the "templates" folder as a template root
 tutor_hooks.Filters.ENV_TEMPLATE_ROOTS.add_item(
-    str(importlib_resources.files("tutordiscovery") / "templates")
+    pkg_resources.resource_filename("tutordiscovery", "templates")
 )
 # Render the "build" and "apps" folders
 tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
@ -131,14 +98,10 @@ tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
        ("discovery/apps", "plugins"),
    ],
 )
-# Template variables
-tutor_hooks.Filters.ENV_TEMPLATE_VARIABLES.add_item(
-    ("is_docker_rootless", is_docker_rootless),
-)
 # Load patches from files
 for path in glob(
    os.path.join(
-        str(importlib_resources.files("tutordiscovery") / "patches"),
+        pkg_resources.resource_filename("tutordiscovery", "patches"),
        "*",
    )
 ):
@ -157,13 +120,16 @@ tutor_hooks.Filters.CONFIG_OVERRIDES.add_items(
    list(config.get("overrides", {}).items())
 )

+########################################
+# Credentials Public Host
+########################################
+

@tutor_hooks.Filters.APP_PUBLIC_HOSTS.add()
-def _print_discovery_public_hosts(
-    hosts: list[str], context_name: t.Literal["local", "dev"]
-) -> list[str]:
+def _discovery_public_hosts(hosts: list[str], context_name: t.Literal["local", "dev"]) -> list[str]:
    if context_name == "dev":
-        hosts += ["{{ DISCOVERY_HOST }}:8381"]
+        # todo: will may change the below dev port when i try this plugin in dev mode
+        hosts += ["discovery.{{ LMS_HOST }}:8000"]
    else:
-        hosts += ["{{ DISCOVERY_HOST }}"]
+        hosts += ["discovery.{{ LMS_HOST }}"]
    return hosts
--- a/tutordiscovery/templates/discovery/apps/settings/partials/common.py
+++ b/tutordiscovery/templates/discovery/apps/settings/partials/common.py
@ -20,14 +20,8 @@ DATABASES = {
    }
 }

-DISCOVERY_DOCKER_IMAGE_ELASTICSEARCH = "{{ DISCOVERY_DOCKER_IMAGE_ELASTICSEARCH }}"
-DISCOVERY_ELASTICSEARCH_HOST = "{{ DISCOVERY_ELASTICSEARCH_HOST }}"
-DISCOVERY_ELASTICSEARCH_PORT = "{{ DISCOVERY_ELASTICSEARCH_PORT }}"
-DISCOVERY_ELASTICSEARCH_SCHEME = "{{ DISCOVERY_ELASTICSEARCH_SCHEME }}"
-DISCOVERY_ELASTICSEARCH_HEAP_SIZE = "{{ DISCOVERY_ELASTICSEARCH_HEAP_SIZE }}"
-
 ELASTICSEARCH_DSL['default'].update({
-    'hosts': "{{ DISCOVERY_ELASTICSEARCH_SCHEME }}://{{ DISCOVERY_ELASTICSEARCH_HOST }}:{{ DISCOVERY_ELASTICSEARCH_PORT }}/"
+    'hosts': "{{ ELASTICSEARCH_SCHEME }}://{{ ELASTICSEARCH_HOST }}:{{ ELASTICSEARCH_PORT }}/"
 })

 {% for name, index in DISCOVERY_INDEX_OVERRIDES.items() %}
@ -53,7 +47,6 @@ PARLER_LANGUAGES[1][0]["code"] = LANGUAGE_CODE
 PARLER_LANGUAGES["default"]["fallbacks"] = [PARLER_DEFAULT_LANGUAGE_CODE]

 EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"
-DEFAULT_PRODUCT_SOURCE_SLUG = "{{ DISCOVERY_DEFAULT_PRODUCT_SOURCE_SLUG }}"
 EMAIL_HOST = "{{ SMTP_HOST }}"
 EMAIL_PORT = "{{ SMTP_PORT }}"
 EMAIL_HOST_USER = "{{ SMTP_USERNAME }}"
--- a/tutordiscovery/templates/discovery/apps/settings/tutor/development.py
+++ b/tutordiscovery/templates/discovery/apps/settings/tutor/development.py
@ -16,7 +16,4 @@ SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL = SOCIAL_AUTH_EDX_OAUTH2_ISSUER + "/logout"
 # Disable API caching, which makes it a pain to troubleshoot issues
 USE_API_CACHING = False

-DISCOVERY_BASE_URL = "http://{{ DISCOVERY_HOST }}:8381"
-MEDIA_URL = DISCOVERY_BASE_URL + "/media/"
-
 {{ patch("discovery-development-settings") }}
--- a/tutordiscovery/templates/discovery/apps/settings/tutor/production.py
+++ b/tutordiscovery/templates/discovery/apps/settings/tutor/production.py
@ -15,7 +15,4 @@ SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL = SOCIAL_AUTH_EDX_OAUTH2_ISSUER + "/logout"

 SOCIAL_AUTH_REDIRECT_IS_HTTPS = {% if ENABLE_HTTPS %}True{% else %}False{% endif %}

-DISCOVERY_BASE_URL = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ DISCOVERY_HOST }}"
-MEDIA_URL = DISCOVERY_BASE_URL + "/media/"
-
 {{ patch("discovery-production-settings") }}
--- a/tutordiscovery/templates/discovery/build/discovery/Dockerfile
+++ b/tutordiscovery/templates/discovery/build/discovery/Dockerfile
@ -1,103 +1,94 @@
-# syntax=docker/dockerfile:1.4
+{% if is_buildkit_enabled() %}# syntax=docker/dockerfile:1.4{% endif %}
 ###### Minimal image with base system requirements for most stages
-FROM docker.io/ubuntu:22.04 AS minimal
+FROM docker.io/ubuntu:20.04 as minimal

 ENV DEBIAN_FRONTEND=noninteractive
-RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
-    --mount=type=cache,target=/var/lib/apt,sharing=locked \
+RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/var/cache/apt,sharing=locked \
+    --mount=type=cache,target=/var/lib/apt,sharing=locked{% endif %} \ 
    apt update && \
-    apt install -y curl git-core gettext language-pack-en \
-    build-essential libcairo2 libffi-dev libmysqlclient-dev libxml2-dev libxslt-dev libjpeg-dev libssl-dev \
-    pkg-config libsqlite3-dev media-types mailcap libbz2-dev liblzma-dev
-ENV LC_ALL=en_US.UTF-8
+    apt install -y curl git-core language-pack-en python3 python3-pip python3-venv \
+    build-essential libcairo2 libffi-dev libmysqlclient-dev libxml2-dev libxslt-dev libjpeg-dev libssl-dev
+ENV LC_ALL en_US.UTF-8

-ARG APP_USER_ID={{ HOST_USER_ID }}
+###### Git-clone course-discovery repo
+FROM minimal as code
+ARG DISCOVERY_REPOSITORY=https://github.com/openedx/course-discovery.git
+ARG DISCOVERY_VERSION='{{ OPENEDX_COMMON_VERSION }}'
+RUN mkdir -p /openedx/discovery && \
+    git clone $DISCOVERY_REPOSITORY --branch $DISCOVERY_VERSION --depth 1 /openedx/discovery
+
+##### Empty layer with just the repo at the root.
+# This is useful when overriding the build context with a host repo:
+# docker build --build-context course-discovery=/path/to/course-discovery
+FROM scratch as discovery
+COPY --from=code /openedx/discovery /
+
+##### Production layer
+FROM minimal as production
+
+# Create app user
+ARG APP_USER_ID=1000
 RUN if [ "$APP_USER_ID" = 0 ]; then echo "app user may not be root" && false; fi
 RUN useradd --home-dir /openedx --create-home --shell /bin/bash --uid ${APP_USER_ID} app
 USER ${APP_USER_ID}

-###### Git-clone course-discovery repo
-ARG DISCOVERY_REPOSITORY='{{ DISCOVERY_REPOSITORY }}'
-ARG DISCOVERY_VERSION='{{ DISCOVERY_REPOSITORY_VERSION }}'
-RUN mkdir -p /openedx/discovery && \
-    git clone $DISCOVERY_REPOSITORY --branch $DISCOVERY_VERSION --depth 1 /openedx/discovery
+# Copy repo
+COPY --chown=app:app --from=discovery / /openedx/discovery
 WORKDIR /openedx/discovery

 # Setup empty yml config file, which is required by production settings
 RUN echo "{}" > /openedx/config.yml
-ENV DISCOVERY_CFG=/openedx/config.yml
+ENV DISCOVERY_CFG /openedx/config.yml

-# Install pyenv
-# https://www.python.org/downloads/
-# https://github.com/pyenv/pyenv/releases
-ARG PYTHON_VERSION=3.12.2
-ENV PYENV_ROOT=/opt/pyenv
-# root user is required for below 2 steps, as app user gets permission denied.
-USER root
-RUN git clone https://github.com/pyenv/pyenv $PYENV_ROOT --branch v2.3.36 --depth 1
-# Install Python
-RUN $PYENV_ROOT/bin/pyenv install $PYTHON_VERSION
-USER app
+# Install python venv
+RUN python3 -m venv ../venv/
+ENV PATH "/openedx/venv/bin:$PATH"

-# Create virtualenv
-RUN $PYENV_ROOT/versions/$PYTHON_VERSION/bin/python -m venv /openedx/venv
-ENV PATH=/openedx/venv/bin:$PATH
-
-RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install \
+RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/pip,sharing=shared {% endif %}pip install \
    # https://pypi.org/project/setuptools/
    # https://pypi.org/project/pip/
    # https://pypi.org/project/wheel/
-    setuptools==77.0.3 pip==25.0.1 wheel==0.45.1
+    setuptools==67.7.2 pip==23.1.2. wheel==0.40.0

 # Install a recent version of nodejs
-RUN pip install nodeenv==1.9.1
+RUN pip install nodeenv==1.7.0
 # nodejs version picked from https://github.com/openedx/course-discovery/blob/master/Dockerfile
 RUN nodeenv /openedx/nodeenv --node=16.14.2 --prebuilt
-ENV PATH=/openedx/nodeenv/bin:${PATH}
+ENV PATH /openedx/nodeenv/bin:${PATH}
+# Install npm/bower requirements
+ARG NPM_REGISTRY='{{ NPM_REGISTRY }}'
+RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.npm/,sharing=shared,uid=${APP_USER_ID} {% endif %}npm clean-install --no-audit --registry=$NPM_REGISTRY --production
+RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/bower/,sharing=shared,uid=${APP_USER_ID} {% endif %}./node_modules/.bin/bower install --allow-root --production

 # Install python and nodejs requirements
 # This is identical to "make production-requirements" but it was split in multiple
 # instructions to benefit from docker image caching
 # Install base requirements
-RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install -r requirements.txt
-{% for extra_requirement in DISCOVERY_EXTRA_PIP_REQUIREMENTS %}RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install '{{ extra_requirement }}'
+RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/pip,sharing=shared {% endif %}pip install -r requirements.txt
+{% for extra_requirement in DISCOVERY_EXTRA_PIP_REQUIREMENTS %}RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/pip,sharing=shared {% endif %}pip install '{{ extra_requirements }}'
 {% endfor %}

-# Install npm, bower requirements
-ARG NPM_REGISTRY='{{ NPM_REGISTRY }}'
-RUN --mount=type=cache,target=/openedx/.npm/,sharing=shared,uid=${APP_USER_ID} npm clean-install --verbose --no-audit --registry=$NPM_REGISTRY --production
-RUN --mount=type=cache,target=/openedx/.cache/bower,sharing=shared,uid=${APP_USER_ID} ./node_modules/.bin/bower install --allow-root --production
-
 # Install extra requirements
-RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install \
+RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/pip,sharing=shared {% endif %}pip install \
    # Use redis as a django cache https://pypi.org/project/django-redis/
-    django-redis==5.4.0 \
+    django-redis==5.2.0 \
    # uwsgi server https://pypi.org/project/uWSGI/
-    uwsgi==2.0.28
-
-{% if DISCOVERY_ATLAS_PULL %}
-# Pull translations. Support the OEP-58 proposal behind a feature flag until it's fully implemented.
-RUN atlas pull {{ patch("atlas-extra-args") }} translations/course-discovery/course_discovery/conf/locale:course_discovery/conf/locale
-RUN python manage.py compilemessages
-{% endif %}
+    uwsgi==2.0.21

 # Collect static assets
 COPY --chown=app:app assets.py ./course_discovery/settings/assets.py
 RUN DJANGO_SETTINGS_MODULE=course_discovery.settings.assets make static

-# Create media directory to serve media files
-RUN mkdir course_discovery/media
-
 # Run production server
-ENV DJANGO_SETTINGS_MODULE=course_discovery.settings.tutor.production
+ENV DJANGO_SETTINGS_MODULE course_discovery.settings.tutor.production
 EXPOSE 8000
-CMD ["uwsgi", \
-    "--static-map", "/static=/openedx/discovery/course_discovery/assets", \
-    "--static-map", "/media=/openedx/discovery/course_discovery/media", \
-    "--http", "0.0.0.0:8000", \
-    "--thunder-lock", \
-    "--single-interpreter", \
-    "--enable-threads", \
-    "--processes=2", \
-    "--buffer-size=8192", \
-    "--wsgi-file", "course_discovery/wsgi.py"]
+CMD uwsgi \
+    --static-map /static=/openedx/discovery/course_discovery/assets \
+    --static-map /media=/openedx/discovery/course_discovery/media \
+    --http 0.0.0.0:8000 \
+    --thunder-lock \
+    --single-interpreter \
+    --enable-threads \
+    --processes=2 \
+    --buffer-size=8192 \
+    --wsgi-file course_discovery/wsgi.py
--- a/tutordiscovery/templates/discovery/tasks/lms/init
+++ b/tutordiscovery/templates/discovery/tasks/lms/init
@ -6,13 +6,8 @@
  "from django.contrib.auth import get_user_model;\
  get_user_model().objects.filter(username='lms_catalog_service_user').exclude(email='lms_catalog_service_user@openedx').update(email='lms_catalog_service_user@openedx')"

-./manage.py lms shell -c \
-  "from openedx.core.djangoapps.programs.models import ProgramsApiConfig;\
-  ProgramsApiConfig.current().enabled or \
-  ProgramsApiConfig.objects.create(marketing_path='/programs', enabled=True)"
-
 ./manage.py lms manage_user discovery discovery@openedx --staff --superuser --unusable-password
-./manage.py lms manage_user lms_catalog_service_user lms_catalog_service_user@openedx --staff --unusable-password
+./manage.py lms manage_user lms_catalog_service_user lms_catalog_service_user@openedx --unusable-password

 # Development client
 ./manage.py lms create_dot_application \
@ -62,5 +57,5 @@
 # configuration -- which means that it takes different values for different
 # sites. This is important because the programs and courses returned for each
 # site will differ.
-./manage.py lms create_or_update_site_configuration {{ LMS_HOST }} --configuration '{"COURSE_CATALOG_API_URL": "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ DISCOVERY_HOST }}/api/v1"}' --enabled
-./manage.py lms create_or_update_site_configuration {{ LMS_HOST }}:8000 --configuration '{"COURSE_CATALOG_API_URL": "http://{{ DISCOVERY_HOST }}:8381/api/v1"}' --enabled
+site-configuration set -d {{ LMS_HOST }} COURSE_CATALOG_API_URL {% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ DISCOVERY_HOST }}/api/v1
+site-configuration set -d {{ LMS_HOST }}:8000 COURSE_CATALOG_API_URL http://{{ DISCOVERY_HOST }}:8381/api/v1
--- a/tutordiscovery/utils.py
+++ b/tutordiscovery/utils.py
@ -1,16 +0,0 @@
-import subprocess
-from functools import lru_cache
-
-
-@lru_cache(maxsize=None)
-def is_docker_rootless() -> bool:
-    """
-    A helper function to determine if Docker is running in rootless mode.
-
-     - https://docs.docker.com/engine/security/rootless/
-    """
-    try:
-        results = subprocess.run(["docker", "info"], capture_output=True, check=True)
-        return "rootless" in results.stdout.decode()
-    except subprocess.CalledProcessError:
-        return False
Author	SHA1	Message	Date
Régis Behmo	803894a4dd	feat: Dockerfile optimizations	2023-05-25 10:50:53 +02:00
Muhammad Faraz Maqsood	804b70e42d	fix: fixed dependency error	2023-05-25 12:06:35 +05:00
Muhammad Faraz Maqsood	6eebef14c5	feat: add dependency of lms to discovery	2023-05-25 11:55:26 +05:00
Muhammad Faraz Maqsood	941127c00b	feat: upgrade to palm	2023-05-24 18:16:38 +05:00
				`@ -0,0 +1 @@`
				`- [Improvement] Add a scriv-compliant changelog. (by @regisb)`
				`@ -1 +0,0 @@`
				`DISCOVERY_RUN_ELASTICSEARCH = {{ DISCOVERY_RUN_ELASTICSEARCH }}`
				`@ -1 +0,0 @@`
				`{% if DISCOVERY_RUN_ELASTICSEARCH %}setowner {{ APP_USER_ID }} /mounts/elasticsearch{% endif %}`
				`@ -1 +0,0 @@`
				`{% if DISCOVERY_RUN_ELASTICSEARCH %}- ../../data/elasticsearch:/mounts/elasticsearch{% endif %}`
				`@ -1 +0,0 @@`
				`MFE_CONFIG["ENABLE_PROGRAMS"] = {{ ENABLE_PROGRAMS }}`