Install, Upgrade and Site Administration

Install/Upgrade best practices

  • Start with understanding the TeamForge installation requirements and EventQ installation requirements.
  • Go through the TeamForge 17.1 release notes and know more about the TeamForge version you are about to install or upgrade.
  • Set up a TeamForge Stage Server before you upgrade your Production Server.
  • Plan your installation or upgrade. See Plan your installation | Plan your upgrade
  • Stop TeamForge services on all servers in a distributed setup while upgrading to TeamForge 17.1.
  • 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.
  • Installing or upgrading TeamForge needs root privileges. You must log on as root or use a root shell to install or upgrade TeamForge.
  • Do not customize your operating system installation. Select only the default packages list.
  • Verify your basic networking setup before installing or upgrading TeamForge. See Set up networking for your TeamForge server.
  • Generate SSL certificates, if required, and keep them handy. See Generate SSL certificates.
  • If you have SELinux in "enforcing" mode, switch SELinux to "Permissive" mode before running the /opt/collabnet/teamforge/bin/teamforge provision command. TeamForge create runtime fails otherwise.
  • Look for new or modified site-options.conf tokens and update your site-options.conf file as required during the upgrade process. See Site options change log.
  • Do not manually modify TeamForge-managed site option tokens such as the AUTO_DATA token. See AUTO_DATA for more information.
  • 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 database and file system.
  • Always use compatible JDBC drivers meant for specific database versions. See JDBC Drivers Reference for more information. Also see: Why do ETL jobs fail post TeamForge upgrade?
  • Before you upgrade to TeamForge 17.1, uninstall hotfixes and add-ons, if any.
  • Before deploying services, make sure that there are no backup files and folders including the error folder present in /opt/collabnet/teamforge/var/james/var/mail/ to avoid any delay during provisioning.
  • You can run the initial load job any time after the site is upgraded to TeamForge 17.1. We recommend that you run it before you hand over the site to the users. For more information, see When do I run the initial load job?

Install TeamForge

Before you begin

TeamForge installation requirements | EventQ installation requirements
How many servers are required to run TeamForge?
How do TeamForge licenses work?
Plan your installation | Set up networking | Open ports
Installation FAQs

Single-server setup

All services on a single: RHEL/CentOS 7.3 server | RHEL/CentOS 6.8 server

Three-server setup

Refer to the following topics if you plan to install TeamForge 17.1 on a three-server distributed setup.

RHEL/CentOS 7.3
Install TeamForge 17.1 and EventQ on two separate servers and:
Database and Datamart on a separate server
Reporting services on a separate server
Black Duck Code Sight on a separate server
SCM and Git on a separate server
Oracle database on a separate server
Git on a separate server

Four-server setup

Refer to the following topic if you plan to install TeamForge 17.1 on a four-server distributed setup.

Install TeamForge 17.1 on a server and EventQ, Database and SCM on separate servers

Post installation

Supply license key: From TeamForge user interface | As a text file
Verify your TeamForge 17.1 installation
Maintain your site

Upgrade TeamForge

Before you begin

TeamForge installation requirements | EventQ installation requirements
How many servers are required to run TeamForge? | Should I upgrade to TeamForge 17.1 on a new server?
Plan your upgrade
Upgrade FAQs

Single-server setup

You may choose to upgrade on the same hardware or new hardware. Refer to the topic that suits your needs.

Upgrade on same hardware Upgrade on new hardware
From 16.10 to 17.1 on: RHEL/CentOS 6.8/7.3 server From 16.10 to 17.1 on: RHEL/CentOS 7.3 server
From 7.2 to 17.1 on RHEL/CentOS  

Three-server setup

Refer to the following topics if you have TeamForge 16.10 running on a three-server distributed setup and are planning to upgrade to TeamForge 17.1 on the same hardware.

RHEL/CentOS 6.8/7.3
Upgrade TeamForge and EventQ running on two separate servers and:
Database and datamart on a separate server
Reporting services on a separate server
Black Duck Code Sight on a separate server
Git on a separate server
Oracle database on a separate server

Four-server setup

Refer to the following topics if you have TeamForge 16.10 running on a four-server distributed setup and are planning to upgrade to TeamForge 17.1 on the same hardware.

RHEL/CentOS 6.8/7.3
Upgrade TeamForge, EventQ, Database and SCM on four separate servers