r3 - 2014-12-06 - 22:17:32 - StevenBeardYou are here: TWiki >  Deployment Web > WebPreferences > InstallCLMUsingParameterFiles

This article describes how to upgrade an existing Jazz Team Server, Rational Team Concert, and Rational Quality Managers v4.0.6 to 5.0 version. The upgrade is done using parameter files

Authors: Natarajan Thirumeni
Build basis: Jazz Team Server, Rational Team Concert and Rational Quality Manager 4.0.6 to Jazz Team Server, Rational Team Concert and Rational Quality Manager 5.0

Introduction

This article describes how to upgrade an existing Jazz Team Server, Rational Team Concert, and Rational Quality Managers v4.0.6 to 5.0 version. The upgrade is done using parameter files

Topology

For a demonstration purpose the installation is done on the single environment. The idea is show the power of upgrade parameter files.

The following is a summary list of the recommended actions:

  • The current version of your Jazz Team Server (JTS), Rational Team Concert (RTC), and Rational Quality Manager (RQM) running on 4.0.6 or below.

  • You are planing to upgrade to 5.0 or 5.0.1

  • You are you planing to automate the upgrade process to make it easier.

  • Validate your upgrade process in a test environment

  • Contact us when you need help

Prerequisite for upgrade process:

* Install CLM 5.0 in the same system side by side where CLM 4.0.6 was running.

* Do not run the /Jtssetup.

* Take a back up of your existing CLM 406 database (consult your Database vendor docs to export DB)

* You meet system requirement in the Installing, upgrading and migrating section

The process for upgrading is based on parameter files:

Before running the upgrade script for JTS, open its parameter file in a text editor to understand the content of the file. We are going set or modify the default values as per our upgrade process requirements. The parameter file contains the default values of the parameters used by the script. The English and translated versions of the parameters files are located in the <5.0.6_JTS_install_dir>\server\upgrade\params directory. You can also specify the parameter values as command line arguments to the upgrade script. To get the exact name of the translated parameter file for your language, from the <5.0\JTS_install_dir>\server\jts\upgrade directory run:

On the UNIX system run locale.sh -jts -showParamFileNamem, for example

[root@RHEL61 jts]# ./locale.sh -showParamFileName

The following set of files contain default parameter values for an application or JTS upgrade. If you need to modify any of the default parameter values, you can edit these files or you can specify the parameter values as command line arguments to the upgrade scripts.

* CCM upgrade: ./params/ccm_params.sh

* QM upgrade: ./params/qm_params.sh

* RM upgrade: ./params/rm_params.sh

* JTS upgrade: ./params/jts_params.sh

on Windows run locale.bat -jts -showParamFileName

C:\AdminWS\IBM\JazzTeamServer\server\upgrade\jts>locale.bat -showParamFileName

The following set of files contain default parameter values for an application or JTS upgrade. If you need to modify any of the default parameter values, you can edit these files or you can specify the parameter values as command line arguments to the upgrade scripts.

- CCM upgrade: ""C:\AdminWS\IBM\JazzTeamServer\server\upgrade\jts\"params\ccm_params.bat"

- QM upgrade: ""C:\AdminWS\IBM\JazzTeamServer\server\upgrade\jts\"params\qm_params.bat"

- RM upgrade: ""C:\AdminWS\IBM\JazzTeamServer\server\upgrade\jts\"params\rm_params.bat"

- JTS upgrade: ""C:\AdminWS\IBM\JazzTeamServer\server\upgrade\jts\"params\jts_params.bat"

Important:

* One of the parameters that must be set is the path to the OLD_JTS_HOME directory. Ensure the path does not contain any spaces. .

* Navigate to <4.0.6JTS_install_dir>\server and run upgrade\jts_upgrade.bat on Windows or upgrade/jts_upgrade.sh on the UNIX systems.

* Although the script file is located under the upgrade directory, it must be run from the server directory.

