.. include:: /includes.rst.txt

.. comments - headings

   # with overline, for parts
   * with overline, for chapters
   = for sections
   - for subsections
   ^ for subsubsections
   " for paragraphs
   * for H5
   + for H6

.. index:: pair: TopBraid EDG ; Upgrading

.. _upgrading:

Upgrading from Previous Versions
================================

You can upgrade from any previous release straight to the current release.

.. warning::
  **Upgrade a test/development environment** successfully before upgrading
  any production environment. This is especially important when the
  EDG workspace includes UI or model customizations.

.. warning::
  Workspaces **cannot be downgraded** once upgraded. To revert to a
  previous version of EDG, you must restore the workspace from a
  backup (see :ref:`edg_backup_and_restore`) taken before upgrade.


.. _migration_notes:

Migration Notes
---------------

.. warning::
  Before upgrading, **review all Migration Notes** starting
  at the version you are currently on and following along to the current
  release. The migration notes contain additional steps that must be
  done before, during or after the upgrade to keep EDG functioning
  and to prevent data loss.

.. toctree::
   :maxdepth: 1

   migration_7.6
   migration_7.7
   migration_7.8
   migration_8.0
   migration_8.0.1
   migration_8.1
   migration_8.2
   migration_8.3


Upgrade steps from earlier 8.x releases to latest 8.x release
-------------------------------------------------------------

#. Stop Tomcat, make sure the process is fully stopped

#. Backup the workspace directory

#. Backup and remove the ``/edg`` directory and ``edg.war`` file located in Tomcat's ``webapps`` directory

#. Place the current release’s ``edg.war`` file found in the download package into Tomcat's ``webapps`` directory

#. Clear Tomcat's ``work`` and ``temp`` directories

#. Start Tomcat

#. Perform any steps from the :ref:`migration_notes` applicable to your installation

#. Test for refressions


Upgrade steps from 6.x/7.x to latest 8.x release
------------------------------------------------

.. note::
  This requires an **upgrade from Tomcat 8/9 to Tomcat 10**. The steps given here
  assume that EDG will be installed on a **fresh Tomcat 10 installation** in a
  different location from the old Tomcat.

.. warning::
  **This is a major upgrade.** Carefully read all the instructions prior to beginning!

#. Read the :ref:`migration notes for upgrading to 8.0 <migration_8_0>` and take note of any additional steps that apply to your installation

#. Recommended: Take screenshots of the EDG settings on the Rights Management page. Have the credentials and connections strings/URLs handy for Explorer and S3 connections.

#. Stop the old Tomcat instance, make sure the process is fully stopped

#. **Back up everything** (workspace, vault, Tomcat installation, etc.)

#. Follow the steps for :ref:`installing a new EDG server <edg_server_installation>`, but using the existing ``edg-setup.properties`` setup file and existing workspace location