Upgrade to TeamForge 17.1 on new hardware

To upgrade to TeamForge 17.1, set up a new hardware, then bring your old site's data and convert it.

Before you begin:


  • TeamForge 17.1 supports both RHEL/CentOS 6.8 and 7.3. See TeamForge installation requirements
  • For the ETL service to run as expected in a distributed TeamForge installation, all servers must have the same time zone.
  • While you can run both EventQ and TeamForge on the same server, CollabNet recommends such an approach only for testing purposes. It's always recommended to run EventQ on a separate server for optimal scalability. See EventQ installation requirements.
  • Installing or upgrading TeamForge needs root privileges. You must log on as root or use a root shell to install or upgrade TeamForge.
  • In a distributed setup, stop TeamForge services on all the servers while upgrading to TeamForge 17.1.
In this setup, the following services run on the TeamForge Application Server (we call this server-01).
  • TeamForge Application Server (ctfcore)
  • Database Server (ctfcore-database and ctfcore-datamart)
  • Code Search Server (codesearch)
  • Mail Server (mail)
  • ETL Server (etl)
  • Git Integration Server (gerrit and gerrit-database)
  • SCM Integration Server (subversion and cvs)
  • Search Server (search).
  • TeamForge EventQ Server (App, MongoDB and RabbitMQ)

Do this on the new TeamForge Application Server (ctfcore) - server-01

  1. Install Red Hat Enterprise Linux/CentOS 7.3 and log in as root.
  2. Check your basic networking setup. See Set up networking for your TeamForge server for details.

Do this on the existing TeamForge Application Server

  1. Back up all your custom event handlers and remove all the event handler JAR files before starting your TeamForge 17.1 upgrade process. Post upgrade, you can add custom event handlers again from the backup while making sure that you don't have SOAP50 (deprecated) library used.
    1. Go to My Workspace > Admin.
    2. Click SYSTEM TOOLS from the Projects menu.
    3. Click Customizations.
    4. Select the custom event handler and click Delete.
  2. Stop TeamForge.
    If you are upgrading from TeamForge 16.7 or earlier releases:
    • /etc/init.d/collabnet stop all
    If you are upgrading from TeamForge 16.10:
    • /opt/collabnet/teamforge/bin/teamforge stop
  3. Back up your site database.
    Tip: /tmp/backup_dir is just an example. You can use any directory or partition you prefer to store your backup files.
    • mkdir -p /tmp/backup_dir
    • cd /var/lib
    • tar -zcvf /tmp/backup_dir/pgsql.tgz pgsql/9.3
  4. Back up the file system data.
    Tip: /tmp/backup_dir is just an example. You can use any directory or partition you prefer to store your backup files.
    1. Make an archive file with the following data directories:
      Directory Contents
      /opt/collabnet/teamforge/var User-created data, such as artifact attachments
      /opt/collabnet/reviewboard Review Board data
      /svnroot Subversion source code repositories
      /sf-svnroot Subversion repository for branding data
      /cvsroot CVS source code repositories (not present on all sites)
      /gitroot GIT source code repositories
      • cp -Rpfv /svnroot /sf-svnroot /cvsroot /opt/collabnet/teamforge/var /opt/collabnet/reviewboard /tmp/backup_dir
      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
      Compress your backup data.
      • cd /tmp
      • tar czvf 1610backup.tgz backup_dir
    2. Back up your SSH keys, if any.
    3. Back up your SSL certificates and keys, if any.
  5. Back up EventQ. See Back up and restore EventQ data.
  6. Copy the master configuration file from the old server to the /tmp directory on the new TeamForge server.
    • scp /opt/collabnet/teamforge/etc/site-options.conf username@newbox:/tmp
    Tip: scp is just an example. You can choose any file transfer method you prefer.
  7. Copy the file system data to the new TeamForge Application Server.
    • scp /tmp/1610backup.tgz username@newbox:/tmp