* The steps are based on Unix file system path, but you can modify the path if you are on Windows server machine.

CLM upgrade process

Copy database from CLM 4.0.6 to CLM 5.0

For this exercise we are using Derby as a database. The DB files has to be moved out of 4.0.6 to 5.0 version. Before copying DB files, the CLM application server has to stopped. Sine we are operating with a default database there is no need to stop database server as shutdown application server takes care of that.

* Shutdown Tomcat Application Server.

* Copy database from existing CLM 4.0.6 to CLM 5.0 - while there are many ways go about it, we will keep it simple. Before copying the Derby database from 4.0.6 to 5 you should clear the default version 5.0 Derby repositoryDB directory. For example you can use the following commands

> to remove JTS 5.0 derby database

rm -rf 5.0_install_dir/server/conf/jts/derby/repositoryDB

> to remove RTC 50 derby database

rm -rf 5.0_install_dir/server/conf/ccm/derby/repositoryDB

> to remove QM derby database

rm -rf 5.0_install_dir/server/conf/qm/derby/repositoryDB

After executing these command, CLM 5.0 database has no default values.

* Copy database files from operating CLM 4.0.6 server to target CLM 5.0 server. For example, I used the following commands to copy the Derby database from 4.0.6 to 5.0

> copy DB from 4.0.6 to 5.0 for JTS repository

cp -R CLM_4.0.6_install_dir/server/conf/jts/derby/repositoryDB 5.0_install_dir/server/conf/jts/derby/repositoryDB

> copy DB from 4.0.6 to 5.0 for RTC repository

cp -R CLM_4.0.6_install_dir/server/conf/ccm/derby/repositoryDB 5.0_install_dir/server/conf/ccm/derby/repositoryDB

> copy DB from 4.0.6 to 5.0 for RQM repository

cp -R CLM_4.0.6_install_dir/server/conf/qm/derby/repositoryDB 5.0_install_dir/server/conf/qm/derby/repositoryDB

> copy DB from 4.0.6 to 5.0 for DW (Data Warehouse) repository

cp -R CLM_4.0.6_install_dir/server/conf/jts/derby/warehouseDB 5.0_install_dir/server/conf/jts/derby/warehouseDB

You need to adjust and update the path accordingly to your environment. At this point, all required DB files are copied over to 5.0 installation. Our database is actually ready for use. DO NOT start Application server yet as we need to CLM application server.

Application Server upgrade

Let us start with upgrading a JTS application server first. As we discussed earlier, to help facilitate the upgrade, we will take advantage of the parameter files for JTS, RTC, and RQM. The JTS parameter file in our new installation (5.x) can be found here: /opt/IBM/<CLM5.0>/server/upgrade/jts/params. In our upgrade example:

Upgrade JTS (Jazz Team Server)

1. Go to jts/params location where JTS server is installed. For example:

[root@RHEL61 params]# pwd

/opt/IBM/CLM5.0/server/upgrade/jts/params

[root@RHEL61 params] # dir

ccm_params_cs.sh ccm_params_ko.sh jts_params_cs.sh jts_params_ko.sh qm_params_cs.sh qm_params_ko.sh rm_params_cs.sh rm_params_ko.sh ccm_params_de.sh ccm_params_pl.sh jts_params_de.sh jts_params_pl.sh qm_params_de.sh qm_params_pl.sh rm_params_de.sh rm_params_pl.sh ccm_params_es.sh ccm_params_pt_BR.sh jts_params_es.sh jts_params_pt_BR.sh qm_params_es.sh qm_params_pt_BR.sh rm_params_es.sh rm_params_pt_BR.sh ccm_params_fr.sh ccm_params_ru.sh jts_params_fr.sh jts_params_ru.sh qm_params_fr.sh qm_params_ru.sh rm_params_fr.sh rm_params_ru.sh ccm_params_hu.sh ccm_params.sh jts_params_hu.sh jts_params.sh qm_params_hu.sh qm_params.sh rm_params_hu.sh rm_params.sh ccm_params_it.sh ccm_params_zh.sh jts_params_it.sh jts_params_zh.sh qm_params_it.sh qm_params_zh.sh rm_params_it.sh rm_params_zh.sh ccm_params_ja.sh ccm_params_zh_TW.sh jts_params_ja.sh jts_params_zh_TW.sh qm_params_ja.sh qm_params_zh_TW.sh rm_params_ja.sh rm_params_zh_TW.sh

