In this procedure, we'll assume that you are upgrading on the same server where your
existing TeamForge
8.0
site is
running.
Important: TeamForge
8.1 supports
RHEL/CentOS 7.1. 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
-
Uninstall the TeamForge CLI add-on.
- cd
/opt/collabnet/teamforge/add-ons/teamforge_cli_server
- ./install --uninstall
- yum erase teamforge_cli_server
-
Stop TeamForge.
- /etc/init.d/collabnet
stop all
-
No backup is required for same hardware upgrades. However, you can create a
backup as a precaution. See Back up and restore CollabNet TeamForge data to
learn more about backing up TeamForge database and file system.
-
Upgrade the operating system packages.
-
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.
-
If the TeamForge server has SELinux
enabled, run it in 'Permissive' mode temporarily while installing or upgrading
TeamForge.
-
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.
See Set up SELinux to have TeamForge run in SELinux mode after
completing the installation or upgrade.
-
Important: Do this only if you are upgrading TeamForge on RHEL/CentOS
6.6.
Delete the python-crypto package.
-
Configure your TeamForge
8.1 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.3 stop
-
Install the following application packages.
-
TeamForge: To install the
TeamForge application
packages run the following command:
- yum
install
teamforge
collabnet-binary
-
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.1.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_CHAIN_FILE
Note: The
SSL_CERT_FILE and SSL_KEY_FILE tokens need an absolute path.
The
SSL_CHAIN_FILE
token
is
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.
-
Ensure to set the token SELINUX_SETUP=true.
-
Important: This step is required if you want Git notification
emails.
Update the JAMES_ACCEPTED_RELAYS site-options token
with the Git server's IP address. See JAMES_ACCEPTED_RELAYS for more information.
JAMES_ACCEPTED_RELAYS=127.0.0.1,{__CEE_DOMAIN__},<The IP address of the Git server>
-
Save the site-options.conf file.
-
As JDK is upgraded to 1.8.0_45, move
the existing runtime directory before create-runtime.
- cd /opt/collabnet/teamforge/
- mv runtime/ runtime_old
-
Recreate the runtime environment.
- cd /opt/collabnet/teamforge-installer/8.1.0.1
- ./install.sh -r -I -V
-
Edit the
/opt/collabnet/teamforge/runtime/james/apps/james/SAR-INF/config.xml
file and comment out the <authorizedAddresses> node.
For example:
<!-- <authorizedAddresses>127.0.0.0/8</authorizedAddresses> -->
-
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.1.
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.1
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.
-
Important: This step is required if and only if you have reporting
enabled and are upgrading to TeamForge 8.1.
If you have reporting enabled, it is more likely that you would have run
initial load jobs and set up incremental load jobs on your site. See etl-client.py for more information on initial and
incremental load jobs. TeamForge 8.1 and later have custom-defined tracker
fields included in the datamart.
-
Run the following commands assuming you have tracker incremental load
job set up on your site and that you just want to have your datamart
loaded with prospective updates to custom-defined tracker fields. Your
incremental load job would fail if the following commands are not
run.
- cd
/opt/collabnet/teamforge/runtime/scripts
- ./etl-client.py –a
- ./etl-client.py –r LoadFlexFields
Going forward, the tracker incremental load job loads all
prospective changes to custom-defined tracker fields to your
datamart.
-
On the other hand, you can bootstrap your datamart and manually run the
initial load jobs again, so that your datamart is loaded with data from
historical custom-defined tracker fields, while at the same time is
ready for prospective updates as well.
CAUTION:
However, keep in mind you are bootstrapping your
datamart (reporting DB) and you may have to run the tracker initial
load job anyway, which may take a while to complete depending on
your volume of data during which your reporting would not be
available. You may also lose all the data related to
UserLoggedInActivity. Run the following commands if you understand
the situation at hand.
- /etc/init.d/collabnet stop
- /opt/collabnet/teamforge/runtime/scripts/bootstrap-reporting-data.py
- /etc/init.d/collabnet start
- /opt/collabnet/teamforge/runtime/scripts/etl-client.py
–r SCMCommitActivityJob
- /opt/collabnet/teamforge/runtime/scripts/etl-client.py
–r TrackerInitialJob
-
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
-
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.
-
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.
-
Important: Do this only if you are upgrading TeamForge on RHEL/CentOS
6.6.
Delete the python-crypto package.
-
Configure your TeamForge
8.1 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.
-
As JDK is upgraded to 1.8.0_45, move
the existing runtime directory before create-runtime.
- cd /opt/collabnet/teamforge/
- mv runtime/ runtime_old
-
Recreate the runtime environment.
- cd /opt/collabnet/teamforge-installer/8.1.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.
-
Important: This step is required if you want Git notification
emails.
Edit the /opt/collabnet/gerrit/etc/gerrit.config file and
update the 'smtpServer' property with the TeamForge application server's host
name.
For
example:[sendemail]
smtpServer = <TeamForge application server host name>
-
Restart gerrit.
- /etc/init.d/collabnet stop
gerrit
- /etc/init.d/collabnet start
gerrit
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.1.
Important: Do not delete the teamforge-installer/8.1.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, if any, after the TeamForge site is up and running as
expected. Remove the repository and the file system backup from the
/tmp/backup_dir directory.
Note: After upgrade, it takes some time for the publishing repositories to get
created for projects imported from other TeamForge sites.