gc_upgrade script

Edit online

Use this script to upgrade the Global Configuration Management application.

Purpose

The gc_upgrade script upgrades the Global Configuration Management application from version 6 and later to desired version. Although the script file is located under the upgrade/gc directory, it must be run from the GCM_install_dir/server directory. Also if your path contains spaces, ensure that you enclose the path name in double quotation marks. Enter [E] to execute the command, [S] to skip a step, or hit [Enter] to cancel the script execution.

As an alternative to running the script and all its command-line arguments, you can open the script's parameters file, modify the default values, and run an abbreviated form of the command line. The English and translated versions of the gc_params files are located in the GCM_install_dir/server/upgrade/gc/params directory. Open gc_params or a translated version of it for editing and specify values for each parameter. One of the parameters that must be set is the path to the OLD_APPLICATION_HOME directory. This must be an existing directory ended by server/conf.

The script performs the following tasks:
  • Step 0: Runs the -migration_gc_updateConfigurationFiles command that updates the server configuration files. After the configuration files are merged successfully, enter [C] to continue. An editor opens in which you can verify the Jazz Team Server and the Global Configuration Management application teamserver.properties files. Verify that the Public URI root denoted by the com.ibm.team.repository.server.webapp.url property is correct. Also verify that the database properties are correct. When done, save your changes, if any, and close the editor to continue the script execution.
  • Step 1: Adds tables to the GCM repository database.

Parameters

Attribute Description Required Default
-oldApplicationHome Full path to the old Global Configuration Management application server configuration directory. The path must not contain any spaces. In a typical installation, this path is old_GCM_install_dir/server/conf. Yes none
-applicationContextRoot The GCM application context root. Must be valid directory single name without a leading slash. No gc
-oldApplicationVersion The GCM version that is being upgraded. By default, this is determined by running repotools -version against the old application. It should be a complete version string. For example, 6.0.0 or 6.0.6.1. No none
-updateAppServerFiles By default, this option is set to yes to update the Tomcat configuration files when migrating to IBM WebSphere Liberty. No yes
-newApplicationHome Path to the Global Configuration Management application configuration directory of the installation. No conf

For example, GCM_install_dir/server/conf
-newJTSHome Path to the Jazz Team Server configuration directory of the installation. By default, the -newJTSHome parameter value is derived from the -newApplicationHome parameter value. No none
-jtsContextRoot Context root of the Jazz Team Server. Must be valid directory single name without a leading slash. No jts
-noPrompt Do not prompt before creating or modifying the tables. No none
-noResumePrompt Do not prompt when resuming an upgrade step. No false
-noVerify Do not perform teamserver.properties file verification. No none
-noStepPrompt Do not prompt before executing a step. No false
-noEditor The -noEditor parameter eliminates opening an editor during the execution of the upgrade script to review or modify the teamserver.properties file. The -noEditor parameter in conjunction with -noStepPrompt, -noVerify, -noResumePrompt, and -noPrompt parameters can be used for a fully automated upgrade script without any user interactions. If you need to review or modify the teamserver.properties file during the upgrade, such as in a WebSphere® Liberty server environment where the index location might be relative to the profile directory, do not use this parameter. No false
-oldTomcatHome Full path to the Tomcat root directory in the old installation. Must be an existing directory. By default, the -oldTomcatHome parameter is derived from the -oldApplicationHome parameter value. No N/A

Example

For Windows operating system Open a command prompt and enter this command:

Open a Windows command prompt and enter the following commands:

cd C:\Program Files\IBM\JazzTeamServer_7.0.3\server\
upgrade\gc\gc_upgrade.bat -oldApplicationHome OLD_GCM_install_dir\server\conf

For Unix operating systems Open a command line and enter this command:

Open a UNIX command shell and enter the following commands:

cd /opt/IBM/JazzTeamServer_7.0.3/server/
./upgrade/gc/gc_upgrade.sh -oldApplicationHome OLD_GCM_install_dir/server/conf