Upgrading MarkLogic on AWS

You can upgrade from any version of MarkLogic instance on AWS to a later version. To upgrade a MarkLogic instance on AWS, you must update the AMI IDs in your original CloudFormation template.

You cannot upgrade your CloudFormation template to a different version. You must keep your original CloudFormation template. Upgrades are supported by updating the AMI IDs in your original CloudFormation template with the AMI IDs from the MarkLogic version to which you are upgrading.

The following procedure describes how to upgrade your stack to use AMI IDs for a later version of MarkLogic:

1. Download the CloudFormation template for the later version of MarkLogic at Deploying in the Cloud.

2. Navigate to your AWS CloudFormation console, and select your original CloudFormation template used to create the stack. Download your original template currently used by the stack to ensure any modifications made to the CloudFormation template are preserved after the upgrade.

   1. Click Actions.

   2. In the Actions menu, click View/Edit template in Designer.

   3. To download the template, click the file icon > Save.

   4. Select Local File, name the file, and click Save.

3. Locate the AMI IDs in your downloaded original template, and find the corresponding AMI IDs in the new template. For example, the LicenseRegion2AMI and AWSRegionArch2AMI definitions in your original template might look like the following:

   Note:

   CloudFormation templates for MarkLogic 9.0-5 or a later version of MarkLogic are in YAML data format.

   YAML

   Copy

   LicenseRegion2AMI
    us-east-1:
     Enterprise: ami-08dcfd988a2988e01
     BYOL: ami-078c0f5757e1ffdd7
   

   Copy

    us-east-1
     Enterprise: ami-0ac019c39cac73c89
     BYOL: ami-0ea837234c4c34363
   

   In the original template, you can modify LicenseRegion2AMI or AWSRegionArch2AMI as follows:

   YAML

   Copy

   LicenseRegion2AMI
    us-east-1:
     Enterprise: ami-0ac019c39cac73c89
     BYOL: ami-0ea837234c4c34363
   

4. Take a backup for each database on your cluster. If the backup fails, use MarkLogic database backup and restore. For details, see Backup and Restore Overview in Administrate MarkLogic Server.

   Note:

   MarkLogic database backup and restore does not back up your configuration.

   Warning:

   Do not use EBS Volume snapshot for backup purposes unless MarkLogic is completely stopped at the time of the snapshot.

5. Navigate to your AWS CloudFormation console, and select the CloudFormation template used to create the stack.

   • Click Update.

   • Upload the modified CloudFormation template.

6. In the EC2 Dashboard, terminate one instance at a time, called a rolling upgrade. After terminating an instance, wait for the terminated instance to come up and reconnect without any UI interaction. After the instance comes up, navigate to the Admin Interface to check the software version installed on each host. For details, see Understanding Rolling Upgrades in Administrate MarkLogic Server.

   Warning:

   Before terminating your instance, MarkLogic recommends you stop all traffic to the cluster during the upgrade.

   Warning:

   You must revert forest replicas back to the original primary hosts. Otherwise, you will experience degraded performance. For details, see Reverting a Failed Over Forest Back to the Primary Host in the Scalability, Availability, and Failover Guide.

7. After terminating your last instance, navigate to the Admin Interface (8001 port) where the security database upgrade prompt will be displayed. (security-upgrade.xqy screen)

8. Click OK and wait for the upgrade to complete on the instance.