Do this on the new TeamForge Application Server (ctfcore) - server-01

  1. Unpack the file system data.
    • cd /tmp
    • tar xzvf 1610backup.tgz
  2. If the TeamForge server has SELinux enabled, run it in 'Permissive' mode temporarily while installing or upgrading TeamForge.
    Important: If you have SELinux in "enforcing" mode, you must either disable SELinux or switch to "Permissive" mode (recommended) before running the /opt/collabnet/teamforge/bin/teamforge provision command. TeamForge create runtime fails otherwise.
    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 enforcing mode after completing the installation or upgrade.
  3. Upgrade the operating system packages.
    • yum upgrade
  4. Reboot the server.
    • reboot
  5. Configure your TeamForge installation repository.
    • TeamForge installation repository configuration for sites with internet access
    1. Contact the CollabNet Support and download the TeamForge 17.1 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-17.1-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 17.1 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.3 64 bit RPM package: CTF-Disconnected-media-17.1.556-48.rhel7.x86_64.rpm
        Note: In addition to the above CentOS 7.3 64 bit RPM package, you must get the following CentOS 7.3 compatibility RPM, which is required for TeamForge 17.1 disconnected media installation on CentOS 7.3 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 17.1 on CentOS 7.3.
      • 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
  6. Install the TeamForge application packages.
    • yum install teamforge
  7. Reload the PostgreSQL data.
    • cd /opt/collabnet/teamforge/
    • mkdir var
    • cd var
    • tar zvxf /tmp/backup_dir/pgsql.tgz
  8. Copy the site-options.conf file to the TeamForge installer directory.
    • cp /tmp/site-options.conf /opt/collabnet/teamforge/etc/
  9. 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. Configure the services and and domain name tokens.
      server-01:SERVICES = ctfcore ctfcore-database mail etl ctfcore-datamart search subversion cvs codesearch
      server-01:PUBLIC_FQDN = my.app.domain.com
      Add Gerrit identifiers if you are installing Git.
      server-01:SERVICES = ctfcore ctfcore-database mail etl ctfcore-datamart search subversion cvs 
      codesearch gerrit gerrit-database
      Add Binary identifiers if you are installing Nexus.
      server-01:SERVICES = ctfcore ctfcore-database mail etl ctfcore-datamart search subversion cvs 
      codesearch gerrit binary binary-database
      Add Review Board identifiers if you are installing Review Board.
      server-01:SERVICES = ctfcore ctfcore-database mail etl ctfcore-datamart search subversion cvs 
      codesearch gerrit binary binary-database reviewboard reviewboard-database
    4. Attention: SSL is enabled by default and a self-signed certificate is auto-generated. Use the following tokens to adjust this behavior. To generate the SSL certificates, see Generate SSL certificates.
      Have the custom SSL certificate and private key for custom SSL certificate in place and provide their absolute paths in these tokens. SSL_CHAIN_FILE (intermediate certificate) is optional.
      Important: You need to add the SSL certificate to the Java keystore if the site uses a self-signed certificate. For instructions on adding the self-signed certificate to the Java keystore, see Protect integrations with SSL.
    5. 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.
    6. TeamForge 7.1 and later support automatic password creation. See AUTO_DATA for more information.
    7. 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.
    8. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
    9. 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?
    10. Enable the POSTGRES_INTERFACE token in the site-options.conf file if the value of "ifconfig -a" is not eth0/enp0*.
    11. 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.

    12. Configure TeamForge site options to proxy EventQ through TeamForge. For more information, see "EventQ and TeamForge on the same server" section in this topic: Proxying EventQ through TeamForge. Also see Proxy settings and ports used by TeamForge EventQ services.
    13. Save the site-options.conf file.
  10. Reload the svnroot, sf-svnroot, cvsroot, gitroot and var directories.
    • cp -Rpfv /tmp/backup_dir/svnroot /svnroot
    • cp -Rpfv /tmp/backup_dir/cvsroot /cvsroot
    • cp -Rpfv /tmp/backup_dir/sf-svnroot /sf-svnroot
    • cp -Rpfv /tmp/backup_dir/var /opt/collabnet/teamforge/
    If Git integration is enabled, do the following:
    • cp -Rpfv /tmp/backup_dir/gitroot /gitroot
    • cp -Rpfv /tmp/backup_dir/gerrit/gerrit/etc /opt/collabnet/gerrit
    • cp -Rpf /tmp/backup_dir/gerrit/gerrit/.ssh /opt/collabnet/gerrit
    • cp -Rpf /tmp/backup_dir/gerrit/gerrit/bin /opt/collabnet/gerrit
    • cp -Rpf /tmp/backup_dir/gerrit/gerrit/index /opt/collabnet/gerrit
  11. As you are upgrading on new hardware, contact CollabNet Support, generate the license key for the new server (IP address) and use it to replace /opt/collabnet/teamforge/var/etc/sflicense.txt
  12. Deploy services.
    • /opt/collabnet/teamforge/bin/teamforge provision

    The "provision" command prompts for response before it bootstraps or migrates data during TeamForge installation and upgrade respectively. Enter "Yes" or "No" to proceed. For more information, see The teamforge script.

  13. 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.
  14. If you have CVS integrations, synchronize permissions post upgrade. See, Synchronize TeamForge source control integrations.
  15. Run the TeamForge post installation script. For more information, see post-install.py.
    • /opt/collabnet/teamforge/runtime/scripts/post-install.py
  16. Upgrade EventQ. See Upgrade EventQ.
  17. Apply the finishing touches and make sure everything is running smoothly after upgrading to TeamForge 17.1.
    1. Log on to the TeamForge web application using the default Admin credentials.
      • Username: "admin"
      • Password: "admin"
    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.
  18. Remove the backup files, if any, after the TeamForge site is up and running as expected. Remove the repository and the file system backup from the /tmp/backup_dir directory.
Note: After upgrade, it takes some time for the publishing repositories to get created for projects imported from other TeamForge sites.