This section describes how to install the Open edX Eucalyptus release.
The Open edX Eucalyptus release contains several new features for learners, course teams, and developers. For more information, see Open edX Eucalyptus Release.
A Git tag identifies the version of Open edX code that is the Eucalyptus release. You can find the most up-to-date Git tag for the current Open edX release on the Open edX Releases Wiki page.
The following Open edX Git repositories have the Eucalyptus Git tag.
You can install the Open edX Eucalyptus release using Devstack or Fullstack.
Review the prerequisites and instructions for each option, and then choose the option that best meets your needs. Ensure that you install the required software to run the Open edX platform.
If you are upgrading from the Dogwood release, see Upgrading from Dogwood to Eucalyptus.
Eucalyptus releases have Git tag names like
The available names are detailed on the Open edX Releases Wiki page.
You can upgrade an Open edX instance that is running the Dogwood release to the
Eucalyptus release. EdX provides the
upgrade.sh script if you have a simple
Dogwood installation and want to upgrade it automatically. If you have a more
complex or customized installation, you may need to upgrade manually.
The upgrade.sh script is in the edX configuration repository on GitHub.
The upgrade script is only for upgrading instances running the Dogwood release. If your instance is running a release prior to the Dogwood release, follow the instructions to upgrade it to each intervening release, and then upgrade from Dogwood to Eucalyptus.
Before upgrading your Open edX instance, back up all data and configuration files. Then verify that you can restore your Open edX instance from the backup files.
On the computer or virtual machine that is running the Dogwood release of Open edX, run the upgrade script for your type of installation.
Download the script.
$ export OPENEDX_RELEASE=open-release/eucalyptus.1 $ curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/vagrant/upgrade.sh
Run the script.
bash upgrade.sh -c devstack.
bash upgrade.sh -c fullstack.
You can find the most up-to-date Git tag for the current Open edX release on the Open edX Releases Wiki page.
You can also run
bash upgrade.sh -h to see which other options the script
The script creates a temporary directory in which it upgrades Open edX, then cleans up extra files and directories when it finishes running.
After upgrading Open edX to the Eucalyptus release, start the LMS and Studio and verify that course content and data was migrated correctly.
Occasionally, we release updates to Eucalyptus. For example, the second
release of Eucalyptus is
The steps to upgrade differ based on your original installation method.
Devstack and Fullstack are installed using Vagrant. To upgrade to a Eucalyptus point release, follow these steps in the host operating system.
$ export OPENEDX_RELEASE=open-release/eucalyptus.2 $ vagrant provision