Upgrade TeamForge, EventQ, Database and Datamart on Three Separate Servers

Three-server setup, same hardware upgrade, with TeamForge, EventQ, Database and Datamart on three separate servers.

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.

Three Server Setup

Here's how the services are distributed across three separate RHEL/CentOS 6.9/7.4 servers.
Services TeamForge Application Server (server-01) EventQ Server (server-02) Database Server (server-03)
ctfcore
   
mail
   
search
   
codesearch
   
etl
   
gerrit
   
gerrit-database    
reviewboard
   
reviewboard-database
 
reviewboard-adapter
   
subversion
   
cvs
   
binary
   
binary-database    
cliserver
   
eventq  
 
mongodb  
 
redis  
 
rabbitmq  
 
ctfcore-database    
ctfcore-datamart    
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 and EventQ database and file system.

Do this step by step on TeamForge Application Server (server-01)

  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. Uninstall hotfixes and add-ons, if any, installed on your site.
  3. If you have Review Board installed, uninstall it.
    • cd /opt/collabnet/RBInstaller-17.8.14
    • python ./install.py -u
  4. 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
  5. Upgrade the operating system packages.
    • yum upgrade
  6. 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.11 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 6.9 64 bit: CTF-Disconnected-media-17.11.501-841.rhel6.x86_64.rpm
      • Red Hat Enterprise Linux/CentOS 7.4 64 bit: CTF-Disconnected-media-17.11.501-841.rhel7.x86_64.rpm
      • 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. If not mounted already, 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
  7. Install the TeamForge application packages.
    • yum install teamforge
    Attention: TeamForge installer has been 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 17.11 on the same hardware (when you run the yum install teamforge command). You can safely ignore such warning messages and proceed with the upgrade.
    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
...
...
  8. Install the Binary application packages. This is required if and only if you are upgrading from TeamForge 16.10 (or earlier) to TeamForge 17.8 (or later).
    • yum install cn-binary

Do this step by step on the Database Server (server-03)

  1. Upgrade the operating system packages.
    • yum upgrade
  2. 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.11 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 6.9 64 bit: CTF-Disconnected-media-17.11.501-841.rhel6.x86_64.rpm
      • Red Hat Enterprise Linux/CentOS 7.4 64 bit: CTF-Disconnected-media-17.11.501-841.rhel7.x86_64.rpm
      • 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. If not mounted already, 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
  3. 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
  4. Install the TeamForge database packages.
    • yum install teamforge-database
  5. Set up your site's master configuration file.
    • vi /opt/collabnet/teamforge/etc/site-options.conf
    1. host: SERVICES Token
      • server-01:SERVICES=ctfcore mail etl search subversion cvs codesearch cliserver gerrit 
binary reviewboard reviewboard-database reviewboard-adapter
      • server-02:SERVICES=eventq mongodb redis rabbitmq
      • server-03:SERVICES=ctfcore-database ctfcore-datamart gerrit-database binary-database
      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.
    2. host: PUBLIC_FQDN Token
      server-01:PUBLIC_FQDN=my.app.domain.com
    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. SSL Tokens
      SSL is enabled by default and a self-signed certificate is auto-generated. Use the following tokens to adjust this behavior.
      SSL_CERT_FILE=
SSL_KEY_FILE=
SSL_CHAIN_FILE=
      • 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.
      • All SSL certificates including self-signed certificates are added automatically.
    5. Password Tokens
      • TeamForge 7.1 and later support automatic password creation. See AUTO_DATA for more information.
      • If the token REQUIRE_PASSWORD_SECURITY is enabled, then set/reset 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.
      • If the token REQUIRE_RANDOM_ADMIN_PASSWORD is already set to true, then set the token ADMIN_EMAIL with a valid email address.
        ADMIN_EMAIL=root@{__APPLICATION_HOST__}
      • If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site-options.conf token to false.
    6. PostgreSQL Tokens and Settings
    7. JAVA_OPTS

      Configure the JBOSS_JAVA_OPTS site-options.conf token. See JBOSS_JAVA_OPTS.

      Note: All JVM parameters but -Xms1024m and -Xmx2048m have been hard-coded in the TeamForge core application. You cannot manually configure any of the following default JVM parameters in the site-options.conf file.
      • -XX:+UseParallelGC
      • -XX:MaxMetaspaceSize=512m
      • -XX:ReservedCodeCacheSize=128M
      • -server
      • -XX:+HeapDumpOnOutOfMemoryError
      • -XX:HeapDumpPath=/tmp -verbose:gc
      • -XX:+PrintCodeCache
      • -Djsse.enableSNIExtension=false
      • -Dsun.rmi.dgc.client.gcInterval=600000
      • -Dsun.rmi.dgc.server.gcInterval=600000
      • -Djava.security.egd=file:/dev/urandom
      • -Djava.awt.headless=true.

      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 default value and ignores any user defined value.

    8. Save the site-options.conf file.
  6. 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.

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

  8. 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"

Do this step by step on TeamForge Application Server (server-01)

  1. Copy the site-options.conf file from the Database Server to the TeamForge Application Server's /opt/collabnet/teamforge/etc/ directory.
  2. 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.

  3. 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"
  4. If you have CVS integrations, synchronize permissions post upgrade. See, Synchronize TeamForge source control integrations.

Do this step by step on EventQ Server (server-02)

  1. 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
  2. Upgrade the operating system packages.
    • yum upgrade
  3. 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.11 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.4 64 bit: CTF-Disconnected-media-17.11.501-841.rhel7.x86_64.rpm
      • 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 -ivh <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. If not mounted already, 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
  4. Install the EventQ packages.
    • yum install teamforge-eventq CN-eventq collabnet-nginx collabnet-passenger
    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
...
...
  5. Copy the site-options.conf file from the Database Server (server-03) to the EventQ Server's /opt/collabnet/teamforge/etc/ directory.
  6. 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.

Do this step by step on TeamForge Application Server (server-01)

  1. 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.
  2. 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.
  3. Fix the TeamForge Avatar display issue on RHEL/CentOS 6.9. TeamForge Avatar image is not displayed properly post Review Board installation on RHEL/CentOS 6.9. Run the following commands to work around this issue:
    • yum erase python-imaging
    • yum install teamforge
    • service httpd restart

Post Upgrade Tasks

Parent topic: Upgrade to TeamForge 17.11 on same hardware: RHEL/CentOS 6.9/7.4
Related concepts
TeamForge installation/upgrade/configuration/administration FAQs