Upgrade to TeamForge 17.11 on new hardware

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

Before you begin:
  • TeamForge 17.11 supports both RHEL/CentOS 6.9 and 7.4. 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.11.
  • Reset the PASSWORD_CONTROL_EFFECTIVE_DATE token while upgrading to TeamForge 17.8. If not reset, the Password Control Kit (PCK) disables, deletes or expires user accounts immediately.

Dos and Don'ts

Dos and Don'ts while installing or upgrading TeamForge.

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)
  • Codesearch 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 (eventq, mongodb, redis and rabbitmq)
  • TeamForge CLI Server (cliserver)

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

  1. Install Red Hat Enterprise Linux/CentOS 7.4 and log on as root.

    The host must be registered with the Red Hat Network if you are using Red Hat Enterprise Linux.

    See the Red Hat installation guide for help.

  2. Check your basic networking setup. See Set up Networking for more information.

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.11 upgrade process.
    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.
      Important: Post upgrade, you can add custom event handlers again from the backup while making sure that you don't have SOAP50 (deprecated) library used.
  2. Stop TeamForge. In a distributed setup, stop TeamForge on all the servers.
    If you are upgarding from TeamForge 16.7 or earlier releases:
    • /etc/init.d/collabnet stop
    If you are upgrading from TeamForge 16.10, 17.1, or 17.4 release:
    • /opt/collabnet/teamforge/bin/teamforge stop
    If you are upgrading from TeamForge 17.8 or later releases:
    • teamforge stop
  3. Make sure EventQ services have been stopped.
    If you are upgrading from TeamForge 16.3:
    • /etc/init.d/orchestrate stop
    If you are upgrading from TeamForge 16.7, 16.10, or 17.1 release:
    • /etc/init.d/eventq stop
    • /etc/init.d/collabnet-rabbitmq-server stop
    • /etc/init.d/collabnet-mongod stop
    If you are upgrading from TeamForge 17.4 release:
    • /opt/collabnet/teamforge/bin/teamforge stop
    If you are upgrading from TeamForge 17.8 release:
    • teamforge stop
  4. Backup your site data.
    1. If you are upgrading from TeamForge 16.7 or earlier to TeamForge 17.11:
      Back up your site database
      • mkdir -p /tmp/backup_dir
      • cd /var/lib
      • tar -zcvf /tmp/backup_dir/pgsql.tgz pgsql/9.3
      Tip: /tmp/backup_dir is just an example. You can use any directory or partition you prefer to store your backup files.

      Back up the file system data

      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
      Back up EventQ
      • cp -Rpfv /opt/collabnet/eventq/config/*.yml /opt/collabnet/mongodb /opt/collabnet/rabbitmq /tmp/backup_dir
      Compress your backup data
      • cd /tmp
      • tar czvf 167backup.tgz backup_dir
    2. If you are upgrading from TeamForge 16.10 or later to TeamForge 17.11:
      • mkdir -p /tmp/backup_dir
      • cp -Rpfv /opt/collabnet/teamforge/var /tmp/backup_dir
      Tip: /tmp/backup_dir is just an example. You can use any directory or partition you prefer to store your backup files.

      If Git integration is enabled

      • mkdir /tmp/backup_dir/gerrit
      • cp -Rpfv /opt/collabnet/gerrit/ /tmp/backup_dir/gerrit
      Back up EventQ
      • cp -Rpfv /opt/collabnet/eventq/config/*.yml /opt/collabnet/mongodb /opt/collabnet/rabbitmq /tmp/backup_dir

      Compress your backup data

      • cd /tmp
      • tar czvf 178backup.tgz backup_dir
    3. Back up your SSH keys, if any.
    4. Back up your SSL certificates and keys, if any.
  5. Copy the master configuration file from the this 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.
  6. Copy the backed up data to the new TeamForge Application Server.
    • scp /tmp/178backup.tgz username@newbox:/tmp or scp /tmp/167backup.tgz username@newbox:/tmp

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

  1. Unpack the file system data.
    • cd /tmp
    • tar xzvf 178backup.tgz or tar xzvf 167backup.tgz
  2. Upgrade the operating system packages.
    • yum upgrade
  3. Reboot the server.
    • reboot
  4. Configure your TeamForge installation repository.
    • TeamForge installation repository configuration for sites with internet access
    1. Contact the CollabNet Support and download the TeamForge 17.11 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-17.11-0.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.11disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.4 64 bit RPM package: CTF-Disconnected-media-17.11.455-814.rhel7.x86_64.rpm
        Note: In addition to the above CentOS 7.4 64 bit RPM package, you must get the following CentOS 7.4 compatibility RPM, which is required for TeamForge 17.11 disconnected media installation on CentOS 7.4 profile: compat-ctf-dc-media-1.1-1.el7.noarch.rpm.
    2. Unpack the disconnected installation package.
      • rpm -Uvh <package-name>
    3. Unpack the compat-ctf-dc-media-1.1-1.el7.noarch.rpm package if you are installing TeamForge 17.11 on CentOS 7.4.
      • rpm -ivh compat-ctf-dc-media-1.1-1.el7.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
  5. Install the TeamForge application packages.
    • yum install teamforge

Important: The following warning message, which shows up during TeamForge install/upgrade (while installing CN-eventq rpm) can be safely ignored.
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
...
...
Errno::ENOENT: No such file or directory - git
...
...

  1. Install PostgreSQL 9.3 packages. Do this if and only if you are upgrading from TeamForge 17.4 or earlier.
    • yum install postgresql93-*
  2. Reload site data.
    1. If you are upgrading from TeamForge 16.7 or earlier to TeamForge 17.11:
      • cd /opt/collabnet/teamforge/
      • mkdir var
      • cd var
      • tar zvxf /tmp/backup_dir/pgsql.tgz
      • 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
      • 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
      EventQ
      • yes | cp -Rf /tmp/backup_dir/*.yml /opt/collabnet/eventq/config/
      • yes | cp -Rf /tmp/backup_dir/mongodb /opt/collabnet
      • yes | cp -Rf /tmp/backup_dir/rabbitmq /opt/collabnet
    2. If you are upgrading from TeamForge 16.10 or later to TeamForge 17.11:
      • cp -Rpfv /tmp/backup_dir/var /opt/collabnet/teamforge/
      If Git integration is enabled
      • 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
      EventQ
      • yes | cp -Rf /tmp/backup_dir/*.yml /opt/collabnet/eventq/config/
      • yes | cp -Rf /tmp/backup_dir/mongodb /opt/collabnet
      • yes | cp -Rf /tmp/backup_dir/rabbitmq /opt/collabnet
  3. Copy the site-options.conf file to the TeamForge installer directory.
    • cp /tmp/site-options.conf /opt/collabnet/teamforge/etc/
  4. Set up your site's master configuration file.
    1. Set up your site options. See Site options change log for a list of site option changes. While upgrading to a latest TeamForge release, make sure that obsolete site option tokens, if any, are removed from the site-options.conf file of the TeamForge version you are upgrading to.
      • vi /opt/collabnet/teamforge/etc/site-options.conf
    2. Configure the services and and domain name tokens.
      server-01:SERVICES = ctfcore ctfcore-database ctfcore-datamart mail etl search codesearch 
      subversion cvs eventq redis mongodb rabbitmq cliserver gerrit gerrit-database binary binary-database 
      reviewboard reviewboard-database reviewboard-adapter
      server-01:PUBLIC_FQDN = my.app.domain.com
      Note: You may remove the identifiers of components you do not want. For example, remove binary and binary-database if you are not planning to install binary repository managers such as Nexus.
    3. Set the MONGODB_APP_DATABASE_NAME token with EventQ’s database name in the site-options.conf file. Do this if and only if you are upgrading from TeamForge 17.1 or earlier to TeamForge 17.4 or later.
      MONGODB_APP_DATABASE_NAME=orchestrate
    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.
      SSL_CERT_FILE=
      SSL_KEY_FILE=
      SSL_CHAIN_FILE=
      Important: All SSL certificates including self-signed certificates are added automatically.
    5. If the token REQUIRE_PASSWORD_SECURITY is enabled, then set this PASSWORD_CONTROL_EFFECTIVE_DATE token with a future date. If already set, reset the PASSWORD_CONTROL_EFFECTIVE_DATE with a future date while upgrading to TeamForge 17.11.
      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. You must set (or reset if required) this token with a future date. For example, you can use the following logic and pick a future date: PASSWORD_CONTROL_EFFECTIVE_DATE=<the day on which TeamForge upgrade is done> + PASSWORD_WARNING_PERIOD. 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. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
    8. 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?
    9. 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.

    10. Save the site-options.conf file.
  5. Install Review Board (note that you should have added the following identifiers to the SERVICES token: reviewboard, revieboard-database, and reviewboard-adapter).
    • yum install CN-reviewboard

    For more information, see Upgrade Review Board.

  6. 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
  7. If you have the TeamForge database and datamart on two separate ports on the same server, you must create a dump of both the database and datamart and load them into the same PostgreSQL instance. For more information, see Upgrade on new hardware: Create a single cluster for both Database and Datamart.
  8. Provision services.
    • teamforge provision
    Note:

    TeamForge 17.4 (and later) installer expects the system locale to be LANG=en_US.UTF-8. TeamForge "provision" command fails otherwise.

  9. Run the /var/lib/pgsql/analyze_new_cluster.sh script. This is required if and only if you are upgrading from TeamForge 17.1 (or earlier) to TeamForge 17.8 (or later).
    • su - postgres -c "/var/lib/pgsql/analyze_new_cluster.sh"
  10. If you have CVS integrations, synchronize permissions post upgrade. See, Synchronize TeamForge source control integrations.
  11. Verify TeamForge installation.
    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 Customize TeamForge .
    3. Let your site's users know they've been upgraded. See Create a Side-wide Broadcast.
  12. 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.