2. Look for the jts_params.sh file, each application has it's own params directory. To upgrade JTS server, I had to make changes to the following variables inside jts_params.sh file

set OLD_JTS_HOME=

set OLD_JTS_VERSION=

set UPDATE_TOMCAT_FILES=no (default value is yes)

# Full path to the JTS home directory in old installation.

# Default:

#

# Constraints:

# -

must be an existing directory ended by 'server/conf'

# - Only valid for RM and JTS upgrades

#

OLD_JTS_HOME=/opt/IBM/JTS406/server/conf/

# Parameter: -oldJTSVersion

# Usage: -oldJTSVersion

# Description:

# The version of the JTS being upgraded. By default,

# this is determined by running repotools -version against the old JTS.

# Default:

#

# Constraints:

# - should be a complete version string

# e.g. 3.0.0 or 3.0.1

#

OLD_JTS_VERSION=4.0.6

# Parameter: -updateTomcatFiles

# Usage: -updateTomcatFiles

# Description:

# Whether to update the tomcat configuration files.

# Default:

# yes

# Constraints:

# - The only valid values are 'yes' and 'no'

#

UPDATE_TOMCAT_FILES=no

3. After you make the changes and save the file, open a shell window.

4. cd to the CLM 5.x installation server directory and run the following upgrade script: upgrade\jts\jts_upgrade.sh. For example

[root@RHEL61 server] # ./upgrade/jts/jts_upgrade.sh

Follow the upgrade screen until you see the following message in the screen.

The data warehouse was upgraded successfully.

The jts upgrade succeeded. You may upgrade any applications in your environment now.

The advantage of using param file is that, we did not enter the existing path of the sever and other required parameters files. All the required variables were already set in the parameter files. You can use this option if you are looking to minimize manual approach during upgrade process.

Upgrade RTC (Rational Team Concert)

1st paragraph

1. Go to ccm/params location where RTC server is installed.

root@RHEL61 params]# pwd

2. Make the changes to the appropriate ccm_params file

/opt/IBM/CLM5.0/server/upgrade/ccm/params

[root@RHEL61 params] # dir

ccm_params_cs.sh ccm_params_pl.sh jts_params_es.sh jts_params_ru.sh qm_params_hu.sh qm_params_zh.sh rm_params_ja.sh

ccm_params_de.sh ccm_params_pt_BR.sh jts_params_fr.sh jts_params.sh qm_params_it.sh qm_params_zh_TW.sh rm_params_ko.sh

ccm_params_es.sh ccm_params_ru.sh jts_params_hu.sh jts_params_zh.sh qm_params_ja.sh rm_params_cs.sh rm_params_pl.sh

ccm_params_fr.sh ccm_params.sh jts_params_it.sh jts_params_zh_TW.sh qm_params_ko.sh rm_params_de.sh rm_params_pt_BR.sh

ccm_params_hu.sh ccm_params_zh.sh jts_params_ja.sh qm_params_cs.sh qm_params_pl.sh rm_params_es.sh rm_params_ru.sh

ccm_params_it.sh ccm_params_zh_TW.sh jts_params_ko.sh qm_params_de.sh qm_params_pt_BR.sh rm_params_fr.sh rm_params.sh

ccm_params_ja.sh jts_params_cs.sh jts_params_pl.sh qm_params_es.sh qm_params_ru.sh rm_params_hu.sh rm_params_zh.sh ccm_params_ko.sh jts_params_de.sh jts_params_pt_BR.sh qm_params_fr.sh qm_params.sh rm_params_it.sh rm_params_zh_TW.sh

