Standard Collaborative Lifecycle Management topologies

Authors: TimFeeney DavidChadwick GrantCovell, VaughnRokosz
Build basis: CLM 2011, Rational Team Concert 3.0.1, Rational Quality Manager 3.0.1, Rational Requirements Composer 3.0.1

Note: This is just a formatting example and you should refer to the topology topics in the Deployment planning and design section for current guidance.

Many of our customers implement Collaborative Lifecycle Management (CLM) solutions to provide a complete tool infrastructure for their software or systems development organizations. One of the most frequently asked questions is how should they deploy the full CLM solution so that it will perform well, run robustly, and evolve without restriction. Customers have asked us about possible deployment strategies because they must balance two sometimes opposing forces: the desire to build what's right for their organizations and the desire to stay within the mainstream of CLM product evolution so they can easily and quickly reap the benefits of the new technology.

The CLM system requirements permit a wide range of supported middleware platforms and topologies upon which to host the solution. The CLM products run on several commercial databases and two of the most popular web application servers. It is also possible and recommended to introduce reverse proxy servers in front of either a centralized or a distributed set of web application servers.

In order to simplify the wide range of choices, this article outlines several standard topologies which are the expected and most frequently chosen deployment patterns that we have seen over the past several years. Keeping in mind the continual evolution of the CLM solution, these topologies can be used with the CLM 2011 product versions. Additionally, these standard topologies contain the direction for future support of high-availability clustered configurations.

By publishing these standard topologies, we seek to represent tried and true examples of how customers have successfully deployed the CLM solution. Additionally, our system testing organization uses these topologies to perform deep “customer simulation” testing which includes installation, upgrade, functional, performance, and robustness testing. By adhering closely to one of these standard topologies, customers will have an easier time characterizing their deployment in the event of an interaction with IBM product support. These topologies become a “short hand” that can be used whenever a CLM deployment is discussed. For example, when we discuss the system performance testing results or we write about a high availability configuration, we can now reference the appropriate standard topology.

Several different teams came together to define and document these standard topologies. We are the teams which design and execute system, performance and reliability testing, the teams which develop and support the CLM products, and the teams which work directly with customers to design and implement CLM solutions at customer locations worldwide.

Key Dimensions

The CLM applications and the Jazz Team Server (JTS) can be installed on shared application servers, or distributed across multiple application servers for improved scalability. Although this flexibility allows you to design a topology to best fit your needs, that flexibility also adds complexity to the planning process. As a result, it is important to plan your deployment topology carefully, as changing your topology later can be very complex and require substantial application downtime. We've divided the potential deployment topologies into three basic dimensions: Evaluation, Department, and Enterprise.

Evaluation Topologies

An evaluation topology is useful for demonstration or training deployments only. In this type of installation, all the application and database software is installed on the same server. It is not recommended that you start with this topology and then attempt to expand it into a Departmental or Enterprise topology. If you have any intent to create production level artifacts, you should consider either a Departmental or Enterprise topology.

Departmental Topologies

Departmental topologies are useful for small team and single-server deployments. Use a stable, company-approved host name and register it with the domain name server (DNS) to keep the URLs of the data stable. In this type of installation, databases are installed on a dedicated database server, and one or more other applications are installed on an application server. A key advantage of the departmental topologies is that they require less hardware and are easier to deploy initially. These topologies are best for smaller projects and smaller-sized teams. Crucially, if you are fairly certain that your deployment will likely expand, you should consider starting with an Enterprise topology.

Enterprise Topologies

Enterprise topologies are useful for production or medium- to large-sized teams and multiple server (or distributed) deployments. Use a stable, company-approved host name and register it with the domain name server (DNS) to keep the URLs of the data stable. Enterprise topologies distribute the CLM applications Jazz Team Server (JTS), the database software, etc, and are more flexible. These topologies enable you to incrementally adopt applications into your deployment and configure them to use the same JTS. In this type of installation, databases are installed on a single database server and each application is usually installed on its own dedicated application server. In addition, to connect multiple application instances to a shared JTS, the instances must all be authenticated from the same authentication realm and thus share the same set of users.

Metadata Variables

The following variables describe the key characteristics which provide variation in the typical CLM deployment. These along with the previously mentioned key dimensions are used to distinguish the standard topologies.

1. Operating system (Windows, AIX, Linux, z/OS, etc.)
2. Database management system (DB2, Oracle, SQL Server, Derby)
3. Application Server (Tomcat, Websphere Application Server (WAS))
4. License management systems (Evaluation, Floating, Token)
5. User management system (Tomcat, Active Directory, Tivoli Directory Server, etc.)
6. Other technologies such as proxy servers, virtual host names, WAN accelerators

Though integrations are an important dimension, they are not addressed in this article or included in the referenced topologies. Additionally, you should note that specific hardware architectures and/or virtualization technologies are not included among these variables. Hardware architecture and virtualization technologies are very important considerations when defining a deployment architecture, however, more from a performance and sizing perspective. Recommended hardware architectures against these standard topologies will be discussed in a follow-on article.

Catalog of Topologies

Based on several sources of input from experiences with customer environments, using the previously mentioned key dimensions and metadata variables, the following standard topologies were identified. These expand on the installation topologies referenced in the CLM 3.0.1 InfoCenter.

• Evaluation (V)
  • (V1) Evaluation - Single server / Tomcat / Derby
• Departmental (D)
  • (D1) Departmental - Single application server, Windows / DB2
• Enterprise (E)
  • (E1) Enterprise - Distributed / Linux / DB2
  • (E2) Enterprise - Distributed / all Microsoft
  • (E3) Enterprise - Clustered / Linux / Oracle
  • (E4) Enterprise - Clustered / AIX / all IBM
  • (E5) Enterprise - z/OS / Linux on System z / DB2
  • (E6) Enterprise - z/OS / DB2

In the following catalog, each topology will be briefly described and depicted. The metadata variables defining each will be noted.

Evaluation

(V1) Evaluation - Single server / Tomcat / Derby

This is a simple, single server topology whose primary use is supporting evaluations, demonstrations, proofs of concept and training. Given the use of Derby and Tomcat, it can be stood up very quickly, especially with the upcoming express install feature.

Metadata Variable	Value
Database Management System	Derby
Other technologies	None
Application Server	Tomcat
User Management System	Tomcat
License Management System	Trial
Operating System	Windows

Departmental

(D1) Departmental - Single application server, Windows / DB2

This departmental topology uses Windows for the server operating systems. The CLM applications and JTS are deployed to a single WAS instance. Virtual host names are used to ensure public URI stability. DB2 is used for the databases and is hosted on a separate server. Rational Reporting for Development Intelligence (RRDI) is included in this department configuration but is hosted on a separate server and WAS instance for performance reasons. Finally, licenses are served by a floating license server and Active Directory provides the Lightweight Directory Access Protocol (LDAP) based user management.

Metadata Variable	Value
Operating System	Windows
Database Management System	DB2
Application Server	WAS
License Management System	Floating
User Management System	Active Directory
Other technologies	Virtual host names

...

Related topics: Deployment planning, Deployment planning and design

External Links:

• System Requirements for Rational Team Concert 3.0.1.x, Rational Quality Manager 3.0.1.x, Rational Requirements Composer 3.0.1.x (and Jazz Foundation 3.0.1.x)
• installation topologies

Additional contributors: JoePesot