Prepare a mapping file is required for using it to rename the IBM® Engineering Lifecycle Management instance at the time of actual rename while the servers are online.
About this task
There are several steps that you need to take before you rename the server. It includes preparing
and reviewing the mapping file that you use to perform the rename operation. The mapping file lists
the existing source URLs and the renamed target URLs in your deployment. These include the URLs for
the Jazz® Team Server, the Engineering Lifecycle Management applications, and other impacted
applications. See Mapping a file for server rename for sample topology diagrams and mapping
files.
Note: Make sure to perform the following steps on the original Jazz Team Server (production or
source) with completed setup and that the instance is running without any error.
Procedure
- Perform the following steps in Jazz Team Server application pod in the production or
source instance and verify that the applications have been registered correctly with the
server.
- Log in to the Administration page of the Jazz Team Server.
Point your web browser to https://hostname:port/jts/admin.
- Go to Server tab and in the
Configuration section, click Registered
Applications.
- Verify that all your applications are registered and for further details, refer to
Registering applications with Jazz Team Server
- Access the Jazz Team Server application pod terminal on directory
/elm/server. For more information, see Accessing application pod terminal
- Use the repotools-jts -generateURLMappings command to generate an
initial mapping file to use as a template for further editing. If you have already run the command,
or the file exists, add the overwrite=true parameter. Save the generated file
to persistent volume location. i.e. elm/backup.
cd /elm/server
./repotools-jts.sh -generateURLMappings toFile=/elm/backup/mappings.txt additionalURLFile=/elm/backup/additionalurl.txt \
unrenameableURLFile=/elm/backup/unrenameableurls.txt \
adminUserId=<adminId> adminPassword=<adminPassword> \
repositoryURL=https://source.example.org/jts
The output of this command is a mapping file that lists the existing source public URL, a default
target URL for the Jazz Team Server and each Engineering Lifecycle Management applications CCM,
DCC, GC, LQE, QM, ENI, RM, and RB registered with the Jazz Team Server.
In addition, a second file is also created that contains a list of all the URLs that needs to be
mapped or that reference third-party integrations. You can add these URLs to the mappings file. For
simple deployments, it is not uncommon for this file to contain no additional URLs. If you include
the additionalURLFile=additionalurl.txt parameter, you can specify a different
name for this file. For further details about this parameter, see Repository tools command to generate the server rename mappings file.
Verify that there are no errors in the log file
at /elm/server/repotools-jts_generateURLMappings.log
- Review and edit the generated mapping file carefully including the typos in the host
name, port or root contexts. Some typos are non-detectable by the server rename tools and can lead
to a mal-functioning. For more information on structure of the mapping file, see Mapping a file for server rename.
- Verify that a source-target pair exists for every application being
renamed.
- Edit the target=urls for the entries that you want to rename to
be the correct targets.
- Using a
#
, comment out the source-> target pair of any URLs that you do not
want to be renamed.
- Review the list of affected URLs. Although the command searches for all known URLs in
the deployment, it is possible that some may be missed. If any of these affected URLs needs to be
mapped, uncomment the source/target pair for the affected URL and provide the new target
URL.
- Review the
additionalurls file. For details, see Repository tools command to generate the server rename mappings file.
Note: If any configuration changes are made to Engineering Lifecycle Management deployment before
proceeding to the actual rename, including registering additional applications, you need to
regenerate the mapping file.
- Use the
repotools-jts -verifyURLMappings command to verify the mapping
file. ./repotools-jts.sh -verifyURLMappings mappingFile=/elm/backup/mappings.txt repositoryURL=<serverURL> adminUserId=<adminId> adminPassword=<adminPassword>
For
further details about the types of verifications that this command performs, see
Repository tools command to verify a mapping file.