サーバー名前変更のマッピング・ファイル

このトピックでは、generateURLMappings コマンドによって生成されるマッピング・ファイルの構造を示し、ご使用のデプロイメント用にマッピング・ファイルを編集する方法について説明します。

マッピング・ファイルの生成の準備ができたら、マッピング・ファイルの準備の手順に従います。

マッピング・ファイルには、Jazz Team Server のソースと ターゲットの URL のペア、登録されているアプリケーション、およびアプリケーションが提供する その他の URL が含まれています。URL は以下の 2 つのタイプに分類されます。

名前変更の一部である URL ペアには、Jazz Team Server のドメイン下のすべてが含まれます。 これには、Jazz Team Server のパブリック URL、アプリケーションのパブリック URL、およびアプリケーションが提供するその他の URL が含まれます。

影響を受ける URL には、このトポロジーと対話するが、この Jazz Team Server のドメイン下にはないその他のすべてのシステムが含まれます。別の Jazz Team Server に登録されているが、この Jazz Team Server のフレンドである relm アプリケーションは、影響を受ける URL になります。Rational® ClearQuest® などの外部統合も、影響を受ける URL です。

サンプル・マッピング・ファイルの説明

# JTS
source=https://relmhost.example.org:9443/jts
target=https://relmhost2.example.org:9443/jts
#Additional Urls included in rename by relmhost.example.org:9443/jts
# ADMIN
source=https://relmhost.example.org:9443/admin
target=https://relmhost2.example.org:9443/admin
#(relm Help URL)
source=https://relmhost.example.org:9443/relmhelp
target=https://relmhost2.example.org:9443/relmhelp
# RELM
source=https://relmhost.example.org:9443/relm
target=https://relmhost2.example.org:9443/relm
# SPARQL
source=https://relmhost.example.org:9443/sparql
target=https://relmhost2.example.org:9443/sparql

#The following list of URLs represent external servers that integrate 
with this Jazz Team Server or with applications registered to it.

#Do not uncomment these lines as they are for reference purposes only.
# Friend Entry
#source=https://friend1.example.org:9443/jts/rootservices 
#target=https://friend1.example.org:9443/jts/rootservices 
#source=https://cqconnector.example.org:9084/cqconnector/gateway
#target=https://cqconnector.example.org:9084/cqconnector/gateway

生成されるマッピング・ファイルは、importURLMappings の実行前に編集する必要があるテンプレートです。トポロジー内のすべてのシステムが正しく名前変更されるようにするためには、マッピング・ファイル内のすべてを理解することが重要です。ファイルの上の方のセクションには、名前変更の一部である URL ペアが含まれます。この例では、Jazz Team Server およびその登録されているすべてのアプリケーションのパブリック URL の URL ペアを参照することができます。また、アプリケーションが提供する URL ペアも参照することができます。

これらの各 URL を確認して、変更されるものを判別します。新しい値を使用して、名前変更されるソース URL のターゲットを更新します。特定のソース URL を名前変更しない場合は、# を使用して、そのペアをコメント化します。

# JTS
#source=https://relmhost.example.org:9443/jts
#target=https://relmhost2.example.org:9443/jts

マッピング・ファイルの下の方には、コメント化された影響を受ける URL のリストが含まれています。 これらの URL はこの名前変更の一部ではありませんが、変更される URL によって影響を受けます。これらの URL は単に参照用なので、実動 URL をマスクアウトする必要がない限り、これらの URL はコメント化されたままにしてください。

ステージング環境の場合は、ステージング・サーバーと実動サーバー間のクロス・リンクがないようにするために、影響を受ける URL を必ずマスクアウトする必要があります。 詳しくは、下記を参照してください。

実動データを保護するためのダミー・マッピング

影響を受ける URL をマスクアウトする必要がある場合は、ソース/ターゲット・ペアをアンコメントしてダミー・ターゲットを指定します。

ステージング環境をセットアップする場合は、マッピング・ファイル内のすべての影響を受ける URL について、ダミー・マッピングを作成する必要があります。 影響を受ける URL には、 このデプロイメントまたは外部サーバーのフレンドであるその他の relm アプリケーションが含まれる可能性があります。フレンド項目について、フレンドのパブリック URL のダミー・マッピングを作成します。

