Upgrade to TeamForge 16.3 - Database and SCM on separate servers

In this procedure, we'll assume that you are upgrading on the same server where your existing TeamForge 8.2 site is running.

Important: See Plan your upgrade and Software requirements for CollabNet TeamForge 16.3 before you proceed.

Important: TeamForge 16.3 supports RHEL/CentOS 7.2. However, it also supports RHEL/CentOS 6.7 if you choose to upgrade on the same server that runs RHEL/CentOS 6.7.

In this option, the following services run on the application server (we call this my.app.host).

TeamForge Application Server
Black Duck Code Sight Server
ETL Server
Search Server (Indexer).

The following service runs on the database server (we call this my.db.host).

Database Server (Operational DB and Reports DB)

The following services run of the SCM server (we call this my.scmandgit.host).

SCM Integration Server (Subversion and CVS)
GIT Integration Server

Note: For the ETL service to run as expected in a distributed TeamForge installation, all servers must have the same time zone.

Log on to the server as root user always.

Do the following on the application server - my.app.host

Uninstall the TeamForge CLI add-on.
Important: You must have no tasks in progress while uninstalling the CLI add-ons.
- cd /opt/collabnet/teamforge/add-ons/teamforge_cli_server
- custom-install --uninstall
- yum erase teamforge_cli_server
Stop TeamForge.
- /etc/init.d/collabnet stop all
No backup is required for same hardware upgrades. However, you can create a backup as a precaution. See Back up and restore CollabNet TeamForge data to learn more about backing up TeamForge database and file system.
Upgrade the operating system packages.
- yum upgrade
Create a file, /etc/security/limits.d/teamforge.conf, and make sure it has the following "nproc" and "nofile" settings.
- vim /etc/security/limits.d/teamforge.conf
- sf-admin soft nproc 10240
- sf-admin hard nproc 10240
- sf-admin hard nofile 65536
- sf-admin soft nofile 65536
- Save the file and reboot the server.
If the TeamForge server has SELinux enabled, run it in 'Permissive' mode temporarily while installing or upgrading TeamForge.
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 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 16.3 installation repository package to /tmp.
2. Install the repository package.
  - yum install -y /tmp/collabnet-teamforge-repo-16.3-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 16.3 disconnected installation and save it in /tmp.
  - Red Hat Enterprise Linux/CentOS 6.7 64 bit RPM package: CTF-Disconnected-media-16.3.924-7294.rhel6.x86_64.rpm
2. Unpack the disconnected installation package.
  - rpm -Uvh <package-name>
3. 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.
4. 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
```
5. Verify your yum configuration files.
  - yum list httpd
  - yum list apr
6. Download the code search installation package, CodeSearch-installer-2.1.3-1.noarch.rpm from https://ctf.open.collab.net/sf/go/rel4193 and save it in the /tmp directory. To install the Black Duck Code Sight installer, run the following command.
  - cd /tmp
  - rpm -ivh CodeSearch-installer-2.1.3-1.noarch.rpm
Install the following application packages.
1. TeamForge: 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 to TeamForge 16.3 on the same hardware (when you run the yum install teamforge command). You can safely ignore such warning messages and proceed with the upgrade.
  
  Tip: If you have Black Duck Code Sight already, it is automatically upgraded when you run yum install teamforge. In such case, you can skip the following sub-step.
2. Black Duck Code Sight: To install the Black Duck Code Sight packages run the following command:
  - yum install teamforge-codesearch
Set up your site's master configuration file.
Always use the site-options-dedicated.conf file that's packaged with the TeamForge version you are upgrading to. Refer to the TeamForge 8.2 site-options.conf file, understand your site settings and set up your TeamForge 16.3 site-options.conf file.
CAUTION:
You run the risk of missing out on newly added site option tokens if you keep reusing your site-options.conf file from an older TeamForge version on newer versions. See Site options change log for more information.
1. Back up your existing site-options.conf as site-options-old.conf.
  - cd /opt/collabnet/teamforge-installer/16.3/
  - mv conf/site-options.conf conf/site-options-old.conf
2. Copy the /opt/collabnet/teamforge-installer/16.3/conf/site-options-dedicated.conf file to the TeamForge installer directory.
  - cd /opt/collabnet/teamforge-installer/16.3/
  - cp conf/site-options-dedicated.conf conf/site-options.conf
3. Set up your site options: In addition to the new site options you may set up for TeamForge 16.3, refer to the TeamForge 8.2's site-options-old.conf file and make sure that the TeamForge 16.3 site-options.conf file inherits all the required site options.
  - sudo vi /opt/collabnet/teamforge-installer/16.3/conf/site-options.conf
4. Update the host name and domain name, if required.
```
HOST_localhost=app etl indexer
```
```
HOST_my.db.domain.com=database datamart 
```
```
HOST_my.scmandgit.domain.com=subversion cvs gerrit
```
```
DOMAIN_localhost=my.app.domain.com
```
  Add 'codesearch' to the HOST_localhost token if you are installing Black Duck Code Sight.
```
HOST_localhost=app etl indexer codesearch
```
  Add 'binary' to the HOST_localhost token if you are installing Nexus.
```
HOST_localhost=app etl indexer codesearch binary
```
5. Turn on the SSL for your site by editing the relevant variables in the site-options.conf file. To generate the SSL certificates, see Generate SSL certificates.
```
SSL=on
```
```
SSL_CERT_FILE
```
```
SSL_KEY_FILE
```
```
SSL_CHAIN_FILE
```
  Note: The SSL_CERT_FILE and SSL_KEY_FILE tokens need an absolute path. The SSL_CHAIN_FILE token is optional.
6. 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.
7. TeamForge 7.1 and later support automatic password creation. See AUTO_DATA for more information.
8. Password obfuscation: The password obfuscation is enabled by default. As a result, all password-related tokens are encrypted in all the TeamForge configuration files.
  Restriction: The password-related tokens cannot contain the following characters in the site-options.conf file: $<>/\'"`
  - To disable password obfuscation, set OBFUSCATION_ENABLED=false.
  - To configure the obfuscation key, set OBFUSCATION_KEY=<Any AlphaNumeric value with length >= 8 bytes>. The default value of OBFUSCATION_KEY token is XSJt43wN.
