Upgrading Local Edition cluster from 5.2.0, 5.3.0,5.3.1, or 5.4.0 to 5.4.1

The Local Edition cluster can be upgraded in place from a version 5.2.0, 5.3.0,5.3,5.3.1 or 5.4 to version 5.4.1.

Note: The following steps are applicable to Swarm environment in Untethered mode.

Prerequisites

  • Local Edition 5.4.1 images must be built and pushed to the desired registry for deployment.
  • For customization done to the JSON properties files in previous versions, the deployment scripts of Local Edition 5.4.1 must include these previously customized values.
  • An admin must generate the manifest deployment folder, namely the manifest-single-zone, as per the deployment topology for version 5.4.1 by running the compose command.
  • For Docker Swarm deployment, if host were pinned in older versions then the deployment scripts are pinned to the same hosts for version 5.4.1.
  • Carry out the configurations as follows:
    • Swarm: Configure the Docker client for communication with the manager node.
Note:
  • Some traffic disruptions are expected during upgrade. To minimize disruptions, upgrade theLocal Edition components sequentially, explained as follows.

Procedure

  1. Undeploy and redeploy Log components.
    1. Remove running Local Edition 5.4.0, 5.3.1, 5.3.0 or 5.2.0 Log container. Run the following command.
      • For single-zone deployment:
        For Docker Swarm: 
        docker stack rm logstack
    2. Deploy Local Edition 5.4.1 Log containers. Run the following command.
      • For single-zone deployment:
        For Docker Swarm: 
        ./deploy-log-pod.sh
  2. Undeploy and redeploy NoSQL components.
    1. Remove running Local Edition 5.4.0, 5.3.1, 5.3.0 or 5.2.0 NoSQL container. Run the following command:
      • For single-zone deployment:
        For Docker Swarm: 
        docker stack rm nosqlstack
    2. Deploy Local Edition 5.4.1 NoSQL containers. Run the following command. 
      ./deploy-nosql-pod.sh
  3. Undeploy and redeploy SQL components.
    1. Remove running Local Edition 5.4.0, 5.3.1, 5.3.0 or 5.2.0 SQL container. Run the following command.
      • For single-zone deployment:
        • For Docker Swarm: 
          docker stack rm sqlstack
    2. Deploy Local Edition 5.4.1 SQL containers. Run the following command.
      • For single-zone deployment:
        For Docker Swarm: 
        ./deploy-sql-pod.sh
  4. Upgrade NoSQL and SQLcontainer consecutively. Run the upgrade scripts inside the container.
    1. Upgrade NoSQL container.
      For single zone deployment:
      • For Docker Swarm: 
        docker exec -it <nosql_container_id> bash
    2. Navigate to the scripts folder using cd /opt/mashery/scripts/ and run the following commands as applicable.
      • Step not required when upgrading from 5.3.1.
      • For upgrading from 5.3.0: 
        ./nosql-upgrade.sh 5.3.0
      • For upgrading from 5.2.0: 
        ./nosql-upgrade.sh 5.2.0
      Note: Execute the above upgrade step only in one NoSQL container. Changes will be reflected across all NoSQL instances.
      The NoSQL container will be upgraded to 5.4.1.
    3. Upgrade SQL container
      For single zone deployment:
      • For Docker Swarm: 
        docker exec -it <sql_container_id> bash
    4. Navigate to the directory with the Mashery scripts, for example: cd /opt/mashery/scripts/. Then, run sql-upgrade.sh and pass 5.4.0, 5.3.1, 5.3.0 or 5.2.0 as parameter to script as applicable.
      • For upgrading from 5.4.0: 
        ./sql-upgrade.sh 5.4.0
      • For upgrading from 5.3.1: 
        ./sql-upgrade.sh 5.3.1
      • For upgrading from 5.3.0: 
        ./sql-upgrade.sh 5.3.0
      • For upgrading from 5.2.0: 
        ./sql-upgrade.sh 5.2.0
        Note: Execute the above upgrade step only in one NoSQL container. Changes will be reflected across all NoSQL instances.
    The SQL container will be upgraded to 5.4.1.
  5. Undeploy and redeploy Cache components.
    1. Remove running Local Edition 5.4.0, 5.3.1, 5.3.0 or 5.2.0 Cache container. Run the following command.
      • For single-zone deployment:
        For Docker Swarm: 
        docker stack rm cachestack
    2. Deploy Local Edition 5.4.1 Cache containers. Run the following command.
      • For single-zone deployment:
        For Docker Swarm: 
        ./deploy-cache-pod.sh
  6. Undeploy and redeploy TM components.
    1. Remove running Local Edition 5.4.0, 5.3.1, 5.3.0 or 5.2.0 TM container. Run the following command.
      • For single-zone deployment:
        For Docker Swarm: 
        docker stack rm tmstack
    2. Deploy Local Edition 5.4.1 TM containers. Run the following command.
      • For single-zone deployment:
        For Docker Swarm: 
        ./deploy-tm-pod.sh
  7. Undeploy and redeploy CM components.
    1. Remove running Local Edition 5.4.0, 5.3.1, 5.3.0 or 5.2.0 CM container. Run the following command.
      • For single-zone deployment:
        For Docker Swarm: 
        docker stack rm cmstack
    2. Deploy Local Edition 5.4.1 CM containers. Run the following command.
      • For single-zone deployment:
        For Docker Swarm: 
        ./deploy-cm-pod.sh
      Note: The following database migration step is applicable only for upgrading from ML 5.3.1.or 5.3.0.
    3. Run a database migration in the CM container as follows:
      • For single-zone deployment:
        For Docker Swarm: 
        docker exec -it <cm_container_id> bash
      • To migrate data, use the following command: 
        service mlconfig database-upgrade --migrate
    After deployment, test TM calls within the CM container.