Upgrade Runbook

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

Note: If your current version is below 7.2.0, please follow Step 2. Otherwise, proceed with Step 1 only.

Step 1 - Upgrade Steps for 7.2.x and above

If your docker-compose.yaml file have tagversion as latest execute the bellow command for upgrade.

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

Else if 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:

Download the docker-compose.yaml file to your system. File link =
Open the docker-compose.yaml in a text editor and pass the required environmental variable follow this link
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 your current version is 7.x.x and want to upgrade to 8.1.1

At first please upgrade your server to 8.0.0 by following this PSknowHOW - Upgrade Guide and then run the delta script from 7.x.x to 8.0.0 from https://github.com/PublicisSapient/PSknowHOW
And then start upgrading 8.0.0 to 8.1.1 by following the below steps:
- In the docker-compose file replace the version from 8.0.0 to 8.1.1 and create following property changes in customapi.properties file, which is located in the path /app/apps/properties/

#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 your 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/

mongock.start-system-version=8.1.0
mongock.end-system-version=8.2.x