9. Ensure to set the token DEDICATED_INSTALL=true.
10. Include the list of non-expiring TeamForge user accounts (password never expires).
```
USERS_WITH_NO_EXPIRY_PASSWORD=admin,nobody,system,scmviewer,scmadmin
```
11. Make sure that the following tokens have a value if ETL is enabled.
```
SOAP_ANONYMOUS_SHARED_SECRET
```
```
ETL_SOAP_SHARED_SECRET
```
12. Configure the Black Duck Code Sight tokens. See Black Duck Code Sight site-option tokens.
13. 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.
14. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
15. Ensure to set the token SELINUX_SETUP=true.
16. 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?
17. If the first interface of "ifconfig -a" is not eth0/enp0*, set the POSTGRES_INTERFACE token in the site-options.conf file with the NIC name that PostgreSQL should listen to, without which you cannot successfully create runtime.
18. 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.
19. Important: This step is required if you want Git notification emails.
  Update the JAMES_ACCEPTED_RELAYS site-options token with the Git server's IP address. See JAMES_ACCEPTED_RELAYS for more information.
```
JAMES_ACCEPTED_RELAYS=127.0.0.1,{__CEE_DOMAIN__},<The IP address of the Git server>
```
20. Save the site-options.conf file.
Recreate the runtime environment.
- cd /opt/collabnet/teamforge-installer/16.3
- ./install.sh -r -I -V
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 for sites with a lot of data.

Do the following on the database server - my.db.host

Run the following commands to upgrade Red Hat/CentOS to the latest version.
1. Remove the neon-devel package if you are upgrading from TeamForge 6.2.
  - yum erase neon-devel -y
  - yum erase subversion-devel -y
2. Upgrade the operating system packages.
  - yum upgrade
If the TeamForge server has SELinux enabled, disable it temporarily while installing or upgrading TeamForge.
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 16.3 installation repository package to /tmp.
2. Install the repository package.
  - yum install -y /tmp/collabnet-teamforge-repo-16.3-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 16.3 disconnected installation and save it in /tmp.
  - Red Hat Enterprise Linux/CentOS 6.7 64 bit RPM package: CTF-Disconnected-media-16.3.924-7294.rhel6.x86_64.rpm
2. Unpack the disconnected installation package.
  - rpm -Uvh <package-name>
