Merge pull request #2 from Pearson-Advance/vue/PADV-291

PADV 291 - Getting the local environments ready

.github/workflows/provisioning-tests.yml

@@ -26,7 +26,7 @@ jobs:
         os:
           - ubuntu-20.04 # Ubuntu 20.04 "Focal Fossa"
         python-version: [ '3.8' ]
-        services: [ discovery+lms+forum ,registrar+lms, ecommerce+lms, edx_notes_api+lms, credentials+lms, xqueue]
+        services: [ discovery+lms+forum ,registrar+lms, ecommerce+lms, credentials+lms, xqueue]
       fail-fast: false # some services can be flaky; let others run to completion even if one fails
 
     steps:

README.rst

@@ -234,6 +234,22 @@ This data collection is behind a consent flag, so please help devstack's maintai
 
    make metrics-opt-in
 
+For Pearson we also need to configure some hosts in our local hosts file. To make this you would have to open the file `/etc/hosts`, then open the file with your favorite editor and add the following values:
+
+.. code:: sh
+
+    127.0.0.1       lms.pearson.localhost
+    127.0.0.1       lms.main.localhost
+
+    127.0.0.1       edx.devstack.ecommerce
+    127.0.0.1       ecommerce.pearson.localhost
+    127.0.0.1       ecommerce.main.localhost
+
+    127.0.0.1       edx.devstack.discovery
+    127.0.0.1       discovery.pearson.localhost
+    127.0.0.1       discovery.main.localhost
+
+
 Now that you're up and running, read about the `most common development workflow`_.
 
 Usernames and Passwords
@@ -274,6 +290,21 @@ is ``edx``.
 Service List
 ------------
 
+Pearson modifications
+~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+    For optimization reasons, we decided to disable some services that we are not going to use. These are:
+
+    * insights
+    * coursegraph
+    * analyticsapi
+    * notes
+    * opensearch12
+
+    If you want to reactivate these services you can uncomment the definitions on docker-compose.yml, provision.sh, repo.sh, etc
+
 These are the edX services that Devstack can provision, pull, run, attach to, etc.
 Each service is accessible at ``localhost`` on a specific port.
 The table below provides links to the homepage, API root, or API docs of each service,
@@ -373,7 +404,7 @@ because services are in the process of being upgraded to Elasticsearch 7, but no
 support Elasticsearch 7 yet. As we complete these migrations, we will update the dependencies
 of these containers.
 
-
+Be sure that you are installing devstack using an environment in Python 3.8.
 
 Advanced Configuration Options
 ------------------------------

docker-compose-host.yml

@@ -5,19 +5,19 @@ services:
   credentials:
     volumes:
       - ${DEVSTACK_WORKSPACE}/credentials:/edx/app/credentials/credentials
-      - credentials_node_modules:/edx/app/credentials/credentials/node_modules
+      - ../volumes/credentials_node_modules:/edx/app/credentials/credentials/node_modules
       - credentials_tox:/edx/app/credentials/credentials/.tox
       - ${DEVSTACK_WORKSPACE}/src:/edx/src
   discovery:
       volumes:
       - ${DEVSTACK_WORKSPACE}/course-discovery:/edx/app/discovery/discovery
-      - discovery_node_modules:/edx/app/discovery/discovery/node_modules
+      - ../volumes/discovery_node_modules:/edx/app/discovery/discovery/node_modules
       - discovery_tox:/edx/app/discovery/discovery/.tox
       - ${DEVSTACK_WORKSPACE}/src:/edx/src
   ecommerce:
     volumes:
       - ${DEVSTACK_WORKSPACE}/ecommerce:/edx/app/ecommerce/ecommerce
-      - ecommerce_node_modules:/edx/app/ecommerce/ecommerce/node_modules
+      - ../volumes/ecommerce_node_modules:/edx/app/ecommerce/ecommerce/node_modules
       - ecommerce_tox:/edx/app/ecommerce/ecommerce/.tox
       - ${DEVSTACK_WORKSPACE}/src:/edx/src
   forum:
@@ -27,14 +27,14 @@ services:
     volumes:
       - ${DEVSTACK_WORKSPACE}/edx-platform:/edx/app/edxapp/edx-platform
       - edxapp_media:/edx/var/edxapp/media
-      - edxapp_node_modules:/edx/app/edxapp/edx-platform/node_modules
+      - ../volumes/edxapp_node_modules:/edx/app/edxapp/edx-platform/node_modules
       - edxapp_tox:/edx/app/edxapp/edx-platform/.tox
       - edxapp_uploads:/edx/var/edxapp/uploads
       - ${DEVSTACK_WORKSPACE}/src:/edx/src
