Upgrade to TeamForge 8.0 on new hardware - Black Duck Code Sight on a separate server

To upgrade to TeamForge 8.0, set up a new hardware, then bring your old site's data and convert it. As Black Duck Code Sight 2.1.3 has no support for RHEL/CentOS 7.0, you must install Black Duck Code Sight on a separate RHEL/CentOS 6.6 server and move your Black Duck Code Sight data to this server.

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

• TeamForge Application Server
• Database Server (Operational DB and Reports DB)
• ETL Server
• GIT Integration Server
• SCM Integration Server (Subversion and CVS)
• Search Server (Indexer).

Black Duck Code Sight Server runs on a separate RHEL/CentOS 6.6 server (we call this my.codesight.host).

Log on to the server as root user always.

Do the following on the new TeamForge Application Server - my.app.host

1. Install Red Hat Enterprise Linux/CentOS 7.0 or later versions and log in as root.
   • The host must be registered with the Red Hat Network if you are using Red Hat Enterprise Linux. See Platform specification for TeamForge 8.0 for the full platform requirements.
   • See the Red Hat installation guide for help.
   Important: Don't customize your installation. Select only the default packages list.
2. Check your basic networking setup. See Set up networking for your TeamForge server for details.

Do the following on the existing TeamForge application server

3. Stop TeamForge.
   • /etc/init.d/collabnet stop all
4. Migrate your PostgreSQL to the latest version supported by TeamForge 8.0.
   Important: You must have RHEL/CentOS 6.5 or later to run PGTurant. Upgrade the operating system packages (yum upgrade) before running PGTurant on sites running on RHEL/CentOS versions 6.4 or earlier.
   1. Install PGTurant. See Upgrade PostgreSQL using PGTurant for more information.
      Important: If your TeamForge site has no internet access, contact the CollabNet Support, get the pgturant-8.0.0.1-4.noarch.rpm package and unpack the RPM.

      • rpm -ivh pgturant-8.0.0.1-4.noarch.rpm
      • yum install pgturant -y
   2. Upgrade TeamForge PostgreSQL data directory to PostgreSQL 9.3.
      • cd /opt/collabnet/pgturant/bin/
      • ./pgturant -s /var/lib/pgsql/9.2/data -d /var/lib/pgsql/9.3 -u 9.3 -m
5. Start the PostgreSQL service, run the analyze_new_cluster.sh script and stop PostgreSQL.
   • /etc/init.d/postgresql-9.3 start
   • su - postgres -c "/var/lib/pgsql/9.3/analyze_new_cluster.sh"
   • /etc/init.d/postgresql-9.3 stop
6. Click here only if your reporting database is running on a separate port.
7. Back up your site database.
   Tip: /tmp/backup_dir is just an example. You can use any directory or partition you prefer to store your backup files.
   • mkdir -p /tmp/backup_dir
   • cd /var/lib
   • tar -zcvf /tmp/backup_dir/pgsql.tgz pgsql/9.3
8. Back up the file system data.
   Tip: /tmp/backup_dir is just an example. You can use any directory or partition you prefer to store your backup files.
   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)
      /gitroot	GIT source code repositories

      • cp -Rpfv /svnroot /sf-svnroot /cvsroot /opt/collabnet/teamforge/var /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
      Compress your backup data.
      • cd /tmp
      • tar czvf 72backup.tgz backup_dir
   2. Back up your SSH keys, if any.
   3. Back up your SSL certificates and keys, if any.

9. Copy the master configuration file from the old server to the /tmp directory on the new TeamForge and Black Duck Code Sight servers.
   • scp /opt/collabnet/teamforge-installer/7.2.0.x/conf/site-options.conf username@newbox:/tmp
   Note: Replace "x" with the appropriate patch release number if applicable.
   Tip: scp is just an example. You can choose any file transfer method you prefer.
10. Copy the file system data to the new TeamForge and Black Duck Code Sight servers.
    • scp /tmp/72backup.tgz username@newbox:/tmp

Do the following on the new TeamForge Application Server - my.app.host

11. Unpack the file system data.
    • cd /tmp
    • tar xzvf 72backup.tgz
12. 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, run the following command to disable SELinux.
       • setenforce 0
    See Set up SELinux to have TeamForge run in SELinux mode after completing the installation or upgrade.
13. Upgrade the operating system packages.
    • yum upgrade
14. Reboot the server.
    • reboot
15. Disable postfix which is enabled by default on CentOS 7.0 profile.
    • systemctl stop postfix
    • systemctl disable postfix
16. Configure your TeamForge 8.0 installation repository. See TeamForge installation repository configuration for Red Hat/CentOS.
17. Install the following application packages.
    1. TeamForge: To install the TeamForge application packages run the following command:
       • yum install teamforge
    2. GIT: To install the GIT packages run the following command:
       • yum install teamforge-git
18. Reload the PostgreSQL data.
    • cd /var/lib
    • mv pgsql pgsql_orig
    • tar -zxvf /tmp/backup_dir/pgsql.tgz
19. Copy the site-options.conf file to the TeamForge installer directory.
    • cp /tmp/site-options.conf /opt/collabnet/teamforge-installer/8.0.0.1/conf
