In order to understand the working of the utility, it is important to understand the structure of runtimedata which is explained below.
Runtimedata Structure
The runtimedata directory present inside $NEW_FIORANO_HOME directory contains the following information:
- API Projects Repository: Repository of user created API projects. This information is present under $NEW_FIORANO_HOME/runtimedata/repository/apiporjects directory.
- API Policy Repository: Repository of user created Policy(s). This information is present under $NEW_FIORANO_HOME/runtimedata/repository/apipolicies directory.
- API Notifications : Repository of user created/configured notification(s). This information is present under $NEW_FIORANO_HOME/runtimedata/repository/apinotifications directory.
- API Reports: Repository of user created/configured report(s). This information is present under $NEW_FIORANO_HOME/runtimedata/repository/apireports directory.
- Gateway Server Profile Cache: Cache of the connected gateway profiles maintained by each Management Server. This cache is present under $NEW_FIORANO_HOME/runtimedata/APIManagers(EnterpriseServer)/<ProfileName>/AMS(FES)/peers directory.
- Logs: Log Files for the Servers and components. The log files are created under runtimedata for each Server Profile separately. This information is present under $NEW_FIORANO_HOME/runtimedata/APIManagers(EnterpriseServers)/<ProfileName>/AMS(FES)/run/logs for a Management Server profile and $NEW_FIORANO_HOME/runtimedata/APIGateways(PeerServers)/<ProfileName>/AGS(FPS)/run/logs for a Gateway Server profile.
- Realm Store: Realm Store (containing users, groups and ACLs) used by the Server. This information is present under each profile directory. A typical example of the directory containing this information would be $NEW_FIORANO_HOME/runtimedata/APIManagers(EnterpriseServers)/<ProfileName>/AMS(FES)/run/SDB.
- File Based Data Store: Data Stores (containing persistent data for Topics and Queues) used by the Server. This information is present under each profile directory. Few examples of the directory containing this information would be $NEW_FIORANO_HOME/runtimedata/APIManagers(EnterpriseServers)/<ProfileName>/AMS(FES)/run/PTP and $NEW_FIORANO_HOME/runtimedata/APIManagers(EnterpriseServers)/<ProfileName>/AMS(FES)/run/PUBSUB and $NEW_FIORANO_HOME/runtimedata/APIManagers(EnterpriseServers)/<ProfileName>/AMS(FES)/run/PSQ.
The next section explains the steps followed by the utility to migrate runtimedata directory. The procedure begins with copying the entire runtimedata directory from previous installation to the new Fiorano installation and then removing the un-necessary data (if required).
How does the Utility work?
Migrating Server Runtimedata
In order to migrate the runtimedata, the utility copies the runtimedata created for each profile to $NEW_FIORANO_HOME directory. After this step, it proceeds with clearing un-necessary and unwanted data from the copied data.
Clearing Gateway Server Profile Cache
It is essential to delete Gateway Server Profile Cache maintained by Management Server due to profile structure changes in the new Fiorano installation w.r.t. previous versions. This step will delete the directory $NEW_FIORANO_HOME/runtimedata/APIManagers(EnterpriseServers)/<ProfileName>/AMS(FES)/peers (This step will be executed for each Management Server profile).
Clearing Server Log Files
Though this step is not mandatory, it helps to keep the new installation clean. This step will delete the Server logs and also the log files for the components. This may also help in debugging and solving an issue (if it occurs), as we will know for sure that the issue occurred in this installation and not in the previous one. For each profile, following directories will be deleted from $NEW_FIORANO_HOME/runtimedata (All paths below are relative to this directory).
APIManagers(EnterpriseServers)/<ProfileName>/AMS(FES)/run/logs
APIGateways(PeerServers)/<ProfileName>/AGS(FPS)/run/logs
Updating MQ Database
It is essential to update the MQ database from one version to the other to encorporate any new MQ level changes done in the product. This upgrade will update the directory structure present under APIManagers(EnterpriseServers)/<ProfileName>/AMS(FES)/run and APIGateways(PeerServers)/<ProfileName>/AGS(FPS)/run respectively for both AMS and AGS server