Install TeamForge, SCM and Git integration and EventQ on separate servers

Three-server distributed setup with TeamForge (including Database and Datamart), SCM (Subversion and CVS) and Git, and EventQ services installed on RHEL/CentOS 7.2 servers.

Important: See:
The following table shows the distribution of services on different servers.
App Server: my.app.host SCM and Git Integration Server: my.scmandgit.host
TeamForge Application Server SCM Integration Server (Subversion and CVS)
Database Server (Operational DB and Reports DB) GIT Integration Server
ETL Server  
Search Server (Indexer)  
EventQ Server: my.eventq.host
TeamForge EventQ Server (App, MongoDB and RabbitMQ)
Remember: As Black Duck Code Sight 2.1.3 has no support for RHEL/CentOS 7.2, CollabNet recommends you install Black Duck Code Sight on a separate RHEL/CentOS 6.8 server.
Note: For the ETL service to run as expected in a distributed TeamForge installation, all servers must have the same time zone.
Attention: Installing or upgrading TeamForge needs root privileges. You must log on as root or use a root shell to install or upgrade TeamForge.

Do this on the TeamForge Application Server (my.app.host)

  1. Install Red Hat Enterprise Linux/CentOS 7.2 and log in as root.
    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.
  3. 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.
  4. Configure your TeamForge installation repository.
    • TeamForge installation repository configuration for sites with internet access
    1. Contact the CollabNet Support and download the TeamForge 16.7 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-16.7-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.7 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.2 64 bit RPM package: CTF-Disconnected-media-16.7.879-116.rhel7.x86_64.rpm
        Note: In addition to the above CentOS 7.2 64 bit RPM package, you must get the following CentOS 7.2 compatibility RPM, which is required for TeamForge 16.7 disconnected media installation on CentOS 7.2 profile: compat-ctf-dc-media-1.0-1.el7.centos.noarch.rpm.
    2. Unpack the disconnected installation package.
      • rpm -ivh <package-name>
    3. Unpack the compat-ctf-dc-media-1.0-1.el7.centos.noarch.rpm package if you are installing TeamForge 16.7 on CentOS 7.2.
      • rpm -ivh compat-ctf-dc-media-1.0-1.el7.centos.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
  5. Install the following application packages.
    1. TeamForge: To install the TeamForge application packages run the following command:
      • yum install teamforge
  6. Set up your site's master configuration file.
    • vi /opt/collabnet/teamforge/etc/site-options.conf
    1. Identify the servers and services running on them. 
      HOST_localhost=app database datamart etl indexer
      DOMAIN_localhost=my.app.domain.com
      HOST_my.scmandgit.domain.com=subversion cvs gerrit
    2. Add 'binary' to the HOST_localhost token if you are installing Nexus. 
      HOST_localhost=app database datamart etl indexer binary
    3. Configure the following token if you are installing Black Duck Code Sight. 
      HOST_my.codesight.domain.com=codesearch
    4. Configure the database and datamart settings.
      Note: For more information about configuring variables, see site-options.conf
      DATABASE_TYPE=postgresql
      DATABASE_USERNAME=ctfuser
      DATABASE_NAME=ctfdb
      DATABASE_READ_ONLY_USER=ctfrouser
      REPORTS_DATABASE_USERNAME=ctfrptuser
      REPORTS_DATABASE_NAME=ctfrptdb
      REPORTS_DATABASE_READ_ONLY_USER=ctfrptrouser
      REPORTS_DATABASE_MAX_POOL_SIZE=30
      Note: The database name and username values are arbitrary alphanumeric strings.
    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. 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.
    8. 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.
    9. Include the SCM_DEFAULT_SHARED_SECRET token in the site-options.conf file of the primary TeamForge server and provide it with a value of 16-24 characters.
      Important: Remember to use the same key in the external SCM integration server also.
    10. If the token REQUIRE_RANDOM_ADMIN_PASSWORD is already set to true, then set the token ADMIN_EMAIL with a valid email address. ADMIN_EMAIL=root@{__APPLICATION_HOST__}
    11. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
    12. Make sure that the following tokens have a value if ETL is enabled. 
      SOAP_ANONYMOUS_SHARED_SECRET
      ETL_SOAP_SHARED_SECRET
    13. Configure Black Duck Code Sight tokens if you are installing Black Duck Code Sight. See Black Duck Code Sight site-option tokens.
    14. 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.
    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. Enable the POSTGRES_INTERFACE token in the site-options.conf file if the value of "ifconfig -a" is not eth0/enp0*.
    18. 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>
    19. Configure TeamForge site options to proxy EventQ through TeamForge. For more information, see "EventQ and TeamForge on two separate servers" section in this topic: Proxying EventQ through TeamForge. Also see Proxy settings and ports used by TeamForge EventQ services.
    20. Save the site-options.conf file.
  7. Create the runtime environment.
    • /opt/collabnet/teamforge/installer/install.sh