3. 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.
4. 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
```
5. Verify your yum configuration files.
  - yum list httpd
  - yum list apr
If the PostgreSQL database is running locally, stop the PostgreSQL service.
- /etc/init.d/postgresql-9.3 stop
Install the TeamForge database packages.
- yum install teamforge-database
Copy the site-options.conf file from my.app.host and modify the token settings.
Note: If you choose to use the old site-options.conf file, don’t forget to copy the AUTO_DATA token from the application server.
1. Set the following tokens.
```
HOST_my.db.host=database datamart
```
  Note: 'HOST_my.db.host' is just an example. As you are installing database on a separate server, do not use 'HOST_localhost'. Use 'HOST_<valid host name>' instead.
```
DOMAIN_my.db.host=my.db.domain.com
```
```
HOST_my.app.domain.com=app etl indexer
```
```
HOST_my.scmandgit.domain.com=subversion cvs gerrit
```
2. If the first interface of "ifconfig -a" is not eth0/enp0*, set the POSTGRES_INTERFACE token in the site-options.conf file with the NIC name that PostgreSQL should listen to, without which you cannot successfully create runtime.
3. Save the site-options.conf file.
Recreate the runtime environment.
- cd /opt/collabnet/teamforge-installer/16.3
- ./install.sh -r -I -V

Do this on the application server - my.app.host

Convert your site data to work with TeamForge 16.3.
Tip: Before you kick off the data migration, do the following:
- Use the /etc/init.d/collabnet status command to make sure the JBoss, Tomcat and Tomcatcs services are stopped.
- If any of the trackers in your project already contains a field with the name team, conflict may arise while running the migrate.py script. This is because of the inclusion of the Team feature in TeamForge 8.0. To prevent this conflict, follow the steps given in FAQ on troubleshooting.
- /opt/collabnet/teamforge/runtime/scripts/migrate.py
The migrate.py script locates the existing site data and modifies it as needed.
This includes configuration data for LDAP and the James mail server. Any modifications that you have applied to these components on your old site are reproduced on your upgraded TeamForge 16.3 site.
Start TeamForge.
- /etc/init.d/collabnet start
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
Note: In case you face any GIT-related issues while running the post-install.py script, see Post install fails for GIT. What should I do?.
Install the Black Duck Code Sight license on the server where Black Duck Code Sight is installed. For more information see these instructions.
Run the svn_cache.sh script.
- cd /opt/collabnet/teamforge/runtime/scripts/codesearch/
- ./svn_cache.sh <Repository Base URL Path of the SCM Integration Server>
Provide a repository base URL path of the SCM integration server, for example, "http://myint.box.net/svn/repos", where myint.box is the server with the SCM integration server.

In addition, if you add a new integration server at some point later, you must run this svn_cache.sh script, (after creating the new integration server), on the TeamForge application server.

Do the following on the SCM server - my.scmandgit.host

If your TeamForge setup includes source control running on its own server, you'll have to upgrade that server as well as the main TeamForge application server.

Stop TeamForge.
- /etc/init.d/httpd stop
- /etc/init.d/collabnet stop tomcat
No backup is required for same hardware upgrades. However, you can create a backup as a precaution. See Back up and restore CollabNet TeamForge data to learn more about backing up TeamForge database and file system.
Run the following commands to upgrade Red Hat/CentOS to the latest version.
1. Remove the neon-devel package if you are upgrading from TeamForge 6.2.
  - yum erase neon-devel -y
  - yum erase subversion-devel -y
2. Upgrade the operating system packages.
  - yum upgrade
If the TeamForge server has SELinux enabled, disable it temporarily while installing or upgrading TeamForge.
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 16.3 installation repository package to /tmp.
2. Install the repository package.
  - yum install -y /tmp/collabnet-teamforge-repo-16.3-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 16.3 disconnected installation and save it in /tmp.
  - Red Hat Enterprise Linux/CentOS 6.7 64 bit RPM package: CTF-Disconnected-media-16.3.924-7294.rhel6.x86_64.rpm
2. Unpack the disconnected installation package.
  - rpm -Uvh <package-name>
3. 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.
4. 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
```
5. Verify your yum configuration files.
  - yum list httpd
  - yum list apr
If Git is enabled and the PostgreSQL database is running locally:
1. Stop the PostgreSQL service.
  - /etc/init.d/postgresql-9.2 stop
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 my.app.host and modify the host token settings in the site-options.conf file.
Note: If you choose to use the old site-options.conf file, don’t forget to copy the AUTO_DATA token from the application server.
```
HOST_my.scmandgit.host=subversion cvs gerrit
```
```
DOMAIN_my.scmandgit.host=my.scmandgit.domain.com
```
```
HOST_my.app.domain.com=app etl indexer codesearch
```
```
HOST_my.db.domain.com=database datamart
```
Save the site-options.conffile.
Recreate the runtime environment.
- cd /opt/collabnet/teamforge-installer/16.3
- ./install.sh -r -I -V
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 for sites with a lot of data.
Start TeamForge.
- /etc/init.d/collabnet start

Note: Gerrit is configured as part of the post installation tasks included in the post-install.py script. As a result, Gerrit's status would be Not configured during startup, which you can safely ignore.

Run the TeamForge post installation script. For more information, see post-install.py.
- /opt/collabnet/teamforge/runtime/scripts/post-install.py
Note: In case you face any GIT-related issues while running the post-install.py script, see Post install fails for GIT. What should I do?.
Important: This step is required if you want Git notification emails.
Edit the /opt/collabnet/gerrit/etc/gerrit.config file and update the 'smtpServer' property with the TeamForge application server's host name. For example:
```
[sendemail]
              smtpServer = <TeamForge application server host name>
```
1. Restart gerrit.
  - /etc/init.d/collabnet stop gerrit
  - /etc/init.d/collabnet start gerrit

Do this on the application server - my.app.host

Apply the finishing touches and make sure everything is running smoothly after upgrading to TeamForge 16.3.
Important: Do not delete the teamforge-installer/16.3 directory. You will need it for future maintenance and upgrades.
1. Log into your site as the administrator.
2. If your site has custom branding, verify that your branding changes still work as intended. See Customize anything on your site.
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 - my.db.host

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

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

yum erase python-imaging
yum install teamforge
/etc/init.d/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_orchestrate_to_projects.py script to add Orchestrate 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.
Orchestrate: To install TeamForge Orchestrate, see TeamForge Orchestrate installation and Proxy upgrade overview.
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?.
Internal code browser: To turn on TeamForge code browser for a Subversion or Git repository, see Internal code browser.
Caching with Memcached: Install Memcached