In this option, we install Black Duck Code Sight on a
separate server on SUSE and other services on the main application server.
Note: For the ETL service to run as expected in a distributed TeamForge installation, all servers must have
the same time zone.
In this option, the following
services run on the application server (we call this
my.app.host).
- TeamForge Application Server
- Database Server (Operational DB and Reports
DB)
- ETL Server
- GIT Integration Server
- SCM Integration Server (Subversion and
CVS)
- Search Server (Indexer).
The following service runs on the
Black Duck Code Sight Server. (We call this
my.codesight.host )
- Black Duck Code Sight Server
Log on to the server as root user always.
Do this on the main
TeamForge application server.
We'll call this my.app.host.
-
Install SuSE Linux Enterprise Server 11 SP2 and log in as
root.
Important: Don't customize your installation. Select only the
default packages list.
-
Check your basic networking setup.
See Set up networking for your TeamForge server for details.
-
Configure your TeamForge
8.0 installation
repository. See TeamForge installation repository configuration for SUSE.
-
Install the following application packages.
-
TeamForge: To install the
TeamForge application
packages run the following command:
-
GIT: To install the GIT packages run the following command.
- zypper install teamforge-git
-
Set up your site's master configuration file.
- vi /opt/collabnet/teamforge-installer/8.0.0.1/conf/site-options.conf
-
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
-
Add
'gerrit' to the HOST_localhost token if you are installing
Git.
HOST_localhost=app database datamart etl indexer subversion cvs gerrit
-
Configure the database and datamart settings.
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.
-
TeamForge
7.1
and later support
automatic
password
creation.
See AUTO_DATA for more
information.
-
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.
-
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_CA_CERT_FILE
-
SSL_CHAIN_FILE
Note: The SSL_CA_CERT_FILE and SSL_CHAIN_FILE are optional.
-
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.
-
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.
-
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__}
-
If you have LDAP set up for external authentication, you must set the
“REQUIRE_USER_PASSWORD_CHANGE” site options token to
false.
-
Make sure that the following tokens have a value if ETL is
enabled.
SOAP_ANONYMOUS_SHARED_SECRET
ETL_SOAP_SHARED_SECRET
-
Configure Black Duck Code Sight
tokens
if you are installing Black Duck Code Sight. See Black Duck Code Sight site-option tokens.
-
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.
-
If you are installing TeamForge through disconnected media, set the token
HELP_AVAILABILITY=local.
-
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?
-
Save the site-options.conf file.
-
Recreate the runtime environment.
- cd /opt/collabnet/teamforge-installer/8.0.0.1
- ./install.sh -r -I -V
Do this on the Black Duck Code Sight Server. We'll call
this my.codesight.host
-
Install SuSE Linux Enterprise Server 11 SP2 and log in as
root.
Important: Don't customize your installation. Select only the
default packages list.
-
Check your basic networking setup.
See Set up networking for your TeamForge server for details.
-
Configure your TeamForge
8.0 installation
repository. See TeamForge installation repository configuration for SUSE.
-
Run the following command to install the Black Duck Code Sight packages.
- zypper install teamforge-codesearch
-
Copy the site-options.conf file from the application
server to the Code Search server in the directory
/opt/collabnet/teamforge-installer/8.0.0.1/conf
-
Modify the host token settings on the site-options.conf
file.
Note: 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
-
Recreate the runtime environment.
- cd /opt/collabnet/teamforge-installer/8.0.0.1
- ./install.sh -r -I -V
Do the following on the application server - my.app.host
-
Set up the initial site data (bootstrap).
- cd
/opt/collabnet/teamforge-installer/8.0.0.1
- ./bootstrap-data.sh
-
Start TeamForge.
- /etc/init.d/collabnet
start
-
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
Do this on my.codesight.host
-
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.
-
Run the TeamForge post installation script. For more information, see post-install.py.
- /opt/collabnet/teamforge/runtime/scripts/post-install.py
Do this on my.app.host
-
Revoke the user permissions of the database and datamart users.
- /opt/collabnet/teamforge/runtime/scripts/revoke-superuser-permission.py
-
Restart the collabnet services.
- /etc/init.d/collabnet restart
Do this on my.codesight.host
-
Restart the Black Duck Code Sight service.
- /etc/init.d/collabnet restart tomcatcs
Do this on my.app.host
-
Apply some finishing touches and make sure everything is running
smoothly.
-
Reboot the server and make sure all services come up automatically at
startup.
-
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.
-
Create a sample project.
See Create a TeamForge project.
-
Write a welcome message to your site's users.
See Create a site-wide broadcast.
- Review Board: To install Review Board, see: Set up Review Board.
- Orchestrate: To install TeamForge
Orchestrate, see TeamForge
Orchestrate installation.
-
Cross-project life cycle metrics reporting in
TeamForge 8.0
As the new reporting framework is expected to
evolve over the next few releases, unlike TeamForge 7.2 or earlier versions,
TeamForge 8.0 and later have the life cycle metric reports feature (that
lets you create and add cross-project life cycle metric charts to project
pages) deprecated and turned off by default. While the new reporting
framework makes reporting effortless, expect it to cater only to
intra-project reporting needs at the moment. If you still want cross-project
life cycle metrics reporting in TeamForge 8.0, you must
set this REPORTS_ENABLE_LIFECYCLE_METRICS token to
true. See REPORTS_ENABLE_LIFECYCLE_METRICS for more
information.