Topologies and mapping files for moving a production deployment to another location

This topic shows sample topology diagrams and mapping files for using server rename to perform a full production rename. In this case, one or more systems in a production deployment are moving to a new location. This could be an actual physical move to new hardware where your source and target systems are different. As an alternative, it could involve changing the hostname or context root of a server where the source and target are the same. This example, which we call a rename in place, requires separate installations on the same system.

When planning a full production rename, it is critical to ensure that all data is backed up prior to the rename and that the old IBM® Engineering Lifecycle Management (ELM) servers are inaccessible from the new ELM servers to avoid data contamination. Be sure to consider any additional ELM servers, or any integrated servers, that might be connected to the production server. For information about currently supported integrations, see Impact of server rename on integrated products and the Jazz.net Deployment wiki.

It is also critical that you plan the rename carefully to minimize outage time for users. All of the planning can be done while the production server is still up and running.

Before attempting a rename, ensure that the scenario is supported. See Supported scenarios for using server rename for details.

Starting Point 1 - Single-server ELM deployment

The following topology diagram shows a nondistributed ELM deployment prior to a rename. In this example, the Jazz™ Team Server and the ELM applications all reside on the same host system.

Single-server ELM production deployment

Copying the single-server production deployment

To copy the production environment, follow the instructions at Moving a pilot or full production deployment by using server rename. The following diagram shows what the topology would look like after the rename.

Renamed single-server production environment

After the mapping file is generated and edited, it should look like this.

#/jts
source=https://production.example.org:9443/jts
target=https://renamedproduction.example.org:9443/jts
#Additional Urls included in rename by /jts
#(CLM Help URL)
source=https://production.example.org:9443/clmhelp
target=https://renamedproduction.example.org:9443/clmhelp

#/ccm
source=https://production.example.org:9443/ccm
target=https://renamedproduction.example.org:9443/ccm

#/relm
source=https://production.example.org:9443/relm
target=https://renamedproduction.example.org:9443/relm

#/dcc
source=https://production.example.org:9443/dcc
target=https://renamedproduction.example.org:9443/dcc

#/gc
source=https://production.example.org:9443/gc
target=https://renamedproduction.example.org:9443/gc

#/lqe
source=https://production.example.org:9443/lqe
target=https://renamedproduction.example.org:9443/lqe

#/ldx
source=https://production.example.org:9443/ldx
target=https://renamedproduction.example.org:9443/ldx

#/rs
source=https://production.example.org:9443/rs
target=https://renamedproduction.example.org:9443/rs

#/qm
source=https://production.example.org:9443/qm
target=https://renamedproduction.example.org:9443/qm

#/rm
source=https://production.example.org:9443/rm
target=https://renamedproduction.example.org:9443/rm
#Additional Urls included in rename by /rm
#(The address of the application used to generate images for graphical artifacts.)
source=https://production.example.org:9443/converter/htmlgen
target=https://renamedproduction.example.org:9443/converter/htmlgen

It is recommended that you edit your hosts file to redirect the source production URL to a false IP address, as follows:

# 10.10.10.10 refers to an IP address that does not host a clm application.
10.10.10.10   production.example.org

Starting Point 2 - Distributed production deployment with integrations

The following topology diagram shows a distributed deployment before a rename, with the Jazz Team Server and each application running on a separate host. This deployment includes an integration with Rational ClearQuest.

Distributed production deployment before a rename

Renaming the distributed production deployment

In this scenario, you move the Jazz Team Server and each ELM application to new servers. Rational ClearQuest does not move. For instructions about distributed deployments, see Step 4 in the topic about moving a production deployment to another location. The following diagram shows what the topology looks like after the rename:

Renamed distributed production deployment

After the mapping file is generated and edited, it should look like this.

