Upgrade to TeamForge 16.7 - SCM and Git on a separate server

In this procedure, we'll 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 services run of the SCM server (we call this my.scmandgit.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 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-1.8.0.0.12
    • 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. No backup is required for same hardware upgrades. However, you can create a backup as a precaution. See Back up and restore TeamForge and EventQ to learn more about backing up TeamForge database and file system.
  6. Upgrade the operating system packages.
    • yum upgrade
  7. 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.
  8. 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.
      [RHEL-CDROM] 
      name=RHEL CDRom 			
      baseurl=file:///media/cdrom/Server/
      gpgfile=file:///media/cdrom/RPM-GPG-KEY-redhat-release 
      enabled=1
      gpgcheck=0
    6. Verify your yum configuration files.
      • yum list httpd
      • yum list apr
  9. 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.
    1. To install the CollabNet binary application, run the following command.
      • yum install cn-binary
  10. 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 database datamart etl indexer
      HOST_my.scmandgit.domain.com=subversion cvs gerrit
      HOST_my.codesight.domain.com=codesearch
      DOMAIN_localhost=my.app.domain.com
      Add 'binary' to the HOST_localhost token if you are installing Nexus.
      HOST_localhost=app database datamart etl indexer binary
    4. The SCM_DEFAULT_SHARED_SECRET should be the same on both my.app.host and my.scmandgit.host.
    5. 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.
      SSL=on
      SSL_CERT_FILE
      SSL_KEY_FILE
      SSL_CHAIN_FILE
      Note: The SSL_CERT_FILE and SSL_KEY_FILE tokens need an absolute path. The SSL_CHAIN_FILE token is optional.
    6. If the token REQUIRE_PASSWORD_SECURITY is enabled, then set a value for the token, PASSWORD_CONTROL_EFFECTIVE_DATE.
      CAUTION:
      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.
    7. TeamForge 7.1 and later support automatic password creation. See AUTO_DATA for more information.
    8. 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.
    9. Include the list of non-expiring TeamForge user accounts (password never expires).
      USERS_WITH_NO_EXPIRY_PASSWORD=admin,nobody,system,scmviewer,scmadmin
    10. Make sure that the following tokens have a value if ETL is enabled.
      SOAP_ANONYMOUS_SHARED_SECRET
      ETL_SOAP_SHARED_SECRET
    11. Configure the Black Duck Code Sight tokens. See Black Duck Code Sight site-option tokens.
    12. 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.
    13. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
    14. Ensure to set the token SELINUX_SETUP=true.
    15. Make sure the PostgreSQL tokens in the site-options.conf file are set as recommended in the following topic: What are the right PostgreSQL settings for my site?
    16. Enable the POSTGRES_INTERFACE token in the site-options.conf file if the value of "ifconfig -a" is not eth0/enp0*.
    17. 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.
    18. Important: This step is required if you want Git notification emails.
      Update the JAMES_ACCEPTED_RELAYS site-options token with the Git server's IP address. See JAMES_ACCEPTED_RELAYS for more information.
      JAMES_ACCEPTED_RELAYS=127.0.0.1,{__CEE_DOMAIN__},<The IP address of the Git server>
    19. Save the site-options.conf file.
  11. Create the runtime environment.
    • /opt/collabnet/teamforge/installer/install.sh

Do the following on the SCM server - my.scmandgit.host

  1. Stop TeamForge.
    • /etc/init.d/collabnet stop all
  2. No backup is required for same hardware upgrades. However, you can create a backup as a precaution. See Back up and restore TeamForge and EventQ to learn more about backing up TeamForge database and file system.
  3. Upgrade the operating system packages.
    • yum upgrade
  4. If the TeamForge server has SELinux enabled, disable it 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 either "Disabled" or "Permissive", SELinux is already disabled.
    3. If not disabled, run the following command to disable SELinux.
      • setenforce 0
  5. 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.
      [RHEL-CDROM] 
      name=RHEL CDRom 			
      baseurl=file:///media/cdrom/Server/
      gpgfile=file:///media/cdrom/RPM-GPG-KEY-redhat-release 
      enabled=1
      gpgcheck=0
    6. Verify your yum configuration files.
      • yum list httpd
      • yum list apr
  6. Install the following application packages.
    1. Install the source code component.
      • yum install teamforge-scm
    2. To install the Git packages, run the following command.
      • yum install teamforge-git
  7. Copy the master site-options.conf file from my.app.host and modify the host token settings in the site-options.conf file.
    Note: If you choose to use the old site-options.conf file, don’t forget to copy the AUTO_DATA token from the application server.
    HOST_my.scmandgit.host=subversion cvs gerrit
    DOMAIN_my.scmandgit.host=my.scmandgit.domain.com
    HOST_my.app.domain.com=app database datamart etl indexer
    HOST_my.codesight.domain.com=codesearch
  8. Save the site-options.conffile.
  9. Create the runtime environment.
    • /opt/collabnet/teamforge/installer/install.sh
  10. Start TeamForge.
    • /etc/init.d/collabnet start all

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

  1. 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.

  2. 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 the following on the SCM server - my.scmandgit.host

  1. 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?.
  2. 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.

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

  1. 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.
  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.
Note: After upgrade, it takes some time for the publishing repositories to get created for projects imported from other TeamForge sites.