Upgrade to TeamForge 16.7 with Oracle database services on a separate server

In this procedure, we assume that you are upgrading on the same RHEL/CentOS 7.2 server where your existing TeamForge 16.3 site is running.

Important: TeamForge 16.7 supports RHEL/CentOS 7.2. However, it also supports RHEL/CentOS 6.8 if you choose to upgrade on the same server that runs RHEL/CentOS 6.8.
In this option, the following services run on the application server (we call this my.app.host). The following service runs on the database server (Oracle) (we call this my.db.host).
Remember: As Black Duck Code Sight 2.1.3 has no support for RHEL/CentOS 7.2, CollabNet recommends you upgrade Black Duck Code Sight on a separate RHEL/CentOS 6.8 server (my.codesight.host).
Note: For the ETL service to run as expected in a distributed TeamForge installation, all servers must have the same time zone.
Attention: Installing or upgrading TeamForge needs root privileges. You must log on as root or use a root shell to install or upgrade TeamForge.

Do this on the Oracle Database Server - my.db.host

  1. Make a dump file of your site database.

    To back up the Oracle database, follow the Oracle backup procedure.

Do the following on the application server - my.app.host

  1. Uninstall hotfixes and add-ons, if any, installed on your site.
  2. If you have Review Board installed, uninstall Review Board.
    • cd /opt/collabnet/RBInstaller-
    • python ./install.py -u
  3. Stop the TeamForge CLI add-on (This step is required only for TeamForge Application server).
    • service teamforge_cli_server stop
  4. Stop TeamForge.
    • /etc/init.d/collabnet stop all
  5. Back up the file system data.
    Tip: /tmp in the following step is just an example. You can use any directory or partition that you prefer.
    1. Make an archive file with the following data directories:
      Directory Contents
      /opt/collabnet/teamforge/var User-created data, such as artifact attachments
      /svnroot Subversion source code repositories.
      /sf-svnroot Subversion repository for branding data
      /cvsroot CVS source code repositories (not present on all sites)
      • mkdir -p /tmp/backup_dir
      • cp -Rpfv /svnroot /sf-svnroot /cvsroot /opt/collabnet/teamforge/var /tmp/backup_dir
    2. If GIT integration is enabled, do the following:
      • mkdir /tmp/backup_dir/gerrit
      • cp -Rpfv /gitroot /tmp/backup_dir
      • cp -Rpfv /opt/collabnet/gerrit/ /tmp/backup_dir/gerrit
    3. Back up your SSH keys, if any.
    4. Back up your SSL certificates and keys, if any.
  6. If GIT is enabled, create a gerrit database dump file, for PostgreSQL upgrade.
    • su - postgres
    • /usr/bin/pg_dumpall > /var/lib/pgsql/9.3/backups/teamforge_gerrit_data_backup.dmp
    • exit
  7. Upgrade the operating system packages.
    • yum upgrade
  8. If the TeamForge server has SELinux enabled, run it in 'Permissive' mode temporarily while installing or upgrading TeamForge.
    1. Verify if SELinux is running in enforcing mode.
      • getenforce
    2. If the output of the getenforce command is "Permissive", continue with the next step. If not, run the following command to bring it to 'Permissive' mode.
      • setenforce 0
    See Set up SELinux to have TeamForge run in SELinux mode after completing the installation or upgrade.
  9. Configure your TeamForge installation repository.
    • TeamForge installation repository configuration for sites with internet access
    1. Contact the CollabNet Support and download the TeamForge 16.7 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-16.7-1.noarch.rpm
    3. Refresh your repository cache.
      • yum clean all
    • TeamForge installation repository configuration for sites without internet access
    1. Contact the CollabNet Support to get the auxiliary installer package for TeamForge 16.7 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.2 64 bit RPM package: CTF-Disconnected-media-16.7.879-116.rhel7.x86_64.rpm
        Note: In addition to the above CentOS 7.2 64 bit RPM package, you must get the following CentOS 7.2 compatibility RPM, which is required for TeamForge 16.7 disconnected media installation on CentOS 7.2 profile: compat-ctf-dc-media-1.0-1.el7.centos.noarch.rpm.
    2. Unpack the disconnected installation package.
      • rpm -Uvh <package-name>
    3. Unpack the compat-ctf-dc-media-1.0-1.el7.centos.noarch.rpm package if you are installing TeamForge 16.7 on CentOS 7.2.
      • rpm -ivh compat-ctf-dc-media-1.0-1.el7.centos.noarch.rpm
    4. Note: If the Red Hat Enterprise Linux/CentOS installation DVD is mounted already, skip the following instructions. If not, mount the DVD.
      Mount the Red Hat Enterprise Linux/CentOS installation DVD. The DVD contains the necessary software and utilities required for installing TeamForge without internet access.

      In the following commands, replace "cdrom" with the identifier for your server's CD/DVD drive, if necessary.

      • cd /media/
      • mkdir cdrom
      • mount /dev/cdrom ./cdrom/

      If there are any spaces in the automount, unmount it first and mount it as a filepath, with no spaces.

    5. Create a yum configuration file that points to the Red Hat Enterprise Linux/CentOS installation DVD.
      • vi /etc/yum.repos.d/cdrom.repo
      Here's a sample yum configuration file.
      name=RHEL CDRom 			
    6. Verify your yum configuration files.
      • yum list httpd
      • yum list apr
  10. Install the following application packages.
    1. TeamForge: To install the TeamForge application packages run the following command:
      • yum install teamforge
      Attention: TeamForge installer is being optimized quite a bit. It's likely that you might come across a lot of warning messages while upgrading from TeamForge 8.2 (or earlier) to TeamForge 16.7 on the same hardware (when you run the yum install teamforge command). You can safely ignore such warning messages and proceed with the upgrade.
    2. To install the CollabNet binary application, run the following command.
      • yum install cn-binary
    3. Tip: If you have GIT already, it is automatically upgraded when you run yum install teamforge. In such case, you can skip the following sub-step.
      GIT: To install the GIT packages run the following command:
      • yum install teamforge-git
  11. Set up your site's master configuration file.
    1. Set up your site options. See Site options change log for a list of new and obsolete tokens.
      • vi /opt/collabnet/teamforge/etc/site-options.conf
    2. TeamForge 16.7 and later versions support automatic JAVA_HOME configuration. Remove the JAVA_HOME token, if present, from the site-options.conf file.
    3. Update the host name and domain name, if required.
      HOST_localhost=app etl indexer subversion cvs
      HOST_my.db.domain.com=database datamart
    4. Add "gerrit" to the HOST_localhost token if you are installing GIT.
      HOST_localhost=app etl indexer subversion cvs gerrit
    5. Add "binary" to the HOST_localhost token if you are installing Nexus.
      HOST_localhost=app etl indexer subversion cvs gerrit binary
    6. To enable the history protection feature of TeamForge Git integration, set the GERRIT_FORCE_HISTORY_PROTECTION=true. For more information, see GERRIT_FORCE_HISTORY_PROTECTION.
    7. Turn on the SSL for your site by editing the relevant variables in the site-options.conf file. To generate the SSL certificates, see Generate SSL certificates.
      Note: The SSL_CERT_FILE and SSL_KEY_FILE tokens need an absolute path. The SSL_CHAIN_FILE token is optional.
    8. If the token REQUIRE_PASSWORD_SECURITY is enabled, then set a value for the token, PASSWORD_CONTROL_EFFECTIVE_DATE.
      The Password Control Kit (PCK) disables, deletes or expires user accounts that don't meet the password security requirements starting from the date set for the PASSWORD_CONTROL_EFFECTIVE_DATE token. If a date is not set, the PCK disables, deletes or expires user accounts immediately. See PASSWORD_CONTROL_EFFECTIVE_DATE for more information.
    9. Password obfuscation: The password obfuscation is enabled by default. As a result, all password-related tokens are encrypted in all the TeamForge configuration files.
      Restriction: The password-related tokens cannot contain the following characters in the site-options.conf file: $<>/\'"`
      • To disable password obfuscation, set OBFUSCATION_ENABLED=false.
      • To configure the obfuscation key, set OBFUSCATION_KEY=<Any AlphaNumeric value with length >= 8 bytes>. The default value of OBFUSCATION_KEY token is XSJt43wN.
    10. Make sure that the following tokens have a value if ETL is enabled.
    11. Configure the Black Duck Code Sight tokens. See Black Duck Code Sight site-option tokens.
    12. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
    13. Ensure to set the token SELINUX_SETUP=true.
    14. Configure the JBOSS_JAVA_OPTS site-options.conf token. See JBOSS_JAVA_OPTS.
      Important: All JVM parameters but -Xms1024m and -Xmx2048m have been hard-coded in the TeamForge core application. You need not manually configure any other parameter (such as -XX:MaxMetaspaceSize=512m -XX:ReservedCodeCacheSize=128M -server -XX:+HeapDumpOnOutOfMemoryError -Djsse.enableSNIExtension=false -Dsun.rmi.dgc.client.gcInterval=600000 -Dsun.rmi.dgc.server.gcInterval=600000) in the site-options.conf file.

      When you change the default value of a JVM parameter such as "-XX:HeapDumpPath", the JBoss runtime parameters include both the user defined and default values for the JVM parameter. However, JBoss runs with the user defined value and ignores the default value.

    15. Save the site-options.conf file.
  12. Download the corresponding version of the Oracle client from http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html
    • yum localinstall <path to oracle client rpm>
  13. Create the runtime environment.
    • /opt/collabnet/teamforge/installer/install.sh
  14. Update the file permissions on your site's data.
    • /opt/collabnet/teamforge/runtime/scripts/fix_data_permissions.sh
    Note: This process can take a long time on sites with a lot of data.
  15. Convert your site data to work with TeamForge 16.7.
    Tip: Before you kick off the data migration, do the following:
    • Use the /etc/init.d/collabnet status command to make sure the JBoss, Tomcat and Tomcatcs services are stopped.
    • If any of the trackers in your project already contains a field with the name team, conflict may arise while running the migrate.py script. This is because of the inclusion of the Team feature in TeamForge 8.0. To prevent this conflict, follow the steps given in FAQ on troubleshooting.
    • /opt/collabnet/teamforge/runtime/scripts/migrate.py
    The migrate.py script locates the existing site data and modifies it as needed.

    This includes configuration data for LDAP and the James mail server. Any modifications that you have applied to these components on your old site are reproduced on your upgraded TeamForge 16.7 site.

  16. Start TeamForge.
    • /etc/init.d/collabnet start

