Install TeamForge, Database, SCM, and EventQ on Four separate servers

Four-server distributed setup with TeamForge, Database (including Datamart), SCM (Subversion CVS and Git) and EventQ on four separate servers.

Dos and Don'ts

Check this list before installing or upgrading TeamForge.

Four Server Setup

Here's how the services are distributed across four separate RHEL/CentOS 7.4 servers.

Services	TeamForge Application Server (server-01)	EventQ Server (server-02)	Database Server (server-03)	SCM and Git Integration Server (server-04)
ctfcore
mail
search
codesearch
etl
gerrit
gerrit-database
reviewboard
reviewboard-database
reviewboard-adpater
subversion
cvs
binary
binary-database
cliserver
eventq
mongodb
redis
rabbitmq
ctfcore-database
ctfcore-datamart

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

1. Install Red Hat Enterprise Linux/CentOS 7.4 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. Configure your TeamForge installation repository.
   • TeamForge installation repository configuration for sites with internet access
   1. Contact the CollabNet Support and download the TeamForge 17.11 installation repository package to /tmp.
   2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-17.11-0.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.11 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.4 64 bit RPM package: CTF-Disconnected-media-17.11.501-841.rhel7.x86_64.rpm
        Note: In addition to the above CentOS 7.4 64 bit RPM package, you must get the following CentOS 7.4 compatibility RPM, which is required for TeamForge 17.11 disconnected media installation on CentOS 7.4 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.11 on CentOS 7.4.
      • 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
4. Install the following application packages.
   1. TeamForge: To install the TeamForge application packages run the following command:
      • yum install teamforge

Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
...
...
Errno::ENOENT: No such file or directory - git
...
...

5. Install Review Board (note that you should have added the following identifiers to the SERVICES token: reviewboard, revieboard-database, and reviewboard-adapter).
   • yum install CN-reviewboard

   For more information, see Install Review Board on the TeamForge Application Server.

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

6. Install Red Hat Enterprise Linux/CentOS 7.4 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.

7. Check your basic networking setup. See Set up Networking for more information.
8. Configure your TeamForge installation repository.
   • TeamForge installation repository configuration for sites with internet access
   1. Contact the CollabNet Support and download the TeamForge 17.11 installation repository package to /tmp.
   2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-17.11-0.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.11 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.4 64 bit: CTF-Disconnected-media-17.11.501-841.rhel7.x86_64.rpm
        Note: In addition to the above CentOS 7.4 64 bit RPM package, you must get the following CentOS 7.4 compatibility RPM, which is required for TeamForge 17.11 disconnected media installation on CentOS 7.4 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.11 on CentOS 7.4.
      • 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
9. Install the TeamForge database packages.
   • yum install teamforge-database
10. 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 codesearch cliserver binary binary-database 
      reviewboard reviewboard-database reviewboard-adapter

    • server-02:SERVICES=eventq mongodb redis rabbitmq

    • server-03:SERVICES=ctfcore-database ctfcore-datamart

    • server-04:SERVICES=subversion cvs gerrit gerrit-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.

    host:PUBLIC_FQDN Token

    server-01:PUBLIC_FQDN=my.app.domain.com

    server-04:PUBLIC_FQDN=my.scmandgit.domain.com

    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

    • 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?
11. Provision services.
    • teamforge provision
    Note:

    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)

12. Copy the site-options.conf file from the Database Server to the TeamForge Application Server's /opt/collabnet/teamforge/etc/ directory.
13. Provision services.
    • teamforge provision
    Note:

    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 the SCM and Git Integration Server (server-04)

14. Install Red Hat Enterprise Linux/CentOS 7.4 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.

15. Check your basic networking setup. See Set up Networking for more information.
16. Configure your TeamForge installation repository.
    • TeamForge installation repository configuration for sites with internet access
    1. Contact the CollabNet Support and download the TeamForge 17.11 installation repository package to /tmp.
    2. Install the repository package.
       • yum install -y /tmp/collabnet-teamforge-repo-17.11-0.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.11 disconnected installation and save it in /tmp.
       • Red Hat Enterprise Linux/CentOS 7.4 64 bit: CTF-Disconnected-media-17.11.501-841.rhel7.x86_64.rpm
         Note: In addition to the above CentOS 7.4 64 bit RPM package, you must get the following CentOS 7.4 compatibility RPM, which is required for TeamForge 17.11 disconnected media installation on CentOS 7.4 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.11 on CentOS 7.4.
       • 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
17. Install the TeamForge SCM and Git packages.
    • yum install teamforge-scm teamforge-git
18. Copy the site-options.conf file from the Database Server (server-03) to the SCM and Git Integration Server's /opt/collabnet/teamforge/etc/ directory.
19. Provision services.
    • teamforge provision
    Note:

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

    During teamforge provision, the Register SCM integration process fails on sites that use self-signed certificates. Perform these steps in such cases.

    1. Restart JBoss on the TeamForge Application server.
       • teamforge restart -s jboss
    2. Reinitialize TeamForge on the SCM server.
       • teamforge reinitialize

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

20. Install Red Hat Enterprise Linux/CentOS 7.4 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.

21. Check your basic networking setup. See Set up Networking for more information.
22. Configure your TeamForge installation repository.

    TeamForge installation repository configuration for sites with internet access

    1. Contact the CollabNet Support and download the TeamForge 17.11 installation repository package to /tmp.
    2. Install the repository package.
       • yum install -y /tmp/collabnet-teamforge-repo-17.11-0.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.11 disconnected installation and save it in /tmp.
       • Red Hat Enterprise Linux/CentOS 7.4 64 bit: CTF-Disconnected-media-17.11.501-841.rhel7.x86_64.rpm
       • In addition to the above CentOS 7.4 64 bit RPM package, you must get the following CentOS 7.4 compatibility RPM, which is required for TeamForge 17.11 disconnected media installation on CentOS 7.4 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.centos.noarch.rpm package if you are installing TeamForge 17.11 on CentOS 7.4.
       • 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
23. Install the EventQ packages.
    • yum install teamforge-eventq

Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.

24. Copy the site-options.conf file from the Database Server (server-03) to the EventQ Server's /opt/collabnet/teamforge/etc/ directory.
25. Provision services.
    • teamforge provision
    Note:

    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)

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