3. Edit ccm_params.sh and edit the file to point out to old application home, version and update tomcat files to no. For example here is values copied the values from testing environment.

OLD_APPLICATION_HOME=/opt/IBM/JTS406/server/conf

OLD_APPLICATION_VERSION=4.0.6

UPDATE_TOMCAT_FILES=no (default value is yes)

3. As you can see all of the steps should be same as the JTS steps, expect the location of the command (and path) is slightly different upgrade\ccm\ccm_upgrade.sh. For example

[root@RHEL61 server] # ./upgrade/ccm/ccm_upgrade.sh

(remember you got to run this command when you are actually in the server folder, example (/opt/IBM/CLM5.0/server)

4. Run the command from step 3) and proceed with the installation until you see the following message in the screen

The ccm upgrade succeeded. You may now start the servers in your deployment

At this point RTC server has been upgraded as expected. Let's move on to upgrade RQM server.

Upgrade RQM (Rational Quality Manager)

1. Go to qm/params location where RTC server is installed.

[root@RHEL61 server]# pwd

2. Make the changes to the appropriate ccm_params file

/opt/IBM/CLM5.0/server/upgrade/ccm/params

[root@RHEL61 params] # dir

_ ccm_params_cs.sh ccm_params_pl.sh jts_params_es.sh jts_params_ru.sh qm_params_hu.sh qm_params_zh.sh rm_params_ja.sh ccm_params_de.sh ccm_params_pt_BR.sh jts_params_fr.sh jts_params.sh qm_params_it.sh qm_params_zh_TW.sh rm_params_ko.sh ccm_params_es.sh ccm_params_ru.sh jts_params_hu.sh jts_params_zh.sh qm_params_ja.sh rm_params_cs.sh rm_params_pl.sh ccm_params_fr.sh ccm_params.sh jts_params_it.sh jts_params_zh_TW.sh qm_params_ko.sh rm_params_de.sh rm_params_pt_BR.sh ccm_params_hu.sh ccm_params_zh.sh jts_params_ja.sh qm_params_cs.sh qm_params_pl.sh rm_params_es.sh rm_params_ru.sh ccm_params_it.sh ccm_params_zh_TW.sh jts_params_ko.sh qm_params_de.sh qm_params_pt_BR.sh rm_params_fr.sh rm_params.sh ccm_params_ja.sh jts_params_cs.sh jts_params_pl.sh qm_params_es.sh qm_params_ru.sh rm_params_hu.sh rm_params_zh.sh ccm_params_ko.sh jts_params_de.sh jts_params_pt_BR.sh qm_params_fr.sh qm_params.sh rm_params_it.sh rm_params_zh_TW.sh _

3. Edit ccm_params.sh and edit the file to point out to old application home, version and update tomcat files to no. For example here is values copied the values from testing environment.

OLD_APPLICATION_HOME=/opt/IBM/JTS406/server/conf/

OLD_APPLICATION_VERSION=4.0.6

UPDATE_TOMCAT_FILES=no (default value is yes)

3. As you can see all of the steps should be same as the JTS steps, expect the location of the command (and path) is slightly different upgrade\qm\qm_upgrade.sh. For example

[root@RHEL61 server]# ./upgrade/qm/qm_upgrade.sh

(remember you got to run this command when you are actually in the server folder, example (/opt/IBM/CLM5.0/server)

4. Run the command from step 3) and proceed with the installation until you see the following message in the screen

The qm upgrade succeeded. You may now start the servers in your deployment.

Heading 1

Related topics: Deployment web home, Deployment web home

External links:

Additional contributors: Main.TWikiUser, Main.TWikiUser

Edit | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r3 < r2 < r1 | More topic actions
 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use. Please read the following disclaimer.
Ideas, requests, problems regarding the Deployment wiki? Create a new task in the RTC Deployment wiki project