#/jts
source=https://jts.production.example.org:9443/jts
target=https://jts.renamedproduction.example.org:9443/jts
#Additional Urls included in rename by /jts
#(CLM Help URL)
source=https://jts.production.example.org:9443/clmhelp
target=https://jts.renamedproduction.example.org:9443/clmhelp
#This URL was also contributed by "/ccm"
#This URL was also contributed by "/qm"
#This URL was also contributed by "/rm"
#This URL was also contributed by "/dcc"
#This URL was also contributed by "/gc"
#This URL was also contributed by "/relm"

#/ccm
source=https://ccm.production.example.org:9443/ccm
target=https://ccm.renamedproduction.example.org:9443/ccm

#/qm
source=https://qm.production.example.org:9443/qm
target=https://qm.renamedproduction.example.org:9443/qm

#/relm
source=https://relm.production.example.org:9443/relm
target=https://relm.renamedproduction.example.org:9443/relm

#/dcc
source=https://dcc.production.example.org:9443/dcc
target=https://dcc.renamedproduction.example.org:9443/dcc

#/gc
source=https://gc.production.example.org:9443/gc
target=https://gc.renamedproduction.example.org:9443/gc

#/rm
source=https://rm.production.example.org:9443/rm
target=https://rm.renamedproduction.example.org:9443/rm
#Additional Urls included in rename by /rm
#(The address of the application used to generate images for graphical artifacts.)
source=https://rm.production.example.org:9443/converter/htmlgen
target=https://rm.renamedproduction.example.org:9443/converter/htmlgen

#The following list of URLs represent external servers that integrate with this Jazz Team Server or with applications registered to it.
#source=https://cqsynchhost.production.example.org:8444/cqconnector/gateway
#target=https://cqsynchhost.production.example.org:8444/cqconnector/gateway

Because the ClearQuest integrated servers have not moved, the source to target mappings are left commented out.

It is recommended that you edit your hosts file to redirect the source production URLs to a false IP address, as follows:

# 10.10.10.10 refers to an IP address that does not host a clm application.
10.10.10.10 jts.production.example.org
10.10.10.10 ccm.production.example.org
10.10.10.10 qm.production.example.org
10.10.10.10 rm.production.example.org
10.10.10.10 relm.production.example.org
10.10.10.10 dcc.production.example.org
10.10.10.10 gc.production.example.org

Moving a single application in a distributed deployment to a new server

In this scenario, only the CCM application in a distributed ELM deployment is moving to a new server. However, a rename must be performed on the entire deployment because there are cross-linked URLs in the Jazz Team Server and all of the applications. For instructions about distributed deployments, see Moving a pilot or full production deployment by using server rename. The following diagram shows what the topology looks like after the rename:

Single application renamed in a distributed production deployment

After the mapping file is generated and edited, it should look like the example below.

Note: All of the source/target pairs are commented out, except for the one application that is being renamed - CCM.
#/jts
#source=https://jts.production.example.org:9443/jts
#target=https://jts.production.example.org:9443/jts
#Additional Urls included in rename by /jts
#(CLM Help URL)
#source=https://jts.production.example.org:9443/clmhelp
#target=https://jts.production.example.org:9443/clmhelp
#This URL was also contributed by "/ccm"
#This URL was also contributed by "/qm"
#This URL was also contributed by "/rm"
#This URL was also contributed by "/relm"
#This URL was also contributed by "/dcc"
#This URL was also contributed by "/gc"

#/ccm
source=https://ccm.production.example.org:9443/ccm
target=https://ccm.renamedproduction.example.org:9443/ccm

#/qm
#source=https://qm.production.example.org:9443/qm
#target=https://qm.production.example.org:9443/qm

#/relm
#source=https://relm.production.example.org:9443/relm
#target=https://relm.production.example.org:9443/relm

#/dcc
#source=https://dcc.production.example.org:9443/dcc
#target=https://dcc.production.example.org:9443/dcc

#/gc
#source=https://gc.production.example.org:9443/gc
#target=https://gc.production.example.org:9443/gc