例えば、フレンド項目 URL が https://friendhost.example.org:9443/jts/rootservices の場合は、通常、パブリック URL は https://friendhost.example.org:9443/jts になります。 マッピング・ファイルの下部に URL ペアを追加して、ターゲットを偽のホスト名に設定することで、この URL をマスクアウトします。ダミー・ターゲット・ホスト名を選択する前に、そのホストにアクセスできないことを確認してください。

# Friend
source=https://friendhost.example.org:9443/jts
target=https://dummyfriendhost.example.org:9443/jts

フレンド項目ではない、すべての影響を受ける URL について、マッピング・ファイルの下部に、以下の URL ペアを追加します。

source=https://externalserver.example.org:9555/
target=https://dummyhost.example.org:9555/

同じターゲットを複数回使用することは許可されません。 複数のフレンド項目がある場合は、dummyhost2、dummyhost3、…を使用します。 Jazz Team Server およびアプリケーションのすべてが同じホストおよびポート上にあるシングル・サーバー・デプロイメントの場合は、以下に示すように、簡易マッピングを使用できます。

簡易マッピング・ファイルの使用

プロトコル、ホスト、ドメイン、およびポートがすべての URL で共通である単純なトポロジーの場合は、マッピング・ファイルを小さくして、1 つのソースとターゲットの項目のみが含まれるようにすることができます。例えば、relmhost.example.org に オールインワン・デプロイメントがあり、すべてが newhost.example.org を使用するように名前変更する場合は、 生成されたマッピング・ファイルを編集して、 以下の URL のみが含まれるようにすることができます。

注: relmhost.example.org から newhost.example.org への 簡易マッピングでは、Jazz Team Server および Jazz アプリケーションを 名前変更するだけです。その他の Rational およびサード・パーティーの統合は名前変更しません。ご使用のシナリオがサポートされるかどうかを判別するため、およびトポロジー内のすべてが正しくマップされるようにするために、必ず、generateURLMappings を実行する必要があります。
source=https://relmhost.example.org:9443
target=https://newhost.example.org:9443
重要: 後日デプロイメントを配布する予定の場合は、簡易マッピング・ファイルを使用しないでください。

デフォルト・ポートを使用した URL

ソース URL のいずれかがデフォルト・ポートを使用していて、デフォルト・ポート番号が明示的に含まれていない場合は、2 つのマッピング・セット (デフォルト・ポートのものと、デフォルト・ポートがないもの) が必要になります。generateURLMappings コマンドは、追加マッピングを自動的に生成します。デフォルト・ポートは、https では 443 で、http では 80 です。

例えば、https://relmhost.example.org/relm で実行されている既存の RELM があるとします。この場合、RELM は、 デフォルト・ポートを使用して (アプリケーション・サーバーのポートを構成するか、 デフォルト・ポートで実行されているリバース・プロキシー http サーバーを使用して)、 サーバーにデプロイされています。RELM 内で、ポートが URL に明示的に含まれているリソースへの URL のリンクが保管されている可能性もあります。 例えば、以下のようなものです。

https://relmhost.example.org:443/resource/...

URL がどちらの形式でも保管されている可能性があるため、それぞれのマッピングが必要になります。例えば、relmhost.example.orgnewhost.example.org に名前変更する場合を考えます。この場合、名前変更を実行するには、以下の両方のマッピングが必要になります。ペアは、generateURLMappings によって自動的に生成されます。

source=https://relmhost.example.org/relm
target=https://newhost.example.org/relm

source=https://relmhost.example.org:443/relm
target=https://newhost.example.org:443/relm

大/小文字の区別

URL はすべて小文字で指定することが推奨されています。URL では大/小文字の区別があります。

マッピング・ファイル生成時のエラー

関係する処理の量が原因で、エラーが発生する可能性があります。エラーの中には、サーバーの始動前にマッピング・ファイルを生成しようとした場合や正しくないログイン資格情報を使用した場合など、明確に示されるものもあります。一方、あまり明らかではないエラーもあります。サーバー名前変更のエラーについて詳しくは、サーバー名前変更のトラブルシューティングを参照してください。

マッピング・ファイルの検証

マッピング・ファイルの生成と編集が終わった後は、必ず repotools-jts -verifyURLMappings コマンドを実行してマッピングに欠落がないことを確認し、その他のいくつかの検証を実行してください。該当の URL をマップする必要がない場合には、欠落マッピングを無視できる場合もあります。詳しくは、マッピング・ファイルを検証するためのリポジトリー・ツール・コマンドを参照してください。


フィードバック