Upgrade to TeamForge 17.11 - Oracle database services on a separate server

Three server setup with TeamForge, Database and Datamart (Oracle), and EventQ on separate servers. In this procedure, we'll assume that you are upgrading on the same server where your existing TeamForge 17.8 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 this on the Database Server (Oracle) - server-03

1. Make a dump file of your site database.

   To back up the Oracle database, follow the Oracle backup procedure.

Do the following on the TeamForge Application Server - server-01

2. 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.
3. Uninstall hotfixes and add-ons, if any, installed on your site.
4. If you have Review Board installed, uninstall it.
   • cd /opt/collabnet/RBInstaller-17.8.14
   • python ./install.py -u
5. Stop the TeamForge CLI add-on.
   • service teamforge_cli_server stop
6. Go to /var/run/cli/ and look for "server" file. If found, remove the "server" file.
   • cd /var/run/cli/
   • rm -rf /var/run/cli/server
7. Stop TeamForge.
   If you are upgarding from TeamForge 17.1 (or earlier) to TeamForge 17.8 (or later):

   • /etc/init.d/collabnet stop
   Use the following command otherwise:

   • teamforge stop
8. Go to /opt/collabnet/teamforge/runtime/temp and look for .marker files. If found, remove the .marker files.
   • cd /opt/collabnet/teamforge/runtime/temp
   • rm -rf *.marker
9. Back up the file system data.
   Tip: /tmp in the following step is just an example. You can use any directory or partition that you prefer.
   1. Make an archive file with the following data directories:

      Directory	Contents
      /opt/collabnet/teamforge/var	User-created data, such as artifact attachments
      /svnroot	Subversion source code repositories
      /sf-svnroot	Subversion repository for branding data
      /cvsroot	CVS source code repositories (not present on all sites)

      • mkdir -p /tmp/backup_dir
      • cp -Rpfv /svnroot /sf-svnroot /cvsroot /opt/collabnet/teamforge/var /tmp/backup_dir
   2. 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
   3. Back up your SSH keys, if any.
   4. Back up your SSL certificates and keys, if any.
10. If Git is enabled, create a gerrit database dump file, for PostgreSQL upgrade.
    • su - postgres
    • /usr/bin/pg_dumpall > /var/lib/pgsql/9.3/backups/teamforge_gerrit_data_backup.dmp
    • exit
11. Upgrade the operating system packages.
    • yum upgrade
12. If the TeamForge server has SELinux enabled, run it in 'permissive' mode temporarily while installing or upgrading TeamForge.

    If you have SELinux in "enforcing" mode, you must either disable SELinux or switch to "permissive" mode (recommended) before running the 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
13. 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.xx-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.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.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.11 on CentOS 7.4.
       • 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
14. Install the following application packages.
    1. To install the TeamForge application packages run the following command:
       • 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.

       Run the following command to install the Binary application packages.

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

       server-01:SERVICES = ctfcore mail etl search codesearch subversion cvs

       server-03:SERVICES = ctfcore-database ctfcore-datamart

       server-01:PUBLIC_FQDN = my.app.domain.com

       Add Gerrit identifiers if you are installing Git.

       server-01:SERVICES = ctfcore mail etl search codesearch subversion cvs gerrit gerrit-database

       Add Binary identifiers if you are installing Nexus.

       server-01:SERVICES = ctfcore mail etl search codesearch subversion cvs gerrit gerrit-database binary binary-database

       Add Review Board identifiers if you are installing Review Board.

       server-01:SERVICES = ctfcore mail etl search codesearch subversion cvs gerrit gerrit-database 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.

       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. Include the list of non-expiring TeamForge user accounts (password never expires).

       USERS_WITH_NO_EXPIRY_PASSWORD=admin,nobody,system,scmviewer,scmadmin

    7. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
    8. 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.

    9. Configure TeamForge site options to proxy EventQ through TeamForge. For more information, see "EventQ and TeamForge on two separate servers" section in this topic: Proxying EventQ through TeamForge. Also see Ports used by TeamForge EventQ services.
    10. Save the site-options.conf file.
16. Download the corresponding version of the Oracle client from http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html
    • yum localinstall <path to oracle client rpm>
17. 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.

18. Update the file permissions on your site's data.
    • teamforge apply-permissions
    Note: This process can take a long time on sites with a lot of data.
19. If you have CVS integrations, synchronize permissions post upgrade. See, Synchronize TeamForge source control integrations.
20. Run the TeamForge post installation script. For more information, see post-install.py.
    • /opt/collabnet/teamforge/runtime/scripts/post-install.py
21. Restart TeamForge.
    • teamforge restart

Do this on the EventQ Server (server-02)

22. Upgrade EventQ. See Upgrade EventQ.

Do this on the TeamForge Application Server - server-01

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