#/rm
#source=https://rm.production.example.org:9443/rm
#target=https://rm.production.example.org:9443/rm
#Additional Urls included in rename by /rm
#(The address of the application used to generate images for graphical artifacts.)
#source=https://rm.production.example.org:9443/converter/htmlgen
#target=https://rm.production.example.org:9443/converter/htmlgen

#The following list of URLs represent external servers that integrate with this Jazz Team Server or with applications registered to it.
#source=https://cqsynchhost.production.example.org:8444/cqconnector/gateway
#target=https://cqsynchhost.production.example.org:8444/cqconnector/gateway

As with the previous examples, it is recommended that you edit your hosts file to redirect the source CCM production URL to a false IP address.

# 10.10.10.10 refers to an IP address that does not host a clm application.
10.10.10.10   ccm.production.example.org

Starting Point 3 - Two distributed deployments that are linked together

In complex production topologies, it is possible to have multiple linked ELM deployments. Because the deployments are linked, URLs for both deployments reside in each database. If only one ELM deployment is moving, as depicted in this diagram, you only need to prepare a mapping file for the Jazz Team Server that is moving. However, you must perform the rename by running the repotools-jts - importURLMappings command on all Jazz Team Server servers. If both ELM deployments are moving, you must prepare a mapping file that includes both deployments. You create a single mapping file by applying the contents of one Jazz Team Server mappings file to another. After that you run the repotools-jts - importURLMappings command with the combined mappings for both Jazz Team Server servers.

The following topology diagram shows two distributed deployments that are linked together, with the Jazz Team Server and each application running on a separate host. There are no integrations in this example.

Multiple linked deployments

Renaming one of the linked deployments

In this scenario, both deployments must be shutdown before the rename. The rename must be performed on both deployments using the mapping file for deployment 1. For additional details about linked deployments, see Step 11 in the topic about moving a production deployment to another location. The following diagram shows what the topology looks like after the rename:

Renaming one of the linked deployments

After the mapping file is generated and edited, it should look like the example below.

Note: All of the source/target pairs for deployment 2 are commented out.
#/jts
source=https://jts1.production.example.org:9443/jts
target=https://jts1.renamedproduction.example.org:9443/jts
#Additional Urls included in rename by /jts
#(CLM Help URL)
source=https://jts1.production.example.org:9443/clmhelp
target=https://jts1.renamedproduction.example.org:9443/clmhelp

#/ccm
source=https://ccm1.production.example.org:9443/ccm
target=https://ccm1.renamedproduction.example.org:9443/ccm

#/qm
source=https://qm1.production.example.org:9443/qm
target=https://qm1.renamedproduction.example.org:9443/qm

#/rm
source=https://rm1.production.example.org:9443/rm
target=https://rm1.renamedproduction.example.org:9443/rm
#Additional Urls included in rename by /rm
#(The address of the application used to generate images for graphical artifacts.)
source=https://rm1.production.example.org:9443/converter/htmlgen
target=https://rm1.renamedproduction.example.org:9443/converter/htmlgen

#The following list of URLs represent external servers that integrate with this Jazz Team Server or with applications registered to it.
#/rm2
#source=https://rm2.production.example.org:9443/rm
#source=https://rm2.production.example.org:9443/rm

#/ccm2
#source=https://ccm2.production.example.org:9443/ccm
#source=https://ccm2.production.example.org:9443/ccm

#/qm2
#source=https://qm2.production.example.org:9443/qm
#source=https://qm2.production.example.org:9443/qm

#/jts2
#source=https://jts2.production.example.org:9443/jts
#source=https://jts2.production.example.org:9443/jts

As with the previous examples, it is recommended that you edit your hosts file to redirect the URLs of the deployment that is being renamed.

# 10.10.10.10 refers to an IP address that does not host a clm application.
10.10.10.10   jts1.production.example.org
10.10.10.10   ccm1.production.example.org
10.10.10.10   qm1.production.example.org
10.10.10.10   rm1.production.example.org

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki