There are 2 options for backup and restore in EDG. The first is the built in backup and restore utility in EDG. The second is a manual process.  The same steps and options to backup EDG are also applicable for Explorer.

EDG Backup and Restore Utility

Starting in EDG version 6.4.2, a new feature has been added for Administrators of EDG to take backups of the collections in the workspace and restore from a backup if needed. Restores should be reserved for disaster recovery purposes. Please test it in a development environment to get familiar with the process. Note, this is memory intensive. If your server is low on memory, the restore could fail. We recommend manually running garbage collection prior to a restore through the memory management page. This feature should not replace any existing backup strategy you have for your organization, only supplement and enhance it.

Important details prior to using this feature:

  • Backups can be downloaded to local machine of user or stored in AWS S3 bucket. They are also stored in Tomcat\webapps\edg\config\restore folder upon doing a restore. This is in case of rollback. If you are doing frequent restores, please clear this folder out periodically to save disk space.
  • Everything in the workspace will be backed up/restored besides EDG system files and configurations. During the restore process, if there are any TDB databases (including new collections you have created) in the system that do not exist in the backup you are restoring, they will be cleared.  Any other files in custom projects will remain, regardless of if they were in the backup or not.
  • This feature is only available for TDB backed data, not RDBMS. Data Platform backup and restore is available with EDG 6.4.3 but requires manual intervention for restore. See steps below.
  • Once a restore is in progress do not navigate away from the page or shutdown the server. It may take time to do the restore, so please let it finish. If you get an error then you may have to restart Tomcat.

Data Platform restore steps:

  1. Shutdown EDG nodes and Data Platform
  2. Download the backup locally, and unzip
  3. Take dp-server.zip from the backup
  4. Copy it to the DP server file system
  5. Unzip it
  6. Move the data in the unzipped folder to whatever you used for –base, if necessary
  7. Re-zip the rest of the backup (minus dp-server.zip) for use on each EDG node

For each EDG node:

  1. Ensure Data Platform is offline
  2. Ensure tomcat is shut down on all EDG nodes.
  3. Place the rest of the backup(from step 7 above) in ~tomcatdir/webbapps/edgDir/WEB-INF/config/restore/backup/ for the primary EDG node. Create this directory if it doesn’t exist.
  4. Copy the current web.xml to the same directory for this same EDG node
  5. Take the web.xml from ~tomcatdir\webapps\edgDir\config\restore and put in WEB-INF for this same EDG node.
  6. In the workspace for this primary EDG node, delete the Zone folder and _Data folders
  7. Start tomcat on the primary EDG node
  8. Send a POST request to /edg/restore or start the restore through the backup and restore utility.
  9. Wait for this to completely finish
  10. Turn on data platform
  11. Test to ensure the data looks correct and is syncing to the Data Platform
  12. Once verified, in the remainder of the EDG nodes workspaces, move the workspace outside of the directory so that EDG will create a new one.
  13. Start each EDG node and let it sync.

Manual Backup of EDG

 

TDB

  1. Stop your EDG server, because the backup must occur offline.
  2. Backup your entire workspace, by performing a tar or zip operation on it. This will also backup the TDB databases with it.
  3. Start EDG backup once all of the above steps have been completed.

Data Platform

  1. Stop your EDG servers, because the backup must occur offline.
  2. Backup your entire workspace, by performing a tar or zip operation on it.
  3. Backup your Data Platform database.
  4. Store these two files together offline.
  5. Start EDG backup once all of the above steps have been completed.

 

RDBMS

  1. Backup your entire workspace, by server snapshot or other.
  2. Backup your configured database. See your RDBMS manufacturer’s website for more information. NOTE: Be sure to backup the correct database/schema, as configured for your EDG server.
  3. Store these two files together offline.

Manual Restore of EDG

 

TDB

  1. Stop EDG server.
  2. Locate and delete (or move out of the directory) your current EDG workspace. The workspace location is stored in the web.xml file.
  3. Replace the existing EDG workspace with your backed-up copy.
  4. Start EDG server.

Data Platform

  1. Stop EDG server.
  2. Stop DP server.
  3. Locate and delete  (or move out of the directory) your current EDG workspace. The workspace location is stored in the web.xml file.
  4. Replace the existing EDG workspace with your backed-up copy.
  5. Replace your Data Platform database with your backed-up copy.
  6. Start DP server.
  7. Start EDG server.

RDBMS

  1. Stop EDG server.
  2. Locate and delete (or move out of the directory) your current EDG workspace. The workspace location is stored in the web.xml file.
  3. Replace the existing EDG workspace with your backed-up copy.
  4. Restore your database from the backup. See your DBA for this step.
  5. Before starting EDG confirm that your EDG is set up to point at your newly restored database. This can be done by editing  [Workspace]/server.topbraidlive.org/dynamic/config.ttl and confirming settings, e.g., the URL points at the newly restored database.
  6. Start EDG server.

Backup and Recovery of Supported Relational Databases (RDBMS)

See your DBA for this. Relevant instruction examples (only) below.