Upgrade to TeamForge 17.4 on new hardware

To upgrade to TeamForge 17.4, set up a new hardware, then bring your old site's data and convert it.

Before you begin:

Plan your upgrade

Remember:

TeamForge 17.4 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.4.

In this setup, the following services run on the TeamForge Application Server (we call this server-01).

TeamForge Application Server (ctfcore)
Database Server (ctfcore-database and ctfcore-datamart)
Codesearch Server (codesearch)
Mail Server (mail)
ETL Server (etl)
Git Integration Server (gerrit and gerrit-database)
SCM Integration Server (subversion and cvs)
Search Server (search).
TeamForge EventQ Server (eventq, mongodb, redis and rabbitmq)
TeamForge CLI Server (cliserver)

Do this on the new TeamForge Application Server (ctfcore) - server-01

Install Red Hat Enterprise Linux/CentOS 7.3 and log on as root.
The host must be registered with the Red Hat Network if you are using Red Hat Enterprise Linux.

See the Red Hat installation guide for help.
Check your basic networking setup. See Set up Networking for more information.

Do this on the existing TeamForge Application Server

Back up all your custom event handlers and remove all the event handler JAR files before starting your TeamForge 17.4 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.
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
Stop EventQ.
- /etc/init.d/eventq stop
- /etc/init.d/collabnet-rabbitmq-server stop
- /etc/init.d/collabnet-mongod stop

Backup your site data.

If you are upgrading from TeamForge 16.7 or earlier to TeamForge 17.4:

Back up your site database

mkdir -p /tmp/backup_dir
cd /var/lib
tar -zcvf /tmp/backup_dir/pgsql.tgz pgsql/9.3

Tip: /tmp/backup_dir is just an example. You can use any directory or partition you prefer to store your backup files.

Back up the file system data

Make an archive file with the following data directories:

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

cp -Rpfv /svnroot /sf-svnroot /cvsroot /opt/collabnet/teamforge/var /opt/collabnet/reviewboard /tmp/backup_dir

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

Back up EventQ