20. In the site-options.conf file, make sure you do the following.
    Note: Back up your site-options.conf file before making any changes.
    • vi /opt/collabnet/teamforge-installer/8.0.0.1/conf/site-options.conf
    1. Update the host name and domain name, if required.

       HOST_localhost=app database datamart etl indexer subversion cvs

       DOMAIN_localhost=my.app.domain.com

       Add 'gerrit' to the HOST_localhost token if you are installing Git.

       HOST_localhost=app database datamart etl indexer subversion cvs gerrit

       Add 'binary' to the HOST_localhost token if you are installing Nexus.

       HOST_localhost=app database datamart etl indexer subversion cvs gerrit binary

       Configure the following token if you are installing Black Duck Code Sight.

       HOST_my.codesight.domain.com=codesearch

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

       • SSL_CHAIN_FILE

       Note: The SSL_CA_CERT_FILE and SSL_CHAIN_FILE are optional.
    3. If your site is running in SSL mode (SSL=on), add the following java runtime property to the JBOSS_JAVA_OPTS token.

       JBOSS_JAVA_OPTS=-Xms1536m -Xmx1536m -XX:MaxPermSize=512m -server -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/tmp -verbose:gc -XX:+
       PrintGCTimeStamps -XX:+PrintGCDetails -Djsse.enableSNIExtension=false -Dsun.rmi.dgc.client.gcInterval=600000 -Dsun.rmi.dgc.server.gcInterval=600000
       

    4. 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.
    5. TeamForge 7.1 and later support automatic password creation. See AUTO_DATA for more information.
    6. 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.
    7. Ensure to set the token DEDICATED_INSTALL=true.
    8. Include the list of non-expiring TeamForge user accounts (password never expires).

       USERS_WITH_NO_EXPIRY_PASSWORD=admin,nobody,system,scmviewer,scmadmin

    9. Make sure that the following tokens have a value if ETL is enabled.

       SOAP_ANONYMOUS_SHARED_SECRET

       ETL_SOAP_SHARED_SECRET

    10. Configure Black Duck Code Sight tokens. See Black Duck Code Sight site-option tokens.
    11. 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.
    12. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
    13. If you are installing TeamForge through disconnected media, set the token HELP_AVAILABILITY=local.
    14. Ensure to set the token SELINUX_SETUP=false.
    15. 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?
    16. Save the site-options.conf file.
21. Recreate the runtime environment.
    • cd /opt/collabnet/teamforge-installer/8.0.0.1
    • ./install.sh -r -I -V

Do the following on the Black Duck Code Sight server - my.codesight.host.

22. Set up Black Duck Code Sight on RHEL/CentOS 6.6. See Install Black Duck Code Sight on a separate RHEL/CentOS 6.6 server.

Do the following on the new TeamForge Application Server - my.app.host

23. Reload the svnroot, sf-svnroot, cvsroot, gitroot and var directories.
    • 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/var
    If Git integration is enabled, do the following:
    • 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
24. Recreate the runtime environment to set the database credentials.
    • cd /opt/collabnet/teamforge-installer/8.0.0.1
    • ./install.sh -r -I -V
25. 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.
26. Convert your site data to work with TeamForge 8.0.
    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 8.0 site.

27. Start TeamForge.
    • /etc/init.d/collabnet start
28. By default, firewall is enabled on CentOS 7.0 profile and needs to be configured, without which no external access is possible.
    • firewall-cmd --zone=public --add-service=http --permanent
    • firewall-cmd --zone=public --add-service=https --permanent
    • firewall-cmd --reload
29. If you have CVS integrations, synchronize permissions post upgrade. See, Synchronize TeamForge source control integrations.
30. Run the TeamForge post installation script. For more information, see post-install.py.
    • /opt/collabnet/teamforge/runtime/scripts/post-install.py
31. Run the following query to get the repository IDs of the repositories for which the Available in Search Results option was enabled.
    • echo "select sr.id from folder f, project p,scm_repository sr where f.id like 'reps%'and p.is_deleted='f' and p.id=f. project_id and sr.search_enabled='t'and sr.id=f.id and f.is_deleted='f';" | /opt/collabnet/teamforge/runtime/scripts/psql-wrapper -t -A >>/tmp/repository-ids.txt
32. As this is a new hardware upgrade, run the codesightmigration.sh script to have the code search project repository URLs point to the new server.
    Note: Make sure TeamForge and Black Duck Code Sight licenses are installed before running the codesightmigration.sh script.
    • /opt/collabnet/teamforge/runtime/scripts/codesearch/codesightmigration.sh --filename=/tmp/repository-ids.txt

Do the following on the Black Duck Code Sight server - my.codesight.host.

33. 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 new TeamForge Application Server - my.app.host

34. Apply the finishing touches and make sure everything is running smoothly after upgrading to TeamForge 8.0.
    Important: Do not delete the teamforge-installer/8.0.0.1 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.
35. Remove the backup files after the TeamForge site is up and running as expected.
    1. Remove the repository and the file system backup from the /tmp/backup_dir directory.
    2. Remove the PostgreSQL 9.2 database dump and the file system from the /var/lib/pgsql/9.2/backups and /var/lib/pgsql/9.2/data directories respectively.