In this procedure, we'll assume that you are upgrading on the same server where your
existing TeamForge site is running on 7.2. It is possible to
simultaneously upgrade and move your site to a new hardware. However, since we are working
with a dedicated installation, the priority here is to keep things as simple and quick as
possible.
Important: TeamForge
8.0 supports
RHEL/CentOS 7.0. However, it also
supports RHEL/CentOS
6.6
if you choose to upgrade on the same server that runs RHEL/CentOS
6.6.
In
this option, the following services run on the application server (we call this
my.app.host).
- TeamForge Application Server
- Black Duck Code Sight Server
- ETL Server
- Database Server (Operational DB and Reports
DB)
- SCM Integration Server (Subversion and
CVS)
- Search Server (Indexer)
The following service runs on the GIT integration server (we call this
my.git.host).
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 the following on the application server - my.app.host
-
Stop the Apache server and the TeamForge application server.
- /etc/init.d/httpd stop
- /etc/init.d/collabnet stop
-
Migrate your PostgreSQL to the
latest version supported by TeamForge
8.0.
Important: You must have RHEL/CentOS 6.5 or
later to run PGTurant. Upgrade the operating system packages (yum upgrade) before running
PGTurant on sites running on RHEL/CentOS versions 6.4 or earlier.
-
Install PGTurant. See Upgrade PostgreSQL using PGTurant for more
information.
Important: If your TeamForge site has no
internet access, contact the
CollabNet Support, get the
pgturant-8.0.0.1-4.noarch.rpm
package and unpack the RPM.
- rpm -ivh pgturant-8.0.0.1-4.noarch.rpm
-
Upgrade TeamForge
PostgreSQL data
directory to PostgreSQL
9.3.
- cd /opt/collabnet/pgturant/bin/
- ./pgturant -s /var/lib/pgsql/9.2/data -d /var/lib/pgsql/9.3 -u 9.3 -m
-
Start the PostgreSQL service, run the
analyze_new_cluster.sh script and stop
PostgreSQL.
- /etc/init.d/postgresql-9.3
start
- su - postgres -c "/var/lib/pgsql/9.3/analyze_new_cluster.sh"
- /etc/init.d/postgresql-9.3
stop
-
Click here only if your
reporting database is running on a separate port.
-
Back up the file system data.
Tip: /tmp/backup_dir is just an
example. You can use any directory or partition you prefer to store your backup
files.
-
Make an archive file with the following data directories:
Directory |
Contents |
/opt/collabnet/teamforge/var |
User-created data, such as artifact
attachments |
/svnroot |
Subversion source code repositories |
/sf-svnroot |
Subversion repository for branding data |
/cvsroot |
CVS source code repositories (not present on all
sites) |
- cp -Rpfv /svnroot /sf-svnroot /cvsroot
/opt/collabnet/teamforge/var
/tmp/backup_dir
-
Back up your SSH keys, if any.
-
Back up your SSL certificates and keys, if any.
-
Move the collabnet repository of the older version of TeamForge.
- mv /etc/yum.repos.d/collabnet-7.2.0.x.repo
/etc/yum.repos.d/collabnet-7.2.0.x.repo.cn_backup
Note: Replace "x" with the appropriate patch release number if
applicable.
-
Upgrade the operating system packages.
-
If the TeamForge server has SELinux
enabled, disable it temporarily while installing or upgrading TeamForge.
-
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, run the following command to disable SELinux.
See Set up SELinux to have TeamForge run in SELinux mode after
completing the installation or upgrade.
-
Configure your TeamForge
8.0 installation
repository. See TeamForge installation repository configuration for Red Hat/CentOS.
-
If the PostgreSQL database is running locally, stop the PostgreSQL
service.
- /etc/init.d/postgresql-9.2
stop
-
Uninstall the TeamForge CLI add-on.
- cd
/opt/collabnet/teamforge/add-ons/teamforge_cli_server
- ./install --uninstall
- yum erase teamforge_cli_server
-
Uninstall the PostgreSQL
RPMs.
Note: When prompted, you must select the option to remove all the dependent
packages.
- yum erase postgresql92-libs postgresql92-docs
postgresql92-server postgresql92
-
Install the following application packages.
-
TeamForge: To install the
TeamForge application
packages run the following command:
-
Black Duck Code Sight: To install the
Black Duck Code Sight packages run the
following command:
- yum install teamforge-codesearch
-
In the site-options.conf file, make sure you do the
following.
Note: Back up your site-options.conf file before making any
changes.
- vi /opt/collabnet/teamforge-installer/8.0.0.1/conf/site-options.conf
-
Update the host name and domain name, if required.
HOST_localhost=app database datamart etl indexer subversion cvs
DOMAIN_localhost=my.app.domain.com
HOST_my.git.domain.com=gerrit
Add
'codesearch' to the HOST_localhost token if you
are installing
Black Duck Code Sight.
HOST_my.localhost= app database datamart etl indexer subversion cvs codesearch
Add 'binary' to the HOST_localhost token if you are installing Nexus.
HOST_my.localhost= app database datamart etl indexer subversion cvs codesearch binary
-
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 your site is running in SSL mode (SSL=on), add the following java
runtime property to the JBOSS_JAVA_OPTS token.
JBOSS_JAVA_OPTS=-Xms1536m -Xmx1536m -XX:MaxPermSize=512m -server -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/tmp -verbose:gc -XX:+
PrintGCTimeStamps -XX:+PrintGCDetails -Djsse.enableSNIExtension=false -Dsun.rmi.dgc.client.gcInterval=600000 -Dsun.rmi.dgc.server.gcInterval=600000
-
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.
-
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.
-
Ensure to set the token
DEDICATED_INSTALL=true.
-
Include the list of non-expiring TeamForge user accounts (password never
expires).
USERS_WITH_NO_EXPIRY_PASSWORD=admin,nobody,system,scmviewer,scmadmin
-
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. 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 have LDAP set up for external authentication, you must set the
“REQUIRE_USER_PASSWORD_CHANGE” site options token to
false.
-
If you are installing TeamForge through disconnected media, set the token
HELP_AVAILABILITY=local.
-
Ensure to set the token SELINUX_SETUP=false.
-
Save the site-options.conf file.
-
Recreate the runtime environment.
- cd /opt/collabnet/teamforge-installer/8.0.0.1
- ./install.sh -r -I -V
-
Update the file permissions on your site's data.
- /opt/collabnet/teamforge/runtime/scripts/fix_data_permissions.sh
Note: This process can take a long time for sites with a lot of data.
-
Convert your site data to work with TeamForge
8.0.
Tip: Before you kick off the data migration, do the following:
- Use the /etc/init.d/collabnet status command
to make sure the JBoss, Tomcat and Tomcatcs services are
stopped.
- If any of the trackers in your project already contains a field with
the name team, conflict may arise while running
the migrate.py script. This is because of
the inclusion of the Team feature in TeamForge 8.0. To prevent this conflict,
follow the steps given in FAQ
on troubleshooting.
- /opt/collabnet/teamforge/runtime/scripts/migrate.py
The migrate.py script locates the existing site
data and modifies it as needed.This includes configuration data for LDAP and
the James mail server. Any modifications that you have applied to these
components on your old site are reproduced on your upgraded TeamForge
8.0
site.
-
Start TeamForge.
- /etc/init.d/collabnet
start
-
If you have CVS integrations, synchronize permissions post upgrade. See, Synchronize TeamForge source control integrations.
-
Run the TeamForge post installation script. For
more information, see post-install.py.
-
Use the following command to run the
post-install.py script.
- /opt/collabnet/teamforge/runtime/scripts/post-install.py
Note: Enter the 'gitadmin' user name and password when prompted.
-
Install the Black Duck Code Sight license on the
server where Black Duck Code Sight is installed.
For more information see these
instructions.
-
Run the svn_cache.sh
script.
- cd
/opt/collabnet/teamforge/runtime/scripts/codesearch/
- ./svn_cache.sh <Repository Base URL Path of the SCM
Integration Server>
Provide a repository base URL path of the SCM integration server, for
example, "http://myint.box.net/svn/repos", where myint.box
is the server with the SCM integration server.
In addition, if you add a new integration server at some point later, you
must run this svn_cache.sh script, (after creating the
new integration server), on the TeamForge application server.
Do this on the Git integration server - my.git.host
-
Migrate your PostgreSQL to the
latest version supported by TeamForge
8.0.
Important: You must have RHEL/CentOS 6.5 or
later to run PGTurant. Upgrade the operating system packages (yum upgrade) before running
PGTurant on sites running on RHEL/CentOS versions 6.4 or earlier.
-
Install PGTurant. See Upgrade PostgreSQL using PGTurant for more
information.
Important: If your TeamForge site has no
internet access, contact the
CollabNet Support, get the
pgturant-8.0.0.1-4.noarch.rpm
package and unpack the RPM.
- rpm -ivh pgturant-8.0.0.1-4.noarch.rpm
-
Upgrade TeamForge
PostgreSQL data
directory to PostgreSQL
9.3.
- cd /opt/collabnet/pgturant/bin/
- ./pgturant -s /var/lib/pgsql/9.2/data -d /var/lib/pgsql/9.3 -u 9.3 -m
-
Start the PostgreSQL service, run the
analyze_new_cluster.sh script and stop
PostgreSQL.
- /etc/init.d/postgresql-9.3
start
- su - postgres -c "/var/lib/pgsql/9.3/analyze_new_cluster.sh"
- /etc/init.d/postgresql-9.3
stop
-
Back up the Git file system data.
-
Make an archive file with the following data directories.
Tip:
/tmp is just an example. You can use any
directory or partition that you prefer.
Directory |
Contents |
/gitroot |
Git source code repositories |
- cp -Rpfv /gitroot
/tmp/gitbackup_dir
- cp -Rpfv /opt/collabnet/gerrit/
/tmp/gitbackup_dir/gerrit
-
Back up your SSH keys, if any.
-
Move the collabnet repository of the older version of TeamForge.
- mv /etc/yum.repos.d/collabnet-7.2.0.x.repo
/etc/yum.repos.d/collabnet-7.2.0.x.repo.cn_backup
Note: Replace "x" with the appropriate patch release number if
applicable.
-
Upgrade the operating system packages.
-
If the TeamForge server has SELinux
enabled, disable it temporarily while installing or upgrading TeamForge.
-
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 disable SELinux.
-
Configure your TeamForge
8.0 installation
repository. See TeamForge installation repository configuration for Red Hat/CentOS.
-
Install the Git packages.
- yum install teamforge-git
-
Copy the site-options.conf file from my.app.host and modify the
token settings.
Note: If you choose to use the old site-options.conf file,
don’t forget to copy the AUTO_DATA token from the
application server.
-
Set the following tokens.
HOST_my.git.host=gerrit
DOMAIN_my.git.host=my.git.domain.com
HOST_my.app.domain.com=app database datamart etl indexer subversion cvs
-
Save the site-options.conf file.
-
Run the installer.
- cd /opt/collabnet/teamforge-installer/8.0.0.1
- ./install.sh -r -I -V
-
Run the TeamForge post installation script. For
more information, see post-install.py.
-
Use the following command to run the
post-install.py script.
- /opt/collabnet/teamforge/runtime/scripts/post-install.py
Note: Enter the 'gitadmin' user name and password when prompted.
Do the following on the application server - my.app.host
-
Apply the finishing touches and make sure everything is running smoothly after
upgrading to TeamForge
8.0.
Important: Do not delete the teamforge-installer/8.0.0.1
directory. You will need it for future maintenance and upgrades.
-
Log into your site as the administrator.
-
If your site has custom branding, verify that your branding changes
still work as intended.
See Customize anything on your site.
-
Let your site's users know they've been upgraded.
See Communicate with all site users at once.
-
Remove the backup files after the TeamForge site is up and running as
expected.
-
Remove the repository and the file system backup from the
/tmp/backup_dir directory.
-
Remove the PostgreSQL
9.2 database dump and the file system from the
/var/lib/pgsql/9.2/backups and /var/lib/pgsql/9.2/data directories respectively.
Note: After upgrade, it takes some time for the publishing repositories to get
created for projects imported from other TeamForge sites.
- ETL initial load jobs: To run ETL initial load jobs, see ETL initial load jobs.
- Review Board: To upgrade Review Board, see Upgrade Review Board.
- SELinux: To run TeamForge in SElinux
enabled mode, see Set up SELinux.
- 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.
- Configure X-Frame-Options: Setting the
X-Frame-Options header to ALLOW-FROM
http://forge.collab.net overrides the default
Jenkins
configuration header settings and displays the page in an iframe on the
specified origin. For more infomration, see Unable to embed Jenkins page into an iframe, How to fix it?.