Install TeamForge, Oracle database, EventQ on separate servers

Three-server distributed setup with TeamForge, Oracle Database (including Datamart) and EventQ on RHEL/CentOS 7.3 servers.

Before you begin:

Remember:

  • TeamForge 17.8 supports both RHEL/CentOS 6.9 and 7.3. See TeamForge installation requirements
  • For the ETL service to run as expected in a distributed TeamForge installation, all servers must have the same time zone.
  • While you can run both EventQ and TeamForge on the same server, CollabNet recommends such an approach only for testing purposes. It's always recommended to run EventQ on a separate server for optimal scalability. See EventQ installation requirements.
  • Installing or upgrading TeamForge needs root privileges. You must log on as root or use a root shell to install or upgrade TeamForge.
App Server: server-01 Oracle Database Server: server-03
TeamForge Application Server (ctfcore) Database Server (ctfcore-database and ctfcore-datamart)
Codesearch Server (codesearch)  
Mail Server (mail)  
ETL Server (etl)  
Search Server (search)  
Git Integration Server (gerrit and gerrit-database)  
SCM Integration Server (subversion and cvs)  
EventQ Server: server-02
TeamForge EventQ Server (eventq, mongodb, redis and rabbitmq)

Do this on the 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 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.8 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-17.8.xx-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.8 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 7.3 64 bit RPM package: CTF-Disconnected-media-17.8.655-104.rhel7.x86_64.rpm
        Note: 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.8 disconnected media installation on CentOS 7.3 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 17.8 on CentOS 7.3.
      • 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
  5. Install the TeamForge application packages.
    • yum install teamforge
  6. Rename the sample site configuration file from the installation package.
    • cd /opt/collabnet/teamforge/etc/
    • cp site-options-oracle.conf site-options.conf
  7. Set up your site's master configuration file.
    • vi /opt/collabnet/teamforge/etc/site-options.conf
    1. Configure the services and domain name tokens. 
      server-01:SERVICES = ctfcore mail search codesearch etl subversion cvs
      server-01:PUBLIC_FQDN = my.app.domain.com
      server-03:SERVICES = ctfc0re-database ctfcore-datamart
    2. Add Gerrit identifiers if you are installing Git. 
      server-01:SERVICES = ctfcore mail search codesearch etl 
subversion cvs gerrit gerrit-database
    3. Add Binary identifiers if you are installing Nexus. 
      server-01:SERVICES = ctfcore mail search codesearch etl 
subversion cvs gerrit gerrit-database binary binary-database
    4. Add Review Board identifiers if you are installing Review Board. 
      server-01:SERVICES = ctfcore mail search codesearch etl 
subversion cvs gerrit gerrit-database binary binary-database reviewboard reviewboard-database
    5. Attention: SSL is enabled by default and a self-signed certificate is auto-generated. Use the following tokens to adjust this behavior. 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. 
      SSL_CERT_FILE=
      SSL_KEY_FILE=
      SSL_CHAIN_FILE=
      Important: All SSL certificates including self-signed certificates are added automatically.
    6. Configure the database and datamart settings.
      Note: For more information about configuring site option tokens, 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 run the following command.
      • su - oracle
      • tnsping <database_name>
      Note down the value of the SERVICE NAME from the system output and use this value for the DATABASE_SERVICE_NAME token in the site-options.conf file.
    7. If the token REQUIRE_PASSWORD_SECURITY is enabled, then set this PASSWORD_CONTROL_EFFECTIVE_DATE token with a future date. If already set, reset the PASSWORD_CONTROL_EFFECTIVE_DATE with a future date while upgrading to TeamForge 17.8.
      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. You must set (or reset if required) this token with a future date. For example, you can use the following logic and pick a future date: PASSWORD_CONTROL_EFFECTIVE_DATE=<the day on which TeamForge upgrade is done> + PASSWORD_WARNING_PERIOD. See PASSWORD_CONTROL_EFFECTIVE_DATE for more information.
    8. 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__}
    9. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
    10. Configure TeamForge site options to proxy EventQ through TeamForge. For more information, see "EventQ and TeamForge on two separate servers" section in this topic: Proxying EventQ through TeamForge. Also see Ports used by TeamForge EventQ services.
    11. Save the site-options.conf file.
  8. 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 Oracle Database Server (server-03)

  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 (server-01)

  1. Copy the Oracle Datamart setup script from /opt/collabnet/teamforge/runtime/scripts/ to the /tmp directory of server-03.
    • scp /opt/collabnet/teamforge/runtime/scripts/datamart-oracle-setup.sh <username>@<server-03>:/tmp

Do this on the Oracle 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. 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 this on the TeamForge Application Server (server-01)

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

  2. 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
  3. Restart TeamForge.
    • teamforge restart

Do this on the EventQ server (server-02)

  1. Install EventQ. See EventQ installation walk-through

Do this on the TeamForge Application Server (server-01)

  1. 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.
Related concepts
TeamForge installation/upgrade/configuration/administration FAQs