Upgrade Runbook

Owned by Manoj Kumar Srivastava
Last updated: May 09, 2024 by Raparthi Kalyan
2 min read

To ensure a smooth upgrade process, please follow the instructions below.

 

 

Note: If current version is below 7.2.0 upgrade to 7.2.0 first then upgrade to latest by following Step 2. Otherwise, if already on 7.2 and above proceed with Step 1 only.

Step 1 - Upgrade Steps for 7.2.x and above

  1. Your docker-compose.yaml file have tagversion as hardcoded version value like 7.3.0. modify it to your desired version before executing these commands:

docker-compose -f /docker-compose.yaml/file/location/docker-compose.yaml pull docker exec mongodb /bin/bash -c 'mongo admin --username="${MONGO_INITDB_ROOT_USERNAME}" --password="${MONGO_INITDB_ROOT_PASSWORD}" --eval "db.shutdownServer()"' docker-compose -f /docker-compose.yaml/file/location/docker-compose.yaml down docker-compose -f /docker-compose.yaml/file/location/docker-compose.yaml up -d

 

Next Step : Follow the Post Upgrade Steps

 

Step 2 a - Upgrade to Version 7.2.0

Only for those whose current version is below 7.2.0,

Before you continue with any latest version (> 7.2.0), it's important to update your system to version 7.2.0 first. By following these steps:

  1. Download the docker-compose.yaml file to your system. File link =

  2. Open the docker-compose.yaml in a text editor and pass the required environmental variable follow this link

  3. Save the changes to the docker-compose.yaml file.

Step 2 b. - Upgrade Steps

Follow the below steps to upgrade the knowhow instance.

Steps Pull the images , stop the running container and run the new container by following commands .

docker-compose -f /docker-compose.yaml/file/location/docker-compose.yaml pull docker exec mongodb /bin/bash -c 'mongo admin --username="${MONGODB_ADMIN_USER}" --password="${MONGODB_ADMIN_PASS}" --eval "db.shutdownServer()"' docker-compose -f /docker-compose.yaml/file/location/docker-compose.yaml down docker stop nonjira-processor azure-processor nonazureboards-processor notification-consumer docker rm nonjira-processor azure-processor nonazureboards-processor notification-consumer docker-compose -f /docker-compose.yaml/file/location/docker-compose.yaml up -d

NOTE Ignore any errors

Step 2 c - Upgrade Steps

If current version is 7.x.x and want to upgrade to 8.1.1

The package needs to be changed based on the installation and upgrade

  • mongock.migration-scan-package=com.publicissapient.kpidashboard.apis.mongock.upgrade

If you are creating a fresh instance, set the starting system version to 0

The base version for Mongock is 8.0.0, so for upgrading an instance, maintain it as 8.0.0

  • mongock.start-system-version=8.1.0

Note: And, at the end follow the Step 1. after completing the above Step 2c changes.

Step 2 d. - Upgrade Steps

If current version is 8.1.x and want to upgrade to 8.2.x

Please change below two properties in customapi.properties file, which is located in the path. /app/apps/properties/ and then follow step 1 above.

  • mongock.start-system-version=8.1.0

  • mongock.end-system-version=8.2.x

 

Upgrade from 8.x to 9.x

 

Steps

  1. From version 9.x onward, we support SAML Authentication. If you wish to use the authentication service, follow this steps

Upgrade steps without Auth

  1. Open the docker-compose.yaml in a text editor and pass the required environmental variable follow this link

  2. Update the docker image tag versin to latest 9.x.

  3. Save the changes to the docker-compose.yaml file.

  4. Pull the docker images

    docker-compose pull

  5. Start the docker container

© 2022 Publicis Sapient. All rights reserved.