Creating a backup of the Eclipse Amlen server in a high availability environment

System administrators can create a secure backup of the Eclipse Amlen high availability (HA) environment by using REST Administration APIs.

To ensure consistency of the backup, perform the backup operation in the HA environment on the standby node.

System administrators can create a secure backup that can be used to restore the Eclipse Amlen configuration and store data. Both of these sets of data are in directories on a file system and can be backed up by using standard system tools. Messaging services remain in progress during the backup operation.

  1. Check that the server is running and is in standby mode using the Eclipse Amlen REST API GET method with the following URI:
    http://<Standby-Server-IP:Port>/ima/v1/service/status/
  2. Messaging on the standby server must be stopped to ensure that the backup is valid during the restore process; however, do not force stop the standby server. Set the Eclipse Amlen server to maintenance mode by using the Eclipse Amlen REST API POST method with the following URI:
    http://<admin-endpoint-IP:port>/ima/v1/service/restart

    Provide configuration data in the payload of the POST method by using the following schema. Content-type is set to application/json:

    
    {    
      "Service": "Server",
      "Maintenance": "start"
    }
  3. When the standby server is in maintenance mode, use your standard system tools to back up the contents of the following directories:
    • var/messagesight/data
    • var/messagesight/store
    Note: If you are operating in a Docker environment, ensure that you mount these directories on the host volume or volumes and back up the corresponding host directory or directories.
  4. Restart the standby server in production mode by using the Eclipse Amlen REST API POST method with the following URI:
    http://<admin-endpoint-IP:port>/ima/v1/service/restart/

    Provide configuration data in the payload of the POST method by using the following schema. Content-type is set to application/json:

    
    {    
      "Service": "Server",
      "Maintenance": "stop"
    }