2.5. Open edX Koa Release#

This section describes how to install the Open edX Koa release.

2.5.1. What’s Included in Koa#

The Open edX Koa release contains several new features for learners, course teams, and developers. For more information, see the Open edX Platform Release Notes.

2.5.2. What Is the Koa Git Tag?#

A git tag identifies the version of Open edX code that is the Koa release. About three dozen repositories are tagged as part of an Open edX release. Many other repositories are installed as dependencies of those repositories. You can find the most up-to-date git tag for Koa on the Open edX Named Releases page.

2.5.3. Installing the Koa Release#

You can install the Open edX Koa release using either devstack or the Open edX Native Installation instructions.

Koa releases have git tag names like open-release/koa.1. The available names are detailed on the Open edX Named Releases page.

2.5.4. Upgrading from the Juniper Release#

The recommended approach to upgrading an existing installation of the Open edX Juniper release to the Koa release is to make a fresh installation of the Koa release on a new machine, and move your data and settings to it.

To move and upgrade your Juniper data onto a Koa installation, follow these steps.

  1. Be sure that your Juniper installation is on the latest commit from open-release/juniper.master. This ensures that your database is fully migrated and ready for upgrade to Koa.

  2. Stop all services on the Juniper machine.

  3. Dump the data on the Juniper machine. Here’s an example script that will dump the MySQL and Mongo databases into a single .tgz file. The script will prompt for the MySQL and Mongo passwords as needed.

    MYSQL_CONN="-uroot -p"
    echo "Reading MySQL database names..."
    mysql ${MYSQL_CONN} -ANe "SELECT schema_name FROM information_schema.schemata WHERE schema_name NOT IN ('mysql','information_schema','performance_schema', 'sys')" > /tmp/db.txt
    DBS="--databases $(cat /tmp/db.txt)"
    NOW="$(date +%Y%m%dT%H%M%S)"
    echo "Dumping MySQL structures..."
    mysqldump ${MYSQL_CONN} --add-drop-database --skip-add-drop-table --no-data ${DBS} > ${SQL_FILE}
    echo "Dumping MySQL data..."
    # If there is table data you don't need, add --ignore-table=tablename
    mysqldump ${MYSQL_CONN} --no-create-info ${DBS} >> ${SQL_FILE}
    for db in edxapp cs_comments_service; do
        echo "Dumping Mongo db ${db}..."
        mongodump -u admin -p -h localhost --authenticationDatabase admin -d ${db} --out mongo-dump-${NOW}
    tar -czf openedx-data-${NOW}.tgz ${SQL_FILE} mongo-dump-${NOW}
  4. Copy the .tgz data file to the Koa machine.

  5. Stop all services on the Koa machine.

  6. Restore the Juniper data into the Koa machine. As an example, you might use the following commands.

    $ tar -xvf openedx-data-20200411T154750.tgz
    $ mysql -uroot -p < mysql-data-20200411T154750.sql
    $ mongorestore -u admin -p -h localhost --authenticationDatabase admin --drop -d edxapp mongo-dump-20200411T154750/edxapp
    $ mongorestore -u admin -p -h localhost --authenticationDatabase admin --drop -d cs_comment_service mongo-dump-20200411T154750/cs_comment_service_development
  7. Run the Koa migrations, which will update your Juniper data to be valid for Koa:

    $ /edx/app/edx_ansible/edx_ansible/util/install/native.sh --tags migrate
  8. Copy your configuration files from the Juniper machine to the Koa machine.

  9. Restart all services.

2.5.5. Upgrading to a Subsequent Koa Release#

Occasionally, we release updates to Koa. For example, the second release of Koa will be open-release/koa.2. The steps to upgrade differ based on your original installation method. Upgrading a Docker Installation#

Devstack is installed using Docker. To upgrade from one Koa release to another, follow the instructions in devstack. Upgrading a Native Installation#

If you installed Open edX using the Open edX Native Installation, you can upgrade from one Koa release to another by re-running those steps using your desired Koa tag as the new value for OPENEDX_RELEASE.