Contact Us 1-800-596-4880
  1. Homepage
  2. Runtime Fabric (1.6)
  3. Manage Runtime Fabric

  4. Backup and Restore Runtime Fabric

Back up and Restore Runtime Fabric

Prerequisites

Before performing a backup or restore operation, verify that Runtime Fabric was installed or upgraded using installer version 1.1.1581474166 or later, and that the rtfctl CLI tool is upgraded to version 0.2.95 or later. The versions can be verified by running rtfctl version on a Runtime Fabric node.

To preserve applications in the event of system failure, ensure that Runtime Fabric is automatically backed up. MuleSoft highly recommends configuring hourly backups. Store your backup archive on external storage outside the Runtime Fabric cluster.

The state of Runtime Fabric is distributed across its controller nodes. Use the following procedures to back up and restore the required state necessary for all deployed applications, management services, and their configurations. Individual node backup and restore operations are not supported.

Create a Backup

To create a backup:

  1. Run the following command on any controller node in the cluster as a privileged user (with root access):

    ./rtfctl backup <path_to_backup_file>

    This command creates an archive of the current system state in <path_to_backup_file>, which can be any path in the file system that you have write access to, for instance /opt/anypoint/runtimefabric/backup.tar.gz.

  2. Move the archive file to secure storage (a different machine that is not part of the RTF cluster); for example:

    scp your_username@remotehost:/opt/anypoint/runtimefabric/backup.tar.gz /backup-path/to-restore.tar.gz

Restore a Cluster

To restore a Runtime Fabric cluster from a backup, you can use the existing Runtime Fabric cluster or create a new Runtime Fabric cluster with the same hardware (number of servers, disks, and so on) as the cluster being restored.

You can not restore Runtime Fabric on a newer version of the Runtime Fabric cluster. The new installation must use the same version of Runtime Fabric installation bundle as the backup.

  1. Log in to a controller node in your Runtime Fabric as a privileged user (with root access).

  2. Move the compressed backup archive file to a folder in any of the controller nodes of the environment to be restored. You can transfer this file securely via the following command:

    scp /backup-path/to-restore.tar.gz your_username@remotehost:/opt/anypoint/runtimefabric/

  3. Restore the cluster from the backup archive:

    rtfctl restore /opt/anypoint/runtimefabric/to-restore.tar.gz

This process requires a few minutes.

See Also