Upgrading Opencast from 12.x to 13.x

This guide describes how to upgrade Opencast 12.x to 13.x. In case you need information about how to upgrade older versions of Opencast, please refer to older release notes.

  1. Stop your current Opencast instance
  2. Replace Opencast with the new version
  3. Read the release notes (especially the section of behaviour changes)
  4. Review the configuration changes and adjust your configuration accordingly
  5. Migrate the database
  6. Start Opencast
  7. Rebuild the Elasticsearch indexes

Configuration Changes

etc/org.apache.felix.fileinstall-workflows.cfg:

etc/org.opencastproject.db.DBSessionFactoryImpl.cfg:

etc/org.opencastproject.ingest.impl.IngestServiceImpl.cfg:

etc/org.opencastproject.liveschedule.impl.LiveScheduleServiceImpl.cfg:

etc/org.opencastproject.organization-mh_default_org.cfg:

etc/org.opencastproject.plugin.impl.PluginManagerImpl.cfg:

etc/org.opencastproject.serviceregistry.impl.JobDispatcher.cfg:

etc/org.opencastproject.serviceregistry.impl.ServiceRegistryJpaImpl.cfg:

etc/org.opencastproject.speechtotext.impl.SpeechToTextServiceImpl.cfg:

etc/org.opencastproject.speechtotext.impl.engine.WhisperEngine.cfg:

etc/org.opencastproject.transcription.amberscript.AmberscriptTranscriptionService.cfg:

etc/org.opencastproject.ui.metadata.CatalogUIAdapterFactory-episode-common.cfg and etc/org.opencastproject.ui.metadata.CatalogUIAdapterFactory-series-common.cfg:

etc/org.opencastproject.userdirectory.ldap.cfg.template:

etc/org.opencastproject.videoeditor.impl.VideoEditorServiceImpl.cfg:

etc/email/errorDetails:

etc/listproviders/event.upload.asset.options.properties:

etc/security/mh_default_org.xml:

Workflow changes:

Database Migration

You can find database upgrade scripts in docs/upgrade/12_to_13/. These scripts are suitable for both, MariaDB and PostgreSQL. Changes include DB schema optimizations as well as fixes for the new workflow tables.

Rebuild the Elasticsearch Indexes

The 13.0 release contains multiple changes to the Elasticsearch indexes an requires a rebuild.

Start your new Opencast and make an HTTP POST request to /index/rebuild.

Example (using cURL):

curl -i -u <admin_user>:<password> -s -X POST https://example.opencast.org/index/rebuild

You can also just open the REST documentation, which can be found under the “Help” section in the admin interface (the “?” symbol at the top right corner). Then go to the “Index Endpoint” section and use the testing form on /rebuild to issue a POST request.

In both cases you should get a 200 HTTP status.