Note: Gerrit is configured as part of the post installation tasks included in the post-install.py script. As a result, Gerrit's status would be Not configured during startup, which you can safely ignore.

  1. If you have CVS integrations, synchronize permissions post upgrade. See, Synchronize TeamForge source control integrations.
  2. Run the TeamForge post installation script. For more information, see post-install.py.
    • /opt/collabnet/teamforge/runtime/scripts/post-install.py
    Note: In case you face any GIT-related issues while running the post-install.py script, see Post install fails for GIT. What should I do?.

Do this on the Black Duck Code Sight Server (my.codesight.host)

  1. If you have installed Black Duck Code Sight, then install the license for Black Duck Code Sight. For more information, see Install the Black Duck Code Sight license.
  2. Run the svn_cache.sh script.
    • cd /opt/collabnet/teamforge/runtime/scripts/codesearch/
    • ./svn_cache.sh <Repository Base URL Path of the SCM Integration Server>

    Provide a repository base URL path of the SCM integration server, for example, "http://myint.box.net/svn/repos", where myint.box is the server with the SCM integration server.

    In addition, if you add a new integration server at some point later, you must run this svn_cache.sh script, (after creating the new integration server), on the TeamForge application server.

Do the following on the application server - my.app.host

  1. Restart the collabnet services.
    • /etc/init.d/collabnet restart
  2. Apply the finishing touches and make sure everything is running smoothly after upgrading to TeamForge 16.7.
    1. Log into your site as the administrator.
    2. If your site has custom branding, verify that your branding changes still work as intended. See Change your site's look and feel.
    3. Let your site's users know they've been upgraded. See Communicate with all site users at once.