Upgrading the Git adapter software

You use IBM® Installation Manager to upgrade the adapter software.

Before you begin

Download the 1.1.1.1 fix pack, see Rational® Lifecycle Integration Adapters Standard Edition Fix Pack 1 (1.1.1.1) for 1.1.1.

If you have Internet access, you can skip downloading the software and steps 4 - 7 in these upgrade instructions. With Internet access, the Update Packages wizard in IBM Installation Manager can search for updates to the installed product packages. For more information about using Installation Manager to install updates, see Updating packages by using wizard mode.

About this task

You use IBM Installation Manager to access a repository that contains the package update to upgrade the adapter software. You can follow the same steps to upgrade from the trial version of the adapter. The latest adapter software includes the latest fix pack. If you plan to upgrade Rational solution for Collaborative Lifecycle Management, you must migrate the Git adapter, see Migrating the adapter to an upgrade installation of CLM.

During the upgrade process, you also update Gitweb additions, Gerrit additions, the receive hook for Gitweb, and the receive hook for Gerrit.

Important: You cannot use the launchpad to upgrade the adapter software.

Procedure

  1. Back up the Git adapter database.
  2. Back up the adapter indexes at JazzInstallDir/server/conf/gitAdapter/indices.
  3. Start Installation Manager. Skip to step 8 if you have Internet access. With Internet access, Installation Manager can access the IBM update repository locations for updates to your installed packages.
  4. In Installation Manager, click File > Preferences and then select Add Repository.
  5. For the Repository location, browse to the location of the diskTag.inf file.
    • If you are installing from the DVD, insert the DVD into your DVD drive. Find the diskTag.inf file, which is in the root folder.
    • If you are installing from the electronic image, change to the directory where you extracted the disk image. Find the diskTag.inf file, which is in the GIT/disk1 folder.
  6. Click OK to finish editing the repository preference list.

    The new repository location is added to the list.

  7. Click OK to close the Preferences page.
  8. In Installation Manager, click Update.
  9. If a new version of Installation Manager is found, you are prompted to confirm the installation before you can continue. Click OK to proceed.

    Installation Manager automatically installs the new version, restarts, and resumes.

  10. In the Update Packages window, select the package group that contains the package for updating. The package group is the location of the installed adapter that you want to update. Click Next.

    If you added a repository, Installation Manager searches for updates by using that repository. If you did not add a repository but have Internet access, Installation Manager searches for updates to the installed product packages.

    The available update is shown and selected in the Update list on the Update Packages page.

  11. Click Next.
  12. Read and accept the license agreement by selecting the appropriate radio button, then click Next.
  13. In the Features window, review the item to be installed and then click Next.
  14. If you deployed the adapter war file on Apache Tomcat, stop the server before it is updated.
  15. If you deployed the adapter war file on WebSphere® Application Server, stop the adapter application from the console.
  16. Click Next.
  17. In the Summary window, review your selection and click Update to install the update.
  18. When the update is complete, click Finish. These files are available in JazzInstallDir/server/conf/gitAdapter/
    • upgrade_additions.sh
    • gitwebAdditions-yyyymmdd-hhmm.zip
    • gerritAdditions-yyyymmdd-hhmm.zip
    You use these files when you update Gitweb and Gerrit.
  19. If you deployed the adapter war file on Apache Tomcat, start that server that you stopped during installation.
  20. If you deployed the adapter war file on WebSphere Application Server, complete these steps:
    1. Delete or rename the two gitAdapter_war folders under the temp directory:
      WASInstallDir/profiles/profile name/temp/wscache/gitAdapter_war
      WASInstallDir/profiles/profile name/temp/node name/AppNode0/gitAdapter_war
    2. Start the adapter application from the console.

Update Gitweb

  1. Go to the Gitweb installation folder and delete gitwebAdditions-yyyymmdd-hhmm.zip and the upgrade_additions.sh files.

    The Gitweb installation folder contains an older version of the gitwebAdditions-yyyymmdd-hhmm.zip and the upgrade_additions.sh files and must be deleted.

  2. Copy the newer version of thegitwebAdditions-yyyymmdd-hhmm.zip and the upgrade_additions.sh files from the JazzInstallDir/server/conf/gitAdapter/ directory.

    If the Gitweb server is on a separate server from the adapter, copy the gitwebAdditions-yyyymmdd-hhmm.zip and the upgrade_additions.sh to your Gitweb installation folder on that separate server.

  3. Update the Gitweb additions on the Gitweb server by running the upgrade_additions.sh script.
  4. Update the receive hook for each registered Gitweb project by running a script, see Deploying the receive hook for Gitweb. If the optional parameters (--username, --password, --jts_url, and --adapter_project_url) did not change, run the script without them.

Update Gerrit

  1. Stop the Gerrit server.
  2. Go to the Gerrit installation folder and delete gerritAdditions-yyyymmdd-hhmm.zip and the upgrade_additions.sh files.

    The Gerrit installation folder contains an older version of the gerritAdditions-yyyymmdd-hhmm.zip and the upgrade_additions.sh files and must be deleted.

  3. Copy the newer version of thegerritAdditions-yyyymmdd-hhmm.zip and the upgrade_additions.sh files from the JazzInstallDir/server/conf/gitAdapter/ directory.

    If the Gerrit server is on a separate server from the adapter, copy the gerritAdditions-yyyymmdd-hhmm.zip and the upgrade_additions.sh to your Gerrit installation folder on that separate server.

  4. Update the Gerrit additions on the Gerrit server by running the upgrade_additions.sh script.
  5. Start the Gerrit server.
  6. Update the receive hook for Gerrit by running the gerrit_setup script, see Deploying the receive hook for Gerrit. Because the Gerrit hook is configured at the Gerrit site level, instead of each Gerrit project, run the gerrit_setup script once to upgrade the hook. You can specify any one of your registered Gerrit projects when you run the gerrit_setup script. If any of the optional parameters (--username, --password, --jts_url, and --adapter_project_url) changed, run the gerrit_setup script again for other previously registered Gerrit projects.

Add PVU license files for the adapter software

  1. If you are using PVU licensing, add the updated license files, see Licensing.

Results

The adapter software is upgraded to the latest software.
Tip: If you experience issues with the adapter software update, you can revert the software to the version installed before the upgrade by using the Installation Manager GUI rollback feature. For more information about the rollback feature, see Roll back updates by using wizard mode.

The rollback feature does not roll back the updates that are made to Gitweb and Gerrit. You can revert Gitweb additions and Gerrit additions to their previous versions before the upgrade by using the files in the git_server_root/upgrade_backup/timestamp directory.

What to do next

Continue to use the adapter, see Using the Git adapter.

Feedback