cp -Rpfv /opt/collabnet/eventq/config/*.yml /opt/collabnet/mongodb /opt/collabnet/rabbitmq /tmp/backup_dir

Compress your backup data

cd /tmp
tar czvf 167backup.tgz backup_dir

If you are upgrading from TeamForge 16.10 or later to TeamForge 17.4:
- mkdir -p /tmp/backup_dir
- cp -Rpfv /opt/collabnet/teamforge/var /tmp/backup_dir
Tip: /tmp/backup_dir is just an example. You can use any directory or partition you prefer to store your backup files.

If Git integration is enabled
- mkdir /tmp/backup_dir/gerrit
- cp -Rpfv /opt/collabnet/gerrit/ /tmp/backup_dir/gerrit
Back up EventQ
- cp -Rpfv /opt/collabnet/eventq/config/*.yml /opt/collabnet/mongodb /opt/collabnet/rabbitmq /tmp/backup_dir
Compress your backup data
- cd /tmp
- tar czvf 171backup.tgz backup_dir
Back up your SSH keys, if any.
Back up your SSL certificates and keys, if any.

Copy the master configuration file from the this server to the /tmp directory on the new TeamForge server.
- scp /opt/collabnet/teamforge/etc/site-options.conf username@newbox:/tmp
Tip: scp is just an example. You can choose any file transfer method you prefer.
Copy the backed up data to the new TeamForge Application Server.
- scp /tmp/171backup.tgz username@newbox:/tmp or scp /tmp/167backup.tgz username@newbox:/tmp

Do this on the new TeamForge Application Server (server-01)

Unpack the file system data.
- cd /tmp
- tar xzvf 171backup.tgz or tar xzvf 167backup.tgz
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 /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
Upgrade the operating system packages.
- yum upgrade
Reboot the server.
- reboot
Configure your TeamForge installation repository.
- TeamForge installation repository configuration for sites with internet access
1. Contact the CollabNet Support and download the TeamForge 17.4 installation repository package to /tmp.
2. Install the repository package.
  - yum install -y /tmp/collabnet-teamforge-repo-17.4-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.4disconnected installation and save it in /tmp.
  - Red Hat Enterprise Linux/CentOS 7.3 64 bit RPM package: CTF-Disconnected-media-17.4.824-110.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.4 disconnected media installation on CentOS 7.3 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.4 on CentOS 7.3.
  - 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
Install the TeamForge application packages.
- yum install teamforge
Install PostgreSQL 9.3 packages.
- yum install postgresql93-*
Reload site data.
1. If you are upgrading from TeamForge 16.7 or earlier to TeamForge 17.4:
  - cd /opt/collabnet/teamforge/
  - mkdir var
  - cd var
  - tar zvxf /tmp/backup_dir/pgsql.tgz
  - cp -Rpfv /tmp/backup_dir/svnroot /svnroot
  - cp -Rpfv /tmp/backup_dir/cvsroot /cvsroot
  - cp -Rpfv /tmp/backup_dir/sf-svnroot /sf-svnroot
  - cp -Rpfv /tmp/backup_dir/var /opt/collabnet/teamforge/
  If Git integration is enabled
  - cp -Rpfv /tmp/backup_dir/gitroot /gitroot
  - cp -Rpfv /tmp/backup_dir/gerrit/gerrit/etc /opt/collabnet/gerrit
  - cp -Rpf /tmp/backup_dir/gerrit/gerrit/.ssh /opt/collabnet/gerrit
  - cp -Rpf /tmp/backup_dir/gerrit/gerrit/bin /opt/collabnet/gerrit
  - cp -Rpf /tmp/backup_dir/gerrit/gerrit/index /opt/collabnet/gerrit
  EventQ
  - yes | cp -Rf /tmp/backup_dir/*.yml /opt/collabnet/eventq/config/
  - yes | cp -Rf /tmp/backup_dir/mongodb /opt/collabnet
  - yes | cp -Rf /tmp/backup_dir/rabbitmq /opt/collabnet
2. If you are upgrading from TeamForge 16.10 or later to TeamForge 17.4:
  - cp -Rpfv /tmp/backup_dir/var /opt/collabnet/teamforge/
  If Git integration is enabled
  - cp -Rpfv /tmp/backup_dir/gerrit/gerrit/etc /opt/collabnet/gerrit
  - cp -Rpf /tmp/backup_dir/gerrit/gerrit/.ssh /opt/collabnet/gerrit
  - cp -Rpf /tmp/backup_dir/gerrit/gerrit/bin /opt/collabnet/gerrit
  - cp -Rpf /tmp/backup_dir/gerrit/gerrit/index /opt/collabnet/gerrit
  EventQ
  - yes | cp -Rf /tmp/backup_dir*.yml/ /opt/collabnet/eventq/config/
  - yes | cp -Rf /tmp/backup_dir/mongodb /opt/collabnet
  - yes | cp -Rf /tmp/backup_dir/rabbitmq /opt/collabnet
Copy the site-options.conf file to the TeamForge installer directory.
- cp /tmp/site-options.conf /opt/collabnet/teamforge/etc/
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 and domain name tokens.
  Note: cliserver and reviewboard-adapter are the new services added in TeamForge 17.4.
```
server-01:SERVICES = ctfcore ctfcore-database ctfcore-datamart mail etl 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
```
  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.
3. Set the MONGODB_APP_DATABASE_NAME token with EventQ’s database name in the site-options.conf file.
```
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 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. 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.
As you are upgrading on new hardware, contact CollabNet Support, generate the license key for the new server (IP address) and use it to replace /opt/collabnet/teamforge/var/etc/sflicense.txt
Deploy services.
- /opt/collabnet/teamforge/bin/teamforge provision
Note:
The "provision" command prompts for response before it bootstraps or migrates data during TeamForge installation and upgrade respectively. Enter "y" or "N" to proceed. For more information, see the TeamForge script.

TeamForge 17.4 (and later) installer expects the system locale to be LANG=en_US.UTF-8. TeamForge "provision" command fails otherwise.
Run the /var/lib/pgsql/analyze_new_cluster.sh script.
- su - postgres -c "/var/lib/pgsql/analyze_new_cluster.sh"
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
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.
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.