-  edx_notes_api:
-    volumes:
-      - ${DEVSTACK_WORKSPACE}/edx-notes-api:/edx/app/edx_notes_api/edx_notes_api
-      - ${DEVSTACK_WORKSPACE}/src:/edx/src
+  # edx_notes_api:
+  #   volumes:
+  #     - ${DEVSTACK_WORKSPACE}/edx-notes-api:/edx/app/edx_notes_api/edx_notes_api
+  #     - ${DEVSTACK_WORKSPACE}/src:/edx/src
   registrar:
     volumes:
       - ${DEVSTACK_WORKSPACE}/registrar:/edx/app/registrar/registrar
@@ -45,18 +45,18 @@ services:
     volumes:
       - ${DEVSTACK_WORKSPACE}/edx-platform:/edx/app/edxapp/edx-platform
       - edxapp_media:/edx/var/edxapp/media
-      - edxapp_node_modules:/edx/app/edxapp/edx-platform/node_modules
+      - ../volumes/edxapp_node_modules:/edx/app/edxapp/edx-platform/node_modules
       - edxapp_tox:/edx/app/edxapp/edx-platform/.tox
       - edxapp_uploads:/edx/var/edxapp/uploads
       - ${DEVSTACK_WORKSPACE}/src:/edx/src
-  insights:
-    volumes:
-      - ${DEVSTACK_WORKSPACE}/edx-analytics-dashboard:/edx/app/insights/insights
-      - insights_node_modules:/edx/app/insights/insights/node_modules
-  analyticsapi:
-    volumes:
-      - ${DEVSTACK_WORKSPACE}/edx-analytics-data-api:/edx/app/analytics_api/analytics_api
-      - ${DEVSTACK_WORKSPACE}/src:/edx/src
+  # insights:
+  #   volumes:
+  #     - ${DEVSTACK_WORKSPACE}/edx-analytics-dashboard:/edx/app/insights/insights
+  #     - insights_node_modules:/edx/app/insights/insights/node_modules
+  # analyticsapi:
+  #   volumes:
+  #     - ${DEVSTACK_WORKSPACE}/edx-analytics-data-api:/edx/app/analytics_api/analytics_api
+  #     - ${DEVSTACK_WORKSPACE}/src:/edx/src
 
   # Note that frontends mount `src` to /edx/app/src instead of /edx/src.
   # See ADR #5 for rationale.
@@ -118,14 +118,16 @@ services:
       - ${DEVSTACK_WORKSPACE}/frontend-app-publisher:/edx/app/frontend-app-publisher
       - frontend_app_publisher_node_modules:/edx/app/frontend-app-publisher/node_modules
       - ${DEVSTACK_WORKSPACE}/src:/edx/app/src
+  frontend-app-sidebar-navigation:
+    volumes:
+      - ${DEVSTACK_WORKSPACE}/frontend-app-sidebar-navigation:/edx/app/frontend-app-sidebar-navigation
+      - frontend_app_sidebar_navigation_node_modules:/edx/app/frontend-app-sidebar-navigation/node_modules
+      - ${DEVSTACK_WORKSPACE}/src:/edx/app/src
 
 volumes:
   credentials_node_modules:
-  discovery_node_modules:
-  ecommerce_node_modules:
   insights_node_modules:
   edxapp_media:
-  edxapp_node_modules:
   edxapp_uploads:
   frontend_app_account_node_modules:
   frontend_app_profile_node_modules:
@@ -138,6 +140,7 @@ volumes:
   frontend_app_payment_node_modules:
   frontend_app_program_console_node_modules:
   frontend_app_publisher_node_modules:
+  frontend_app_sidebar_navigation_node_modules:
   credentials_tox:
   discovery_tox:
   ecommerce_tox:

docker-compose-themes.yml

@@ -3,13 +3,13 @@ version: "2.1"
 services:
   discovery:
       volumes:
-      - ${DEVSTACK_WORKSPACE}/edx-themes:/edx/app/edx-themes
+      - ${DEVSTACK_WORKSPACE}/openedx-themes:/edx/app/edx-themes
   ecommerce:
       volumes:
-      - ${DEVSTACK_WORKSPACE}/edx-themes:/edx/app/edx-themes
+      - ${DEVSTACK_WORKSPACE}/openedx-themes:/edx/app/edx-themes
   lms:
       volumes:
-      - ${DEVSTACK_WORKSPACE}/edx-themes:/edx/app/edx-themes
+      - ${DEVSTACK_WORKSPACE}/openedx-themes:/edx/app/edx-themes
   studio:
       volumes:
-      - ${DEVSTACK_WORKSPACE}/edx-themes:/edx/app/edx-themes
+      - ${DEVSTACK_WORKSPACE}/openedx-themes:/edx/app/edx-themes