Upgrade to TeamForge 17.1 - Database and SCM on separate servers

Four server setup with TeamForge, Database (Database and Datamart), SCM and EventQ on separate servers. In this procedure, we'll assume that you are upgrading on the same server where your existing TeamForge 16.10 site is running. The following instructions are valid for both RHEL/CentOS 6.8/7.3 platforms. Specific steps, if applicable only for a particular RHEL/CentOS platform, are called out explicitly.

Before you begin:

Plan your upgrade

Remember:

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)
Code Search Server (codesearch)
Mail Server (mail)
ETL Server (etl)
Search Server (search).

The following service runs on the Database Server (we call this server-03).

Database Server (ctfcore-database and ctfcore-datamart)

The following services run on the SCM and Git Integration Server (we call this server-04).

SCM Integration Server (subversion and cvs)
Git Integration Server (gerrit and gerrit-database)

EventQ runs on a separate EventQ Server (server-02).

TeamForge EventQ Server (App, MongoDB and RabbitMQ)

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

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.
Before you upgrade to TeamForge 17.1, uninstall hotfixes and add-ons, if any.
If you have Review Board installed, uninstall Review Board.
- cd /opt/collabnet/RBInstaller-16.10.4
- python ./install.py -u
Stop the TeamForge CLI add-on.
- service teamforge_cli_server stop
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
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
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
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.
Upgrade the operating system packages.
- yum upgrade
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.
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 6.8 64 bit RPM package: CTF-Disconnected-media-17.1.556-48.rhel6.x86_64.rpm
  - 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.
```
[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
Install the following application packages.
1. To install the TeamForge application packages run the following command:
  - yum install teamforge
  Attention: TeamForge installer is being 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.1 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

Do the following on the Database Server - server-03

Upgrade the operating system packages.
- yum upgrade
If the TeamForge server has SELinux enabled, disable it temporarily while installing or upgrading TeamForge. TeamForge create runtime fails otherwise.
1. Verify if SELinux is running in enforcing mode.
  - getenforce
2. If the output of the getenforce command is either "Disabled" or "Permissive", SELinux is already disabled.
3. If not disabled, run the following command to disable SELinux.
  - setenforce 0
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 6.8 64 bit RPM package: CTF-Disconnected-media-17.1.556-48.rhel6.x86_64.rpm
  - 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.
```
[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
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
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
Install the TeamForge database packages.
- yum install teamforge-database
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 domain name tokens.
```
server-03:SERVICES = ctfcore-database ctfcore-datamart
```
```
server-01:SERVICES = ctfcore mail etl search codesearch
```
```
server-04:SERVICES = subversion cvs gerrit gerrit-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: 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.
  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. 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. Save the site-options.conf file.
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.

Do this on the TeamForge Application Server - server-01

Copy the site-options.conf file from the Database Server to the TeamForge Application Server's /opt/collabnet/teamforge/etc/ directory.
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 domain name tokens.
```
server-01:SERVICES = ctfcore mail etl search codesearch
```
```
server-01:PUBLIC_FQDN = my.app.domain.com
```
```
server-03:SERVICES = ctfcore-database ctfcore-datamart
```
```
server-04:SERVICES = subversion cvs gerrit gerrit-database
```
  Add Binary identifiers if you are installing Nexus.
```
server-01:SERVICES = ctfcore mail etl search codesearch binary binary-database
```
  Add Review Board identifiers if you are installing Review Board.
```
server-01:SERVICES = ctfcore mail etl search codesearch binary binary-database reviewboard reviewboard-database
```
4. 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 Proxy settings and ports used by TeamForge EventQ services.
5. Save the site-options.conf file.
Deploy services.
1. Move all backup files and folders including the error folder to /tmp.
  Note: This step is required to make sure that there are no backup files and folders present in /opt/collabnet/teamforge/var/james/var/mail/ to avoid any delay during provisioning.
  - cd /opt/collabnet/teamforge/var/james/var/mail/
  - mv * /tmp
2. Run the TeamForge provision command.
  - /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.
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.
If you have CVS integrations, synchronize permissions post upgrade. See, Synchronize TeamForge source control integrations.
Run the TeamForge post installation script. For more information, see post-install.py.
- /opt/collabnet/teamforge/runtime/scripts/post-install.py

Do the following on the SCM and Git Integration Server - server-04

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
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
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.
Upgrade the operating system packages.
- yum upgrade
If the TeamForge server has SELinux enabled, disable it temporarily while installing or upgrading TeamForge. TeamForge create runtime fails otherwise.
1. Verify if SELinux is running in enforcing mode.
  - getenforce
2. If the output of the getenforce command is either "Disabled" or "Permissive", SELinux is already disabled.
3. If not disabled, run the following command to disable SELinux.
  - setenforce 0
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 6.8 64 bit RPM package: CTF-Disconnected-media-17.1.556-48.rhel6.x86_64.rpm
  - 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.
```
[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
Install the following application packages.
1. Install the source code component.
  - yum install teamforge-scm
2. To install the Git packages, run the following command.
  - yum install teamforge-git

Copy the master site-options.conf file from server-01 and configure the services and domain name tokens.

server-04:SERVICES = subversion cvs gerrit gerrit-database

server-04:PUBLIC_FQDN = my.scmandgit.domain.com

server-01:SERVICES = ctfcore mail etl search codesearch binary binary-database reviewboard reviewboard-database

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

Save the site-options.conffile.
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.
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.

Do this on the EventQ Server (server-02)

Upgrade EventQ. See Upgrade EventQ.

Do this on the TeamForge Application Server - server-01

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.

Do this on the Database Server - server-03

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.

TeamForge Avatar display issue on RHEL/CentOS 6.8

TeamForge Avatar image is not displayed properly post Review Board installation on RHEL/CentOS 6.8. Run the following commands to work around this issue:

yum erase python-imaging
yum install teamforge
service httpd restart

Note: After upgrade, it takes some time for the publishing repositories to get created for projects imported from other TeamForge sites.

EventQ: Run the add_eventq_to_projects.py script to add Eventq to existing projects.
ETL initial load jobs: To run ETL initial load jobs, see ETL initial load jobs.
Review Board: To upgrade Review Board, see Upgrade Review Board.
SELinux: To run TeamForge in SELinux enabled mode, see Set up SELinux.
Configure X-Frame-Options: Setting the X-Frame-Options header to ALLOW-FROM http://forge.collab.net overrides the default Jenkins configuration header settings and displays the page in an iframe on the specified origin. For more information, see Unable to embed Jenkins page into an iframe. How to fix it?.
Caching with Memcached: Install Memcached