Install TeamForge 8.1 with Database and Datamart on a separate server

In this option, we install the database (Operational Database) and datamart (Reporting database) on a separate server and other services on the main application 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)
We call this a "dedicated install" since both the servers are dedicated to TeamForge. The TeamForge installer takes care of the database configurations. In this example, we will specify a separate port for the reports database. By default, both the site database and the reporting database use port 5432, but when heavy traffic is expected, it can be a good idea to use port 5632 for the reporting database.
Note: In a multi-server installation of TeamForge, ensure that all servers have the same system time zone for ETL to function properly.

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 SuSE Linux Enterprise Server 11 SP2 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. Configure your TeamForge 8.1 installation repository. See TeamForge installation repository configuration for SUSE.
  4. Install the following application packages.
    1. TeamForge: To install the TeamForge application packages run the following command:
      • zypper install teamforge
    2. GIT: To install the GIT packages run the following command.
      • zypper install teamforge-git
    3. To install Black Duck Code Sight run the following command.
      • zypper install teamforge-codesearch
  5. 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 subversion cvs
      DOMAIN_localhost=my.app.domain.com
      HOST_my.db.domain.com=database datamart
    2. Add 'gerrit' to the HOST_localhost token if you are installing Git. 
      HOST_localhost=app etl indexer subversion cvs gerrit
    3. Add 'codesearch' to the HOST_localhost token if you are installing Black Duck Code Sight. 
      HOST_localhost=app etl indexer subversion cvs gerrit 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. 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. Save the site-options.conf file.
  6. Run the install_jdk_suse.sh script.
    • cd /opt/collabnet/teamforge-installer/8.1.0.1
    • ./install_jdk_suse.sh
  7. Recreate the runtime environment.
    • cd /opt/collabnet/teamforge-installer/8.1.0.1
    • ./install.sh -r -I -V

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

  1. Install SuSE Linux Enterprise Server 11 SP2 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. Configure your TeamForge 8.1 installation repository. See TeamForge installation repository configuration for SUSE.
  4. Install the TeamForge database packages.
    • zypper install teamforge-database
  5. 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
  6. 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 subversion cvs gerrit codesearch
  7. Run the install_jdk_suse.sh script.
    • cd /opt/collabnet/teamforge-installer/8.1.0.1
    • ./install_jdk_suse.sh
  8. Recreate the runtime environment.
    • cd /opt/collabnet/teamforge-installer/8.1.0.1
    • ./install.sh -r -I -V

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. If you have installed Black Duck Code Sight, then install the license for Black Duck Code Sight. For more information, see Install the Black Duck Code Sight license.
  5. Revoke the super user permissions of database and datamart users.
    • /opt/collabnet/teamforge/runtime/scripts/revoke-superuser-permission.py
  6. Restart the collabnet services.
    • /etc/init.d/collabnet restart
  7. 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 SuSE
Related concepts
TeamForge installation/upgrade/configuration/administration FAQs