Install TeamForge 8.1: Database and SCM on separate servers

In this option, we install the Database (Operational Database) and Datamart (Reporting Database) on the same server; SCM (Subversion and CVS) and Git on the second server, and other services on the application server. If you want Black Duck Code Sight, you must install it on a separate RHEL/CentOS 6.6 server.

Important: See Plan your installation and Software requirements for CollabNet TeamForge 8.1 before you proceed.
In this option, the following services run on the application server (we call this my.app.host). The following service runs on the database server. (We call this my.db.host)
The following services run on the SCM server. (We call this my.scmandgit.host)
  • SCM Integration Server (Subversion and CVS)
  • GIT Integration Server
Note: For the ETL service to run as expected in a distributed TeamForge installation, all servers must have the same time zone.

Log on to the server as root user always.

Do this on the main TeamForge application server. We'll call this my.app.host.

  1. Install Red Hat Enterprise Linux/CentOS 7.1 and log in as root.
    Important: Don't customize your installation. Select only the default packages list.
  2. Create a file, /etc/security/limits.d/teamforge.conf, and make sure it has the following "nproc" and "nofile" settings.
    • vim /etc/security/limits.d/teamforge.conf
    • sf-admin soft nproc 10240
    • sf-admin hard nproc 10240
    • sf-admin hard nofile 65536
    • sf-admin soft nofile 65536
    • Save the file and reboot the server.
  3. Check your basic networking setup. See Set up networking for your TeamForge server for details.
  4. 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.
  5. Configure your TeamForge 8.1 installation repository. See TeamForge installation repository configuration for Red Hat/CentOS.
  6. Install the following application packages.
    1. TeamForge: To install the TeamForge application packages run the following command:
      • yum install teamforge
  7. Set up your site's master configuration file.
    • vi /opt/collabnet/teamforge-installer/8.1.0.1/conf/site-options.conf
    1. Identify the servers and services running on them. 
      HOST_localhost=app etl indexer
      DOMAIN_localhost=my.app.domain.com
      HOST_my.db.domain.com=database datamart
      HOST_my.scmandgit.domain.com=subversion cvs gerrit
    2. Add 'binary' to the HOST_localhost token if you are installing Nexus. 
      HOST_localhost=app 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. 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. Ensure to set the token DEDICATED_INSTALL=true. This makes the installation process very simple as the TeamForge installer takes care of configuring the Apache and PostgreSQL automatically.
    13. Make sure that the following tokens have a value if ETL is enabled. 
      SOAP_ANONYMOUS_SHARED_SECRET
      ETL_SOAP_SHARED_SECRET
    14. Configure Black Duck Code Sight tokens if you are installing Black Duck Code Sight. See Black Duck Code Sight site-option tokens.
    15. 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.
    16. Ensure to set the token SELINUX_SETUP=true.
    17. 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?
    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. Save the site-options.conf file.
  8. Recreate the runtime environment.
    • cd /opt/collabnet/teamforge-installer/8.1.0.1
    • ./install.sh -r -I -V
  9. Important: Do this if you have updated the JAMES_ACCEPTED_RELAYS token with the Git server's IP address.
    Edit the /opt/collabnet/teamforge/runtime/james/apps/james/SAR-INF/config.xml file and comment out the <authorizedAddresses> node. For example: 
    <!--  <authorizedAddresses>127.0.0.0/8</authorizedAddresses>   -->

Do this on the database server - my.db.host

  1. Install Red Hat Enterprise Linux/CentOS 7.1 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 8.1 installation repository. See TeamForge installation repository configuration for Red Hat/CentOS.
  5. Install the TeamForge database packages.
    • yum install teamforge-database
  6. Copy the site-options.conf file from the application server to the database server in the directory /opt/collabnet/teamforge-installer/8.1.0.1/conf
  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.db.host=database datamart
    Note: 'HOST_my.db.host' is just an example. As you are installing database on a separate server, do not use 'HOST_localhost'. Use 'HOST_<valid host name>' instead.
    DOMAIN_my.db.host=my.db.domain.com
    HOST_my.app.domain.com=app etl indexer
    HOST_my.scmandgit.domain.com=subversion cvs gerrit
  8. Recreate the runtime environment.
    • cd /opt/collabnet/teamforge-installer/8.1.0.1
    • ./install.sh -r -I -V

Do this on the SCM Server - my.scmandgit.host

  1. Install Red Hat Enterprise Linux/CentOS 7.1 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 8.1 installation repository. See TeamForge installation repository configuration for Red Hat/CentOS.
  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 server in the directory /opt/collabnet/teamforge-installer/8.1.0.1/conf
  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
    Note: 'HOST_my.scmandgit.host' is just an example. As you are installing SCM on a separate server, do not use 'HOST_localhost'. Use 'HOST_<valid host name>' instead.
    DOMAIN_my.scmandgit.host=my.scmandgit.domain.com
    HOST_my.app.domain.com=app etl indexer
    HOST_my.db.domain.com=database datamart
  8. Recreate the runtime environment.
    • cd /opt/collabnet/teamforge-installer/8.1.0.1
    • ./install.sh -r -I -V
  9. Restart Apache.
    • RHEL/CentOS 6.x: systemctl reload httpd
    • RHEL/CentOS 7.x: /etc/init.d/httpd reload
    Important: Make sure you restart Apache whenever you do a runtime recreation on the SCM server.
  10. Set up the initial site data (bootstrap).
    • cd /opt/collabnet/teamforge-installer/8.1.0.1
    • ./bootstrap-data.sh

Do the following on the Black Duck Code Sight server - my.codesight.host.

  1. Set up Black Duck Code Sight on a separate server. See Install Black Duck Code Sight on a separate RHEL/CentOS 6.6 server.

Do the following on the application server - my.app.host

  1. Set up the initial site data (bootstrap).
    • cd /opt/collabnet/teamforge-installer/8.1.0.1
    • ./bootstrap-data.sh
  2. Start TeamForge.
    • /etc/init.d/collabnet start
  3. Note: 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 server - my.scmandgit.host

  1. Run the TeamForge post installation script. For more information, see post-install.py.
    • /opt/collabnet/teamforge/runtime/scripts/post-install.py
  2. Important: This step is required if you want Git notification emails.
    Edit the /opt/collabnet/gerrit/etc/gerrit.config file and update the 'smtpServer' property with the TeamForge application server's host name. For example:
    [sendemail]
              smtpServer = <TeamForge application server host name>
    1. Restart gerrit.
      • /etc/init.d/collabnet stop gerrit
      • /etc/init.d/collabnet start gerrit

Do the following on the application server - my.app.host

  1. Revoke the super user permissions of database and datamart users.
    • /opt/collabnet/teamforge/runtime/scripts/revoke-superuser-permission.py
  2. Restart the collabnet services.
    • /etc/init.d/collabnet restart
  3. 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 CollabNet TeamForge 8.1 on Red Hat/CentOS
Related concepts
TeamForge installation/upgrade/configuration/administration FAQs