This document describes the steps required to migrate from a native installation (using Ansible scripts) to a Tutor deployment of the Open edX platform. This document will outline steps for:
Single instance installation
Not using external services for MongoDB and MySQL running on the same VM
Migrate to the same Open edX version
For any specific use case, feel free to ask questions in the tutor forum.
Identify tutor plugins that you need based on the Open edX services that you use.
Backup data from your native installation.
Install tutor and the different plugins you need
Customise your tutor instance to match your native configuration
(Optional) Maintain your tutor instance
1. Getting ready
First, make a list of services that your Open edX instance rely on. The native installation script installs a lot of services (e.g. edx-analytics-api by default but unless you configured them you probably don’t need them.
docker exec -i tutor_local_mysql_1 sh -c 'exec mysql -uroot -p"MYSQL_ROOT_PASSWORD"' < /home/user/mysql-data-20210504T110001.sql
You can find your MYSQL_ROOT_PASSWORD using tutor config printvalue MYSQL_ROOT_PASSWORD.
Copy your MongoDB backup to $TUTOR_ROOT/data/mongodb.
Run tutor local exec mongodb bash.
Run mongorestore -d openedx /data/db/edxapp/.
Remove the export rm -r /data/db/edxapp.
Copy the content from /edx/var/edxapp/media to $TUTOR_ROOT/data/openedx-media.
The following steps are for guidance only, make sure they are suitable for your use case.
Tutor takes care of the configuration of the different services. For a service like discovery, it includes configuring the site, the partners and the OAuth clients. Unless you have a particular use case, the easiest way forward is to let Tutor handle the initialisation of the services as this makes upgrading to different Open edX release versions easier.
To be able to use the profile images that you’ve copied from you media folder, you need to copy the PROFILE_IMAGE_SECRET_KEY setting from your native configuration in the openedx-lms-production-settings patch.