Manual upgrade for MarkLogic AWS AMI

Procedure

To upgrade manually the MarkLogic AMI, follow these steps:

Before proceeding, if required, Subscribe to the new version of the Progress MarkLogic Server product (example: for a new major MarkLogic version) and Accept Terms.

1. Launch a new small MarkLogic instance from the AWS MarketPlace, based on the latest available image. For example, t2.small based on MarkLogic Developer Edition v. 11 (or 12 Bring Your Own License or BYOL). 
Planning to leverage the PAYG-PayAsYouGo model requires selection of MarkLogic Essential Enterprise.
a. Search the required MarkLogic AMI from AWS MarketPlace, then select and click Launch:
 

Select the appropriate Launch method and continue.
below instructions follow "Launch from EC2 Console" launch method. Select required version (usually latest, select by default) and Region and click "Launch from EC2":

b. Choose Name and tags for the new instance.
c. Choose Instance Type. For example, t3.large
d. Configure rest of the instance details. For example, Network settings with default VPC with a public IP for easy access and Storage details. 
e. Configure Security Group - only SSH access is needed for the upgrade procedure
f. Review and click Launch instance

2. SSH into the new instance and switch the user to root in order to execute the commands in the following steps.

$ sudo su -

Optionally, use "sudo ..." for each individual command.

3. Stop MarkLogic and uninstall MarkLogic rpm:

$ systemctl stop MarkLogic
$ rpm -e MarkLogic

4. Update-patch the OS:

$ yum -y update

Refer to Note 3 and 4.

5. Install the new MarkLogic rpm
a. Upload MarkLogic rpm to the instance. (For example, via "scp" or S3)
b. Install the rpm:

$ yum install [<path_to_MarkLogic_RPM>]/[MarkLogic_RPM]

Refer to Note 1.

6. Double check to be sure that the following files and log traces do not exist. If they do, they must be deleted.

$ rm -f /var/local/mlcmd.conf
$ rm -f /var/tmp/mlcmd.trace
$ rm -f /tmp/marklogic.host

7. Remove artifacts
Important: Performing the following actions will remove the ability to ssh back into the baseline image. New credentials are applied to the AMI when launched as an instance. If more changes are required, mount the root drive to another instance to make changes.

$ rm -f /root/.ssh/authorized_keys
$ rm -f /home/ec2user/.ssh/authorized_keys
$ rm -f /home/ec2-user/.bash_history
$ rm -rf /var/spool/mail/*
$ rm -rf /tmp/userdata*
$ rm -f [<path_to_MarkLogic_RPM>]/[MarkLogic_RPM]
$ rm -f /root/.bash_history
$ rm -rf /var/log/*
$ sync

8. Optional - Create an AMI from the stopped instance [Note 4]. The AMI can be created at the end of step 7.

$ init 0

At this point, the custom AMI should be ready for use in deployments. When using multiple AWS regions, the AMI must be copied as needed.

Note 1. Do not start MarkLogic at any point of AMI's preparation.
Note 2. While the Service command may still work on some older systems to manage MarkLogic service, it is not supported on Amazon Linux 2023 and newer (systemd-based) distributions. Refer to the Progress Article listed below.
Note 3: If needed, restart the instance (For example: after a kernel upgrade/core-libraries).
Note 4: If additional custom options/configuration/updates are desired, they should be added between steps 4 and 5.


References to Other Documentation:

AWS documentation: Creating an AMI from an Amazon EC2 Instance
https://docs.aws.amazon.com/toolkit-for-visual-studio/latest/user-guide/tkv-create-ami-from-instance.html

Enabling a MarkLogic Server for EC2 AMI
https://docs.progress.com/bundle/marklogic-server-on-aws-11/page/topics/getting-started-with-marklogic-server-on-aws/enabling-a-marklogic-server-for-ec2-ami.html

Launching an AMI with EC2 Console
https://developer.marklogic.com/products/cloud/aws/#launching-an-ami-with-ec2-console

Upgrading the MarkLogic AMI
https://docs.marklogic.com/guide/ec2/managing#id_69624 


Progress Article(s):
MarkLogic: Upgrade MarkLogic on AWS Using Custom AMIs
How to manage (start, stop, or restart) MarkLogic service on RHEL