Do this on the SCM and Git Integration Server (my.scmandgit.host)

  1. Install Red Hat Enterprise Linux/CentOS 7.2 and log in as root.
    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.
  3. 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
  4. Configure your TeamForge installation repository.
    • TeamForge installation repository configuration for sites with internet access
    1. Contact the CollabNet Support and download the TeamForge 16.7 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-16.7-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.7 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.2 64 bit RPM package: CTF-Disconnected-media-16.7.879-116.rhel7.x86_64.rpm
        Note: In addition to the above CentOS 7.2 64 bit RPM package, you must get the following CentOS 7.2 compatibility RPM, which is required for TeamForge 16.7 disconnected media installation on CentOS 7.2 profile: compat-ctf-dc-media-1.0-1.el7.centos.noarch.rpm.
    2. Unpack the disconnected installation package.
      • rpm -ivh <package-name>
    3. Unpack the compat-ctf-dc-media-1.0-1.el7.centos.noarch.rpm package if you are installing TeamForge 16.7 on CentOS 7.2.
      • rpm -ivh compat-ctf-dc-media-1.0-1.el7.centos.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
  5. Install the TeamForge SCM and Git packages.
    • yum install teamforge-scm teamforge-git
  6. Copy the site-options.conf file from the Application Server to the SCM and Git Integration Server's /opt/collabnet/teamforge/etc/ directory.
  7. Modify the host token settings on the site-options.conf file.
    Important: If you choose not to use the Application Server's site-options.conf file, then don't forget to copy the value of 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 database datamart etl indexer
  8. Create the runtime environment.
    • /opt/collabnet/teamforge/installer/install.sh

Do this on the Application Server (my.app.host)

  1. Set up the initial site data (bootstrap).
    • /opt/collabnet/teamforge/installer/bootstrap-data.sh
  2. Start TeamForge.
    • /etc/init.d/collabnet start
  3. Important: If the token REQUIRE_USER_PASSWORD_CHANGE is set to true, login to TeamForge user interface, change the admin password and then run the post-install.py script.
    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?.
  4. 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 the SCM and Git Integration Server (my.scmandgit.host)

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

  1. Run the TeamForge post installation script. For more information, see post-install.py.
    • /opt/collabnet/teamforge/runtime/scripts/post-install.py

Do this on the Application Server (my.app.host)

  1. Restart the collabnet services.
    • /etc/init.d/collabnet restart

Do this on the EventQ server (my.eventq.host)

  1. Install EventQ. See EventQ installation walk-through

Do this on the Application Server (my.app.host)

  1. Apply some finishing touches and make sure everything is running smoothly.
    1. Reboot the server and make sure all services come up automatically at startup.
    2. Log into your site as the administrator. The value of the DOMAIN variable in the site-options.conf file is the URL to log into.
    3. Create a sample project. See Create a TeamForge project.
    4. Write a welcome message to your site's users. See Create a site-wide broadcast.
Parent topic: Install TeamForge 16.7 on RHEL/CentOS
Related concepts
TeamForge installation/upgrade/configuration/administration FAQs
Related information
Fine tune Gerrit performance