Install TeamForge, Code Search and EventQ on separate servers

Three-server distributed setup with TeamForge (including operational database and datamart), Code Search and EventQ services installed on RHEL/CentOS 7.3 servers.

Before you begin:

Remember:

  • TeamForge 17.1 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.
The following table shows the distribution of services on different servers.
App Server: server-01 (RHEL/CentOS 7.3) Code Search: server-03 (RHEL/CentOS 7.3)
TeamForge Application Server (ctfcore) Code Search Server (codesearch)
Mail Server (mail)  
Database Server (ctfcore-database and ctfcore-datamart)  
Git Integration Server (gerrit and gerrit-database)  
SCM Integration Server (subversion and cvs)  
ETL Server (etl)  
Search Server (search)  
EventQ Server: server-02 (RHEL/CentOS 7.3)
TeamForge EventQ Server (App, MongoDB and RabbitMQ)

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

  1. Install Red Hat Enterprise Linux/CentOS 7.3 and log in as root.
  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.
    Important: 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
    See Set up SELinux to have TeamForge run in SELinux enforcing 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 17.1 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-17.1-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.1 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.3 64 bit RPM package: CTF-Disconnected-media-17.1.556-48.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.1 disconnected media installation on CentOS 7.3 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 17.1 on CentOS 7.3.
      • 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 application packages.
    • yum install teamforge
  6. Set up your site's master configuration file.
    • vi /opt/collabnet/teamforge/etc/site-options.conf
    1. Configure the services and domain name tokens. 
      server-01:SERVICES = ctfcore ctfcore-database mail etl ctfcore-datamart search subversion cvs codesearch
      server-01:PUBLIC_FQDN = my.app.domain.com
      server-03:SERVICES = codesearch
    2. Add Gerrit identifiers if you are installing Git. 
      server-01:SERVICES = ctfcore ctfcore-database mail etl ctfcore-datamart search subversion cvs 
codesearch gerrit gerrit-database
    3. Add Binary identifiers if you are installing Nexus. 
      server-01:SERVICES = ctfcore ctfcore-database mail etl ctfcore-datamart search subversion cvs 
codesearch gerrit gerrit-database binary binary-database
    4. Add Review Board identifiers if you are installing Review Board. 
      server-01:SERVICES = ctfcore ctfcore-database mail etl ctfcore-datamart search subversion cvs 
codesearch gerrit gerrit-database binary binary-database reviewboard reviewboard-database
    5. 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: You need to add the SSL certificate to the Java keystore if the site uses a self-signed certificate. For instructions on adding the self-signed certificate to the Java keystore, see Protect integrations with SSL.
    6. 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=40
      Note: The database name and username values are arbitrary alphanumeric strings.
    7. TeamForge 7.1 and later support automatic password creation. See AUTO_DATA for more information.
    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. 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__}
    10. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
    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. 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?
    13. Enable the POSTGRES_INTERFACE token in the site-options.conf file if the value of "ifconfig -a" is not eth0/enp0*.
    14. 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.
    15. Save the site-options.conf file.
  7. Deploy services.
    • /opt/collabnet/teamforge/bin/teamforge provision

    The "provision" command prompts for response before it bootstraps or migrates data during TeamForge installation and upgrade respectively. Enter "Yes" or "No" to proceed. For more information, see The teamforge script.

Do this on the Code Search Server (server-03)

  1. Install Red Hat Enterprise Linux/CentOS 7.3 and log in as root.
  2. If the TeamForge server has SELinux enabled, disable it temporarily while installing or upgrading TeamForge. TeamForge create runtime fails otherwise.
    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
  3. Configure your TeamForge installation repository.
    • TeamForge installation repository configuration for sites with internet access
    1. Contact the CollabNet Support and download the TeamForge 17.1 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-17.1-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.1 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 6.8 64 bit RPM package: CTF-Disconnected-media-17.1.556-48.rhel6.x86_64.rpm
    2. Unpack the disconnected installation package.
      • rpm -ivh <package-name>
    3. 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.

    4. 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
    5. Verify your yum configuration files.
      • yum list httpd
      • yum list apr
  4. Run the following command to install the Code Search packages.
    • yum install teamforge-codesearch
  5. Copy the site-options.conf file from the TeamForge Application Server to the Code Search Server's /opt/collabnet/teamforge/etc/ directory.
  6. Configure the services and domain name tokens. 
    server-03:SERVICES = codesearch
    server-01:SERVICES = ctfcore ctfcore-database mail etl ctfcore-datamart search subversion cvs gerrit gerrit-database binary binary-database reviewboard reviewboard-database
  7. Deploy services.
    • /opt/collabnet/teamforge/bin/teamforge provision

    The "provision" command prompts for response before it bootstraps or migrates data during TeamForge installation and upgrade respectively. Enter "Yes" or "No" to proceed. For more information, see The teamforge script.

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

  1. Restart TeamForge.
    • setenforce 1
    • /opt/collabnet/teamforge/bin/teamforge restart
  2. 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

Do this on the EventQ server (server-02)

  1. Install EventQ. See EventQ installation walk-through

Do this on the Application Server (server-01)

  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 on to the TeamForge web application using the default Admin credentials.
      • Username: "admin"
      • Password: "admin"
    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
Related concepts
TeamForge installation/upgrade/configuration/administration FAQs
Related tasks
Set up SSL for your TeamForge site