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

In this procedure, we'll assume that you are upgrading on the same server where your existing TeamForge site is running on 7.2. It is possible to simultaneously upgrade and move your site to a new hardware. However, since we are working with a dedicated installation, the priority here is to keep things as simple and quick as possible.

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

1. Stop TeamForge.
   • /etc/init.d/collabnet stop
2. 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.
   1. Create a /backups directory in /var/lib/pgsql/ and change ownership to postgres.
      • cd /var/lib/pgsql/
      • mkdir backups
      • chown -R postgres:postgres backups
   2. Make a dump file of your site database. You have to do a PostgreSQL dump because we are upgrading the PostgreSQL application as part of this upgrade.
      • su - postgres
      • /usr/bin/pg_dumpall > /var/lib/pgsql/backups/teamforge_data_backup.dmp
      • exit
      If your reporting database is running on a separate port, backup your reporting database as well.
      • /usr/bin/pg_dumpall -p <reports_database_port> > /var/lib/pgsql/backups/teamforge_reporting_data_backup.dmp
      • exit
      Copy the database backup to the backup directory.
      • mkdir -p /tmp/backup_dir
      • cp /var/lib/pgsql/backups/teamforge_data_backup.dmp /tmp/backup_dir/
      If your reporting database is running on a separate port, copy your reporting database dump as well.
      • cp /var/lib/pgsql/backups/teamforge_reporting_data_backup.dmp /tmp/backup_dir/
3. 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)
      /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
   2. Back up your SSH keys, if any.
   3. Back up your SSL certificates and keys, if any.
4. Move the collabnet repository of the older version of TeamForge.
   • mv /etc/zypp/repos.d/collabnet-7.2.0.x.repo /etc/zypp/repos.d/collabnet-7.2.0.x.repo.cn_backup
   Note: Replace "x" with the appropriate patch release number if applicable.
5. Configure your TeamForge 8.0 installation repository. See TeamForge installation repository configuration for SUSE.
6. If the PostgreSQL database is running locally, stop the PostgreSQL service.
   • /etc/init.d/postgresql stop
7. Uninstall the TeamForge CLI add-on.
   • cd /opt/collabnet/teamforge/add-ons/teamforge_cli_server
   • ./install --uninstall
   • zypper remove teamforge_cli_server
8. Uninstall the PostgreSQL RPMs.
   Note: When prompted, you must select the option to remove all the dependent packages.
   • zypper remove postgresql-libs postgresql-docs postgresql-server postgresql
9. Install the following application packages.
   1. TeamForge: To install the TeamForge application packages run the following command:
      
      • zypper install teamforge
   2. GIT: To install the GIT packages run the following command:
      • zypper install teamforge-git
10. 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

       HOST_my.codesight.host=codesearch

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

       HOST_localhost=app database datamart etl indexer subversion cvs gerrit

    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. Save the site-options.conf file.
11. Recreate the runtime environment.
    • cd /opt/collabnet/teamforge-installer/8.0.0.1
    • ./install.sh -r -I -V
12. Restore your site data.
    1. Reload the PostgreSQL data.
       • su - postgres
       • /usr/bin/psql < /tmp/backup_dir/teamforge_data_backup.dmp
       • exit
       Note: If your reporting database is running on a separate port, restore that data too.
       • su - postgres
       • /usr/bin/psql -p <reports_database_port> < /tmp/backup_dir/teamforge_reporting_data_backup.dmp
       • exit
13. Recreate the runtime environment to set the database credentials.
    • cd /opt/collabnet/teamforge-installer/8.0.0.1
    • ./install.sh -r -I -V
14. 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 this on the my.codesight.host

15. Configure your TeamForge 8.0 installation repository. See TeamForge installation repository configuration for SUSE.
16. Stop the Black Duck Code Sight service.
    • /etc/init.d/collabnet stop tomcatcs
17. Install Black Duck Code Sight.
    • zypper install teamforge-codesearch
18. Copy the master 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_localhost=codesearch

       DOMAIN_localhost=my.codesight.domain.com

       Host_my.app.host=app database datamart etl indexer subversion cvs

    2. Save the site-options.conf file.
19. Recreate the runtime environment.
    • cd /opt/collabnet/teamforge-installer/8.0.0.1
    • ./install.sh -r -I -V
20. Start the Black Duck Code Sight service.
    • /etc/init.d/collabnet start tomcatcs
21. To install the license for Black Duck Code Sight follow these instructions.

Do this on my.app.host

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

23. Start TeamForge.
    • /etc/init.d/collabnet start
24. If you have CVS integrations, synchronize permissions post upgrade. See, Synchronize TeamForge source control integrations.
25. Run the TeamForge post installation script. For more information, see post-install.py.
    • /opt/collabnet/teamforge/runtime/scripts/post-install.py

Do this on my.codesight.host

26. Run the TeamForge post installation script. For more information, see post-install.py.
    • /opt/collabnet/teamforge/runtime/scripts/post-install.py
27. 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 this on my.app.host

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