tutor/docs/tutorials/datamigration.rst

Making backups and migrating data
---------------------------------

With Tutor, all data are stored in a single folder. This means that it's extremely easy to migrate an existing platform to a different server. For instance, it's possible to configure a platform locally on a laptop, and then move this platform to a production server.

1. Make sure `tutor` is installed on both servers with the same version.
2. Stop any running platform on server 1::

    tutor local stop

3. Transfer the configuration, environment, and platform data from server 1 to server 2::

    rsync -avr "$(tutor config printroot)/" username@server2:/tmp/tutor/

4. On server 2, move the data to the right location::

    mv /tmp/tutor "$(tutor config printroot)"

5. Start the instance with::

    tutor local start -d

Making database dumps
---------------------

To dump all data from the MySQL and Mongodb databases used on the platform, run the following commands::

    tutor local exec \
        -e USERNAME="$(tutor config printvalue MYSQL_ROOT_USERNAME)" \
        -e PASSWORD="$(tutor config printvalue MYSQL_ROOT_PASSWORD)" \
        mysql sh -c 'mysqldump --all-databases --user=$USERNAME --password=$PASSWORD > /var/lib/mysql/dump.sql'
    tutor local exec mongodb mongodump --out=/data/db/dump.mongodb

The ``dump.sql`` and ``dump.mongodb`` files will be located in ``$(tutor config printroot)/data/mysql`` and ``$(tutor config printroot)/data/mongodb``.
docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`. 2021-09-16 08:53:52 +00:00			`Making backups and migrating data`
			`---------------------------------`

			`With Tutor, all data are stored in a single folder. This means that it's extremely easy to migrate an existing platform to a different server. For instance, it's possible to configure a platform locally on a laptop, and then move this platform to a production server.`

			1. Make sure `tutor` is installed on both servers with the same version.
			`2. Stop any running platform on server 1::`

			`tutor local stop`

minor typos fixed 2022-03-27 10:36:55 +00:00			`3. Transfer the configuration, environment, and platform data from server 1 to server 2::`
docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`. 2021-09-16 08:53:52 +00:00
			`rsync -avr "$(tutor config printroot)/" username@server2:/tmp/tutor/`

			`4. On server 2, move the data to the right location::`

			`mv /tmp/tutor "$(tutor config printroot)"`

			`5. Start the instance with::`

			`tutor local start -d`

			`Making database dumps`
			`---------------------`

			`To dump all data from the MySQL and Mongodb databases used on the platform, run the following commands::`

docs: specify root username in mysql dump instructions The default user in the mysql container is 'mysql', so the `mysql` command tries to use the 'mysql' MySQL user by default. But, in the MySQL dump instructions, we are providing the MySQL root user's password, so we need to specify `MYSQL_ROOT_USERNAME` as the MySQL user when invoking `mysql`. 2022-05-19 16:50:18 +00:00			`tutor local exec \`
			`-e USERNAME="$(tutor config printvalue MYSQL_ROOT_USERNAME)" \`
			`-e PASSWORD="$(tutor config printvalue MYSQL_ROOT_PASSWORD)" \`
			`mysql sh -c 'mysqldump --all-databases --user=$USERNAME --password=$PASSWORD > /var/lib/mysql/dump.sql'`
docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`. 2021-09-16 08:53:52 +00:00			`tutor local exec mongodb mongodump --out=/data/db/dump.mongodb`

			The ``dump.sql`` and ``dump.mongodb`` files will be located in ``$(tutor config printroot)/data/mysql`` and ``$(tutor config printroot)/data/mongodb``.