Install TeamForge 16.3: Oracle database on a separate server

In this option, we install the Oracle database (Operational database and Reports database) on a separate server and other services on the main application server. If you want Black Duck Code Sight, you must install it on a separate RHEL/CentOS 6.7 server.

Important: See Plan your installation and Software requirements for CollabNet TeamForge 16.3 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)
Note: If either of the remote servers (the data server or the source code server) is not under your direct control, check with the Database Administrator to make sure that you can carry out these instructions on that 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 TeamForge application server. We'll call this my.app.host.

  1. Install Red Hat Enterprise Linux/CentOS 7.2 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 installation repository.
    • TeamForge installation repository configuration for sites with internet access
    1. Contact the CollabNet Support and download the TeamForge 16.3 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-16.3-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 16.3 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.2 64 bit RPM package: CTF-Disconnected-media-16.3.924-7294.rhel7.x86_64.rpm
        Note: In addition to the above CentOS 7.2 64 bit RPM package, you must get the following CentOS 7.2 compatibility RPM, which is required for TeamForge 16.3 disconnected media installation on CentOS 7.2 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 16.3 on CentOS 7.2.
      • 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
  6. Install the following application packages.
    1. TeamForge: To install the TeamForge application packages run the following command:
      • yum install teamforge
    2. GIT: To install the GIT packages run the following command.
      • yum install teamforge-git
  7. Rename the sample site configuration file from the installation package.
    • cd /opt/collabnet/teamforge-installer/16.3
    • cp conf/site-options-oracle.conf conf/site-options.conf
    Note: The files site-options-small.conf, site-options-medium.conf and site-options-large.conf contain options to tune the performance of the TeamForge site. To tune your site's performance, you can look through these files for the load specifications they are intended for, and use the appropriate one for your site's requirements.
  8. Set up your site's master configuration file.
    • vi /opt/collabnet/teamforge-installer/16.3/conf/site-options.conf
    1. Configure the HOST token. 
      HOST_localhost=app etl indexer subversion cvs
      DOMAIN_localhost=my.app.domain.com
      HOST_<my.db.host>=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 'binary' to the HOST_localhost token if you are installing Nexus. 
      HOST_localhost=app etl indexer subversion cvs gerrit binary
    4. Configure the following token if you are installing Black Duck Code Sight. 
      HOST_my.codesight.domain.com=codesearch
    5. Configure the database and datamart settings.
      Note: For more information about configuring variables, see site-options.conf
      DATABASE_TYPE=oracle
      DATABASE_USERNAME=sitedatabaseusername  
      DATABASE_PASSWORD=sitedatabasepwd  
      DATABASE_READ_ONLY_USER=sitedatabasereadonlyusername
      DATABASE_READ_ONLY_PASSWORD=sitedatabasereadonlyuserpwd
      DATABASE_NAME=sitedatabaseinstancename
      REPORTS_DATABASE_USERNAME=reportingdatabaseusername
      REPORTS_DATABASE_PASSWORD=reportingdatabasepwd
      REPORTS_DATABASE_NAME=reportingdatabaseinstancename
      REPORTS_DATABASE_READ_ONLY_USER=reportingreadonlyusername
      REPORTS_DATABASE_READ_ONLY_PASSWORD=reportingreadonlyuserpwd
      REPORTS_DATABASE_MAX_POOL_SIZE=30
      DATABASE_SERVICE_NAME
      REPORTS_DATABASE_SERVICE_NAME
      Tip: To find the value for the token DATABASE_SERVICE_NAME log in to your Oracle server and execute this command.
      • su - oracle
      • tnsping <database_name>
      Find the value of the SERVICE NAME in the output and use this value for the DATABASE_SERVICE_NAME in the site-options.conf file.
    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. 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.
    8. 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.
    9. 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.
    10. 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.
      Important: Remember to use the same key in the external SCM integration server also.
    11. 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__}
    12. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
    13. 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.
    14. Make sure that the following tokens have a value if ETL is enabled. 
      SOAP_ANONYMOUS_SHARED_SECRET
      ETL_SOAP_SHARED_SECRET
    15. Configure Black Duck Code Sight tokens if you are installing Black Duck Code Sight. See Black Duck Code Sight site-option tokens.
    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. Save the site-options.conf file.
  9. Download the corresponding version of Oracle client from http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html and run the following command:
    • yum localinstall <path to oracle client rpm>

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

  1. Log on to the Oracle database server as a system administrator with 'SYSDG' privilege and run the following query.
    • alter system set parallel_threads_per_cpu=4;

Do this on the TeamForge application server - my.app.host

  1. Recreate the runtime environment.
    • cd /opt/collabnet/teamforge-installer/16.3
    • ./install.sh -r -I -V
  2. Copy the Oracle datamart setup script from /opt/collabnet/teamforge/runtime/scripts to the /tmp directory of my.db.host.
    • scp /opt/collabnet/teamforge/runtime/scripts/datamart-oracle-setup.sh <username>@<my.db.host>:/tmp

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

  1. Install Red Hat Enterprise Linux/CentOS 7.2 and log in as root.
    Important: Don't customize your installation. Select only the default packages list.
  2. Install Oracle 12c.
    Note: Make sure your database uses UTF8 or AL32UTF8 encoding. This is needed to support users in Asian languages. See this Oracle knowledge base article.
  3. Copy the Oracle datamart setup script.
    • mkdir /u1
    • cp /tmp/datamart-oracle-setup.sh /u1
  4. Log in as Oracle user and create the site database user and permissions. See Set up an Oracle database for help.
  5. Create the reporting user and schema.
    Note: Skip this step if you have already set up the datamart setup in the Oracle database. Your responses to the script's prompts must match the values of the equivalent variables in the site-options.conf file on my.app.server.
    • cd /u1
    • sh datamart-oracle-setup.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.7 server.

Do this on the TeamForge Application Server - my.app.host

  1. Set up the initial site data (bootstrap).
    • ./bootstrap-data.sh
  2. Start TeamForge.
    • /etc/init.d/collabnet start

Note: Gerrit is configured as part of the post installation tasks included in the post-install.py script. As a result, Gerrit's status would be Not configured during startup, which you can safely ignore.

  1. 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
    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?.
  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 TeamForge 16.3 on RHEL/CentOS
Related concepts
TeamForge installation/upgrade/configuration/administration FAQs