Upgrading Rational Engineering Lifecycle Manager running with Apache Tomcat

To upgrade Rational® Engineering Lifecycle Manager, install the new product version, update configuration files, add or update tables in existing database repositories, and migrate your existing data to version 5.0.1.

Before you begin

Procedure

  1. Install Rational Engineering Lifecycle Manager.
    This step installs:
    • Rational Engineering Lifecycle Manager 5.0.1
    • Jazz™ Team Server 5.0.1
    • Configuration Management application 5.0.1
    Important:
    • Select a different package group and directory than the original installation.
    • Select the same context root as your previous installation.

      If you upgrade from Rational Engineering Lifecycle Manager version 5.0 or older versions, your existing Jazz Reporting Service or SPARQL Gateway context root is SPARQL_Gateway, and your application file name is SPARQL_Gateway.war. When you install Rational Engineering Lifecycle Manager 5.0.1, select the custom context root option, and enter SPARQL_Gateway in the Application context root values field.

  2. Stop your old Tomcat server.
  3. Migrate or back up your database.
    Option Description
    Derby Delete the Derby databases that were installed with the upgrade, and replace them with the Derby files from the original installation.
    rm -rf $newRELMHome/server/conf/jts/derby/repositoryDB
    rm -rf $newRELMHome/server/conf/jts/indices
    rm -rf $newRELMHome/server/conf/relm/derby/repositoryDB
    rm -rf $newRELMHome/server/conf/vvc/derby/repositoryDB
    cp -R $oldRELMHome/server/conf/jts/derby/repositoryDB $newRELMHome/server/conf/jts/derby
    cp -R $oldRELMHome/server/conf/jts/indices $newRELMHome/server/conf/jts
    cp -R $oldRELMHome/server/conf/relm/derby/repositoryDB $newRELMHome/server/conf/relm/derby
    cp -R $oldRELMHome/server/conf/relm/indices $newRELMHome/server/conf/relm
    cp -R $oldRELMHome/server/conf/vvc/derby/repositoryDB $newRELMHome/server/conf/vvc/derby
    cp -R $oldRELMHome/server/conf/vvc/indices $newRELMHome/server/conf/vvc
    DB2 or Oracle For complete instructions, refer to the documentation supplied by your database vendor.
    The following is a sample database back-up process for DB2® that can be used as a guideline.
    1. Ensure that your old Jazz Team Server is stopped.
    2. In DB2, locate the databases that are used by the previous installation of Jazz Team Server applications.
    3. Back up each database that is used by a Jazz Team Server application.
    4. Save your changes.
    For more information about backing up and restoring the database, read the documentation for the Rational solution for Collaborative Lifecycle Management.
    SQL Server

    The following is a sample database back-up process for SQL Server that can be used as a guideline.

    • Ensure that you have the correct user name and password.
    • Ensure that you backed up your database before you started the upgrade process.
    • Confirm that the Java Database Connectivity (JDBC) driver is installed, and you are using sqljdbc4.jar. In version 5.0.1 JRE version 5.0 is no longer supported. Only JRE version 6.0 and 7.0 are supported.
    • Ensure that the SQL service is started.
    For complete instructions, refer to the documentation supplied by your database vendor.
    Oracle Ensure that the Oracle JDBC driver ojdbc.jar is available in the $newRELMHome/JazzTeamServer/server/oracle directory.
  4. Upgrade the Configuration Management application.
    Run the vvc_upgrade script to upgrade the configuration and database files, and to rebuild the text indices. This is a parameters example:
    cd $newRELMHome/server/
    upgrade/vvc/vvc_upgrade.sh -oldApplicationHome oldRELMHome/server/conf
    • If you upgrade a distributed (multiple server) installation topology, use the following parameter with the vvc_upgrade script:
      -oldApplicationHome oldRELMHome/server/conf -ignoreJTSVersionCheck
    Tip: The Configuration Management application can also be installed with Rhapsody® Design Manager. When you install Rational Engineering Lifecycle Manager, you have the option to install the Configuration Management application - this option is useful if you want to install the application on a different server from Rhapsody Design Manager. Integrate only one Configuration Management application with the Rational Engineering Lifecycle Manager. If you choose to install the component on multiple servers, ensure that you select the correct component for installing and upgrading.
  5. Upgrade Rational Engineering Lifecycle Manager.
    Run the relm_upgrade.sh command to upgrade configuration and database files, and to rebuild the text indices.
    $newRELMHome/server/upgrade/relm/relm_upgrade.sh -oldApplicationHome oldRELMHome/server/conf
  6. Port the Lifecycle Query Engine and the existing Jazz Reporting Service or SPARQL Gateway configuration information to the new product version.
    Copy the contents of the SPARQL_Gateway directory in the old installation to the new SPARQL_Gateway directory.
    cp -R $oldRELMHome/server/conf/SPARQL_Gateway/* $newRELMHome/server/conf/SPARQL_Gateway
    If you are upgrading from version 5.0 to 5.0.1, proceed to Step 7.
    If you are upgrading from version 4.x to 5.0.1, use a text editor to add the following properties to $newRELMHome/server/conf/SPARQL_Gateway/SPARQL_Gateway.properties.
    • support.query.editing=false
    • support.db.derby=false
    • support.dwse=false
    • query.results.limit=3000
    • query.results.cache.timeout=300
    • user.account.cache.timeout=480
    Remove app.properties from SPARQL_Gateway
    rm $newRELMHome/server/conf/SPARQL_Gateway/app.properties
    Rename SPARQL_Gateway.properties to app.properties.
    mv $newRELMHome/server/conf/SPARQL_Gateway/SPARQL_Gateway.properties $newRELMHome/server/conf/SPARQL_Gateway/app.properties
    Rename SPARQL_Gateway_runtime.properties to app_runtime.properties. (By default, SPARQL_Gateway_runtime.properties does not exist, but you can create the file if you need to configure the connection timeout setting.)
    mv $newRELMHome/server/conf/SPARQL_Gateway/SPARQL_Gateway_runtime.properties $newRELMHome/server/conf/SPARQL_Gateway/app_runtime.properties
  7. Start your Apache Tomcat server.
  8. If you upgrade from version 4.x, upgrade the Lifecycle Query Engine.

    Open the Lifecycle Query Engine administration page https://relm_host_name:port/lqe/web/admin. A message states that the Lifecycle Query Engine upgrade is in progress, and that the application is unavailable. Click Start Upgrade. When the upgrade process completes, the data sources are available.

  9. Upgrade the Configuration Management application.
    1. Ensure that a credentials.txt file exists, and contains: adminUserId, adminPassword, repositoryURL, smartCard, certificateFile .

      If the file does not exist, create the file. A credentials file example is:

      adminUserId=yourAdminUserId
      adminPassword=yourAdminPassword 
      repositoryURL=https://yourserver.com:9443/vvc 
      smartCard=<none>
      certificateFile=<none>
    2. Run the repotools-vvc command from your Configuration_Application_install_dir/server directory.
      • Linux./repotools-vvc.sh -vvc_online_migrationCommand credentialsFile=credentials.txt fromVersion=<previous_version> logPort=52000 logLevel=DEBUG
      • Windowsrepotools-vvc.bat -vvc_online_migrationCommand credentialsFile=credentials.txt fromVersion=<previous_version> logPort=52000 logLevel=DEBUG
    3. Restart the Jazz Team Server.
    The Configuration Management application repotools command sends a request to the running Configuration Management application and waits for a response. If the repotools-vvc command stops immediately with an authorization error, verify that the server is running, and that the user ID and password in the credentials file are correct.
  10. Restart your Tomcat server.
  11. Restart your Rational Engineering Lifecycle Manager server to automatically upgrade migrated data to the format that is required in the new application version. This process is called online upgrade. Log on if you want to see the upgrade status page.

Results

When the online upgrade is successful, the web browser refreshes and opens the Rational Engineering Lifecycle Manager welcome page. If an upgrade step fails, examine the relm.log file to determine what caused the failure. If you have a large number of products defined in Rational Engineering Lifecycle Manager, the online upgrade takes a long time to complete (up to several hours).

What to do next


Feedback