Three-server distributed setup with TeamForge (including Database and Datamart), SCM
(Subversion and CVS) and Git, and EventQ services installed 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.
The following table shows the distribution of services on different servers.
App Server: server-01 |
SCM and Git Integration Server: server-03 |
TeamForge Application Server (ctfcore) |
SCM Integration Server (subversion and
cvs) |
Mail Server (mail) |
Git Integration Server
(gerrit
and
gerrit-database) |
Codesearch Server (codesearch) |
|
Database Server (ctfcore-database and
ctfcore-datamart) |
|
ETL Server (etl) |
|
Search Server (search) |
|
EventQ Server: server-02 |
TeamForge EventQ Server (eventq, mongodb, redis
and rabbitmq) |
Do this on the TeamForge Application
Server (server-01)
-
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.
-
Check your basic networking setup. See Set up Networking for
more information.
-
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.
-
Verify if SELinux is running in enforcing mode.
-
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.
-
Configure your TeamForge installation repository.
- TeamForge installation repository configuration for sites with internet
access
-
Contact the CollabNet Support and download the TeamForge
17.8
installation repository package to /tmp.
-
Install the repository package.
- yum install -y
/tmp/collabnet-teamforge-repo-17.8.xx-1.noarch.rpm
-
Refresh your repository cache.
- TeamForge installation repository configuration for sites without
internet access
-
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.
-
Unpack the disconnected installation package.
-
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
-
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.
-
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
-
Verify your yum configuration files.
- yum list httpd
- yum list apr
-
Install the following application packages.
-
TeamForge: To install the
TeamForge application
packages run the following command:
-
Set up your site's master configuration file.
- vi /opt/collabnet/teamforge/etc/site-options.conf
-
Configure
the services and domain name tokens.
server-01:SERVICES = ctfcore ctfcore-database mail codesearch search etl ctfcore-datamart
server-01:PUBLIC_FQDN = my.app.domain.com
server-03:SERVICES = subversion cvs gerrit gerrit-database
-
Add
Binary identifiers if you are installing Nexus.
server-01:SERVICES = ctfcore ctfcore-database mail codesearch search etl
ctfcore-datamart binary binary-database
-
Add
Review Board identifiers if you are installing Review Board.
server-01:SERVICES = ctfcore ctfcore-database mail codesearch search etl
ctfcore-datamart binary binary-database reviewboard reviewboard-database
-
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.
-
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.
-
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.
-
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 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?
-
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.
-
Save the site-options.conf file.
-
Provision
services.
Note:
TeamForge 17.4 (and later) installer expects the system locale to be
LANG=en_US.UTF-8. TeamForge "provision" command fails otherwise.
Do this on the SCM and Git Integration Server (server-03)
-
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.
-
Check your basic networking setup. See Set up Networking for
more information.
-
If the TeamForge server has SELinux
enabled, run it in 'permissive' mode temporarily while installing or upgrading
TeamForge. TeamForge create
runtime fails otherwise.
-
Verify if SELinux is running in enforcing mode.
-
If the output of the getenforce command is
either "Disabled" or "Permissive", SELinux is already disabled.
-
If not disabled, run the following command to bring it to 'permissive'
mode.
-
Configure your TeamForge installation repository.
- TeamForge installation repository configuration for sites with internet
access
-
Contact the CollabNet Support and download the TeamForge
17.8
installation repository package to /tmp.
-
Install the repository package.
- yum install -y
/tmp/collabnet-teamforge-repo-17.8.xx-1.noarch.rpm
-
Refresh your repository cache.
- TeamForge installation repository configuration for sites without
internet access
-
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.xx disconnected media installation on CentOS
7.3 profile:
compat-ctf-dc-media-1.0-1.el7.centos.noarch.rpm.
-
Unpack the disconnected installation package.
-
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
-
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.
-
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
-
Verify your yum configuration files.
- yum list httpd
- yum list apr
-
Install the TeamForge SCM and Git
packages.
- yum install teamforge-scm teamforge-git
-
Copy the site-options.conf file from the TeamForge
Application Server to the SCM and Git Integration Server's /opt/collabnet/teamforge/etc/ directory.
-
Configure
the services and domain name tokens.
server-03:SERVICES = subversion cvs gerrit gerrit-database
server-03:PUBLIC_FQDN = my.scmandgit.domain.com
server-01:SERVICES = ctfcore ctfcore-database mail codesearch search etl ctfcore-datamart binary binary-database reviewboard reviewboard-database
-
Provision
services.
Note:
TeamForge 17.4 (and later) installer expects the system locale to be
LANG=en_US.UTF-8. TeamForge "provision" command fails otherwise.
Do this on the TeamForge Application Server (server-01)
-
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
-
Restart TeamForge.
Do this on the EventQ server (server-02)
-
Install EventQ. See EventQ installation walk-through
Do this on the Application Server (server-01)
-
Verify TeamForge installation.
-
Reboot the server and make sure all services come up automatically at
startup.
-
Log on to the TeamForge web application using the default Admin
credentials.
- Username: "admin"
- Password: "admin"
-
Create a sample project. See Create a TeamForge project
-
Write a welcome message to your site's users. See Create a
site-wide broadcast.