edX Devstack

Get up and running quickly with edX services.

If you are seeking info on the Vagrant-based devstack, please see https://openedx.atlassian.net/wiki/display/OpenOPS/Running+Devstack. This project is meant to replace the traditional Vagrant-based devstack with a multi-container approach driven by Docker Compose. It is still in the alpha/beta testing phase. Support for this project is limited at the moment, so it may take a while to respond to issues.

You should run any Make targets described below on your local machine, not from within a VM.

Prerequisites

This project was developed and tested using Docker 1.13+. If you are using OS X, please use Docker for Mac. Previous Mac-based tools (e.g. boot2docker) are not supported.

Docker for Windows may work but has not been tested and is not supported.

Getting Started

All of the services can be run by following the steps below. Note that since we are running many containers, you should configure Docker with a sufficient amount of resources. Our testing found that configuring Docker for Mac with 2 CPUs and 4GB of memory works well.

1. Create a Python 3 virtualenv. If you're using virtualenvwrapper, you can do this with:

$ mkvirtualenv devstack --python=$(which python3)

Source the virtualenv and install requirements:

$ workon devstack
(devstack)$ make requirements

2. The Docker Compose file mounts a host volume for each service's executing code. The host directory is expected to be a sibling of this directory. For example, if this repo is cloned to ~/workspace/devstack, host volumes will be expected in ~/workspace/course-discovery, ~/workspace/ecommerce, etc. These repos can be cloned with the command below.

(devstack)$ make clone

3. Run the provision command, if you haven't already, to configure the various services with super-users (for development without the auth service) and tenants (for multi-tenancy).

   The username and password for the superusers are both "edx". You can access the services directly via Django admin at the /admin/ path, or login via single sign-on at /login/.

   (devstack)$ make devstack.provision
   

4. Start the services.

   (devstack)$ make devstack.start
   

After the services have started, if you need shell access to one of the services, run make devstack.open.<service>. For example to access the Catalog/Course Discovery Service, you can run:

(devstack)$ make devstack.open.discovery

Remaining Work

There is still work to be done before this is ready for full release to the Open edX community. Here are the major items:

1. Align with OEP-5
2. Finish provisioning all services
3. Load demo data
4. PyCharm debugging
5. Merge devstack settings for edxapp (https://github.com/edx/edx-platform/pull/14376), and reactivate host volume