Install TeamForge, EventQ, Database and Datamart on three separate servers

Three-server distributed setup with TeamForge, EventQ, and Database (including Datamart) services installed on three separate servers.

Dos and Don'ts

Check this list before installing or upgrading TeamForge.

Three Server Setup

Here's how the services are distributed across three separate RHEL/CentOS 7.3 servers.
Services TeamForge Application Server (server-01) EventQ Server (server-02) Database Server (server-03)
ctfcore
   
mail
   
search
   
codesearch
   
etl
   
gerrit
   
gerrit-database    
reviewboard
   
reviewboard-database
 
reviewboard-adapter
   
subversion
   
cvs
   
binary
   
binary-database    
cliserver
   
eventq  
 
mongodb  
 
redis  
 
rabbitmq  
 
ctfcore-database    
ctfcore-datamart    

The TeamForge installer takes care of the database configurations. In this setup, we use a separate port for the reports database. By default, both the site database and the datamart use port 5432, but when heavy traffic is expected, it is a good idea to use a separate port(5632) for datamart.

Do this step by step on TeamForge Application Server (server-01)

  1. Install Red Hat Enterprise Linux/CentOS 7.3 and log on as root.

    The host must be registered with the Red Hat Network if you are using Red Hat Enterprise Linux.

    See the Red Hat installation guide for help.

  2. Check your basic networking setup. See Set up Networking for more information.
  3. If the TeamForge server has SELinux enabled, run it in 'permissive' mode temporarily while installing or upgrading TeamForge.

    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
  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.4 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-17.4-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.4 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.3 64 bit: CTF-Disconnected-media-17.4.770-27.rhel7.x86_64.rpm
      • 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.4 disconnected media installation on CentOS 7.3 profile: compat-ctf-dc-media-1.1-1.el7.noarch.rpm.
    2. Unpack the disconnected installation package.
      • rpm -ivh <package-name>
    3. Unpack the compat-ctf-dc-media-1.1-1.el7.noarch.rpm package if you are installing TeamForge 17.4 on CentOS 7.3.
      • rpm -ivh compat-ctf-dc-media-1.1-1.el7.noarch.rpm
    4. If not mounted already, 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

Do this step by step on Database Server (server-03)

  1. Install Red Hat Enterprise Linux/CentOS 7.3 and log on as root.

    The host must be registered with the Red Hat Network if you are using Red Hat Enterprise Linux.

    See the Red Hat installation guide for help.

  2. Check your basic networking setup. See Set up Networking for more information.
  3. If the TeamForge server has SELinux enabled, run it in 'permissive' mode temporarily while installing or upgrading TeamForge.

    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
  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.4 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-17.4-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.4 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.3 64 bit: CTF-Disconnected-media-17.4.770-27.rhel7.x86_64.rpm
      • 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.4 disconnected media installation on CentOS 7.3 profile: compat-ctf-dc-media-1.1-1.el7.noarch.rpm.
    2. Unpack the disconnected installation package.
      • rpm -ivh <package-name>
    3. Unpack the compat-ctf-dc-media-1.1-1.el7.noarch.rpm package if you are installing TeamForge 17.4 on CentOS 7.3.
      • rpm -ivh compat-ctf-dc-media-1.1-1.el7.noarch.rpm
    4. If not mounted already, 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 database packages.
    • yum install teamforge-database
  6. Set up your site's master configuration file.
    • vi /opt/collabnet/teamforge/etc/site-options.conf

    host: SERVICES Token

    Note: cliserver and reviewboard-adapter are the new services added in TeamForge 17.4.
    • server-01:SERVICES=ctfcore mail etl search subversion cvs codesearch cliserver gerrit 
      binary reviewboard reviewboard-database reviewboard-adapter
    • server-02:SERVICES=eventq mongodb redis rabbitmq
    • server-03:SERVICES=ctfcore-database ctfcore-datamart gerrit-database binary-database
    Note: You may remove the identifiers of components you do not want. For example, remove binary and binary-database if you are not planning to install binary repository managers such as Nexus. See TeamForge services for more information.

    Save the site-options.conf file.

    For further customization of your site configuration:

    SSL Tokens

    SSL is enabled by default and a self-signed certificate is auto-generated. Use the following tokens to adjust this behavior.
    SSL_CERT_FILE=
    SSL_KEY_FILE=
    SSL_CHAIN_FILE=
    • 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.
    • All SSL certificates including self-signed certificates are added automatically.

    Password Tokens

    • TeamForge 7.1 and later support automatic password creation. See AUTO_DATA for more information.
    • If the token REQUIRE_PASSWORD_SECURITY is enabled, then set a value for the token, PASSWORD_CONTROL_EFFECTIVE_DATE.
      Warning: 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.
    • 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__}
    • If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.

    PostgreSQL Tokens and Settings

  7. Deploy services.
    • /opt/collabnet/teamforge/bin/teamforge provision
    Note:

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

    TeamForge 17.4 (and later) installer expects the system locale to be LANG=en_US.UTF-8. TeamForge "provision" command fails otherwise.

Do this step by step on TeamForge Application Server (server-01)

  1. Copy the site-options.conf file from the Database Server (server-03) to the TeamForge Application Server's /opt/collabnet/teamforge/etc/ directory.
  2. Deploy services.
    • /opt/collabnet/teamforge/bin/teamforge provision
    Note:

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

    TeamForge 17.4 (and later) installer expects the system locale to be LANG=en_US.UTF-8. TeamForge "provision" command fails otherwise.

Do this step by step on EventQ server (server-02)

  1. Install Red Hat Enterprise Linux/CentOS 7.3 and log on as root.

    The host must be registered with the Red Hat Network if you are using Red Hat Enterprise Linux.

    See the Red Hat installation guide for help.

  2. Check your basic networking setup. See Set up Networking for more information.
  3. If the TeamForge server has SELinux enabled, run it in 'permissive' mode temporarily while installing or upgrading TeamForge.

    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
  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.4 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-17.4-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.4 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.3 64 bit: CTF-Disconnected-media-17.4.770-27.rhel7.x86_64.rpm
      • 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.4 disconnected media installation on CentOS 7.3 profile: compat-ctf-dc-media-1.1-1.el7.noarch.rpm.
    2. Unpack the disconnected installation package.
      • rpm -ivh <package-name>
    3. Unpack the compat-ctf-dc-media-1.1-1.el7.noarch.rpm package if you are installing TeamForge 17.4 on CentOS 7.3.
      • rpm -ivh compat-ctf-dc-media-1.1-1.el7.noarch.rpm
    4. If not mounted already, 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 EventQ packages.
    • yum install teamforge-eventq
  6. Copy the site-options.conf file from the Database Server (server-03) to the EventQ Server's /opt/collabnet/teamforge/etc/ directory.
  7. Deploy services.
    • /opt/collabnet/teamforge/bin/teamforge provision
    Note:

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

    TeamForge 17.4 (and later) installer expects the system locale to be LANG=en_US.UTF-8. TeamForge "provision" command fails otherwise.

Do this step by step on TeamForge Application Server (server-01)

  1. Run the TeamForge post installation script. For more information, see post-install.py.
    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.
    • /opt/collabnet/teamforge/runtime/scripts/post-install.py
  2. Restart TeamForge.
    • setenforce 1
    • /opt/collabnet/teamforge/bin/teamforge restart
  3. Verify TeamForge installation.
    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.

Post Installation Tasks