Install TeamForge 8.1: Black Duck Code Sight on a separate server on RHEL/CentOS

In this option, we install Black Duck Code Sight on a separate server and other services on the main application server.

1. Install Red Hat Enterprise Linux/CentOS 7.1 and log in as root.
   • Red Hat Enterprise Linux/CentOS 6.6 is also supported. See Software requirements for CollabNet TeamForge 8.1.
   • The host must be registered with the Red Hat Network if you are using Red Hat Enterprise Linux. See Platform specification for TeamForge 8.1 for the full platform requirements.
   • See the Red Hat installation guide for help.
   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
   2. GIT: To install the GIT packages run the following command.
      • yum install teamforge-git
7. Set up your site's master configuration file.
   • vi /opt/collabnet/teamforge-installer/8.1.0.1/conf/site-options.conf
   1. Configure the HOST token.

      • HOST_localhost=app database datamart etl indexer subversion cvs

      • DOMAIN_localhost=my.app.domain.com

      • HOST_my.codesight.domain.com=codesearch

   2. Add 'gerrit' to the HOST_localhost token if you are installing Git.

      HOST_localhost=app database datamart etl indexer subversion cvs gerrit

   3. Add 'binary' to the HOST_localhost token if you are installing Nexus.

      HOST_localhost=app database datamart etl indexer subversion cvs gerrit binary

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

Do this on the Black Duck Code Sight Server. We'll call this my.codesight.host.

9. Install Red Hat Enterprise Linux/CentOS 6.6 and log in as root.
   • The host must be registered with the Red Hat Network if you are using Red Hat Enterprise Linux. See Platform specification for TeamForge 8.1 for the full platform requirements.
   • See the Red Hat installation guide for help.
   Important: Don't customize your installation. Select only the default packages list.
10. 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
11. Configure your TeamForge 8.1 installation repository. See TeamForge installation repository configuration for Red Hat/CentOS.
12. Run the following command to install the Black Duck Code Sight packages.
    • yum install teamforge-codesearch
13. Copy the site-options.conf file from the application server to the /opt/collabnet/teamforge-installer/8.1.0.1/conf directory of the Black Duck Code Sight server.
14. 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.codesight.host=codesearch

    • DOMAIN_my.codesight.host=my.codesight.domain.com

    • HOST_my.app.domain.com=app database datamart etl indexer subversion cvs gerrit

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

16. Set up the initial site data (bootstrap).
    • cd /opt/collabnet/teamforge-installer/8.1.0.1
    • ./bootstrap-data.sh
17. Start TeamForge.
    • /etc/init.d/collabnet start
18. 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?.
19. Revoke the user permissions of the database and datamart users.
    • /opt/collabnet/teamforge/runtime/scripts/revoke-superuser-permission.py

Do this on my.codesight.host

20. Install the Black Duck Code Sight license on the server where Black Duck Code Sight is installed. For more information, see Install the Black Duck Code Sight license.
21. Run the TeamForge post installation script. For more information, see post-install.py.
    • /opt/collabnet/teamforge/runtime/scripts/post-install.py
22. Restart the Black Duck Code Sight service.
    • /etc/init.d/collabnet restart tomcatcs

Do this on my.app.host

23. Restart the collabnet services.
    • /etc/init.d/collabnet restart
24. 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.