Upgrade from TeamForge 16.3 to 17.11 - All services on the same server

Single server setup. In this procedure, we'll assume that you are upgrading on the same server where your existing TeamForge 16.3 site is running. The following instructions are valid for both RHEL/CentOS 6.9/7.4 platforms. Specific steps, if applicable only for a particular RHEL/CentOS platform, are called out explicitly.

Do the following on the 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 Review Board.
   • cd /opt/collabnet/RBInstaller-1.7.0.0.7
   • python ./install.py -u
4. 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 or later releases:

   • /opt/collabnet/teamforge/bin/teamforge stop
5. 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
6. 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.
7. Move the CollabNet-Orchestrate.repo file.
   Important: This is required only if you are upgrading from TeamForge 16.3 (or earlier) to TeamForge 16.10 (or later).
   • mv /etc/yum.repos.d/CollabNet-Orchestrate.repo /etc/yum.repos.d/CollabNet-Orchestrate.repo_old
8. Run the following commands to upgrade Red Hat/CentOS to the latest version.
   1. Remove the neon-devel package.
      • yum erase neon-devel -y
   2. Upgrade the operating system packages.
      • yum upgrade
9. Attention: Do this if and only if you are upgrading TeamForge on RHEL/CentOS 6.9.
   Delete the python-crypto package.
   • yum erase python-crypto
10. 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 RPM package: CTF-Disconnected-media-17.11.501-841.rhel6.x86_64.rpm
       • Red Hat Enterprise Linux/CentOS 7.4 64 bit RPM package: CTF-Disconnected-media-17.11.501-841.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
11. Install the following application packages.
    1. To install the TeamForge application packages run the following command:
       • yum install teamforge CN-eventq collabnet-nginx collabnet-passenger
       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
       ...
       ...

       Run the following command to install the Binary application packages.

       • yum install cn-binary
12. 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 domain name tokens.

       server-01:SERVICES=ctfcore ctfcore-database ctfcore-datamart etl mail 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

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

    10. Save the site-options.conf file.
13. 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.

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

15. Run the /var/lib/pgsql/analyze_new_cluster.sh script.
    • su - postgres -c "/var/lib/pgsql/analyze_new_cluster.sh"
16. Run the following script to upgrade the Subversion working copies.
    • /opt/collabnet/teamforge/runtime/scripts/svn-upgrade-working-copies.sh
17. If you have CVS integrations, synchronize permissions post upgrade. See, Synchronize TeamForge source control integrations.
18. 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.
19. Remove the backup files, if any, after the TeamForge site is up and running as expected.