2.3.1 構成パターンテンプレートファイル
- 〈この項の構成〉
(1) 記述形式
構成パターンテンプレートファイルはXML形式で記述します。
サポートするXMLファイルの文字コードはUTF-8とします。XMLファイルにはXML宣言を記述し，XML宣言におけるencodingの値にUTF-8を指定してください。
タグは，「表2-13 構成パターンテンプレートファイルのXML記述文法」の順番に従って記述してください。従わない場合，エラーとなることがあります。
「表2-13 構成パターンテンプレートファイルのXML記述文法」に記載がない要素または属性を記述した場合，エラーとせずに該当の要素または属性を無視する場合があります。
(2) ファイル名
構成パターンテンプレートファイルのファイル名は任意です。
(3) 格納先ディレクトリ
構成パターンテンプレートファイルの格納先は任意です。
(4) 説明
構成パターンテンプレートファイルはPaaS利用者が作成するマスターイメージの元となるファイルになります。構成パターンテンプレートファイルが持つ情報一覧を次の表に示します。
|
項番 |
項目 |
説明 |
|
|---|---|---|---|
|
1 |
テンプレート名 |
テンプレートの名称を表します。ほかのテンプレートと重複しない名称を指定してください。 |
|
|
2 |
テンプレートパターン （テンプレート種別） |
テンプレートの種別を表します。ここでは，構成パターンテンプレートであることを指定します。 |
|
|
3 |
識別子 |
VirtualSystemCollection，またはAbstractSystemCollection※2を識別するための識別子を表します。 |
|
|
4 |
要素の説明 |
親要素の説明を表します。 |
|
|
5 |
要素の名前 |
親要素の名前を表します。 |
|
|
6 |
コンポーネントID |
構成パターン内の要素を識別するために使うIDです。要素間で重複してはいけません。 このIDは，マスターイメージ登録時にコンポーネントテンプレートとの組み合わせを指定する際に使用します。 |
|
|
7 |
デプロイ一時停止フラグ |
業務システムのデプロイ中に，VMデプロイ完了のタイミング（ミドルウェアのセットアップ前）でデプロイを一時停止するかどうか指定するフラグです。 |
|
|
8 |
ティア※1 |
構成パターン内の要素が持つティア（例：WEB，DBなど）を表します。 マスターイメージ登録時には，同じティアを持つコンポーネントテンプレートとの組み合わせを指定します。 |
|
|
9 |
セットアップ順序 |
ティアのセットアップ順序を表します。構成パターンテンプレート内で重複した値は指定できません。ただし，同一AbstractSystemCollection内の場合は，重複した値を指定することができます。 業務システムのデプロイ時には，ティアに対応づけられたミドルウェアのセットアップ※3を，この順序で実行します。サイジングによってコンポーネント内の仮想ホストが2台以上の構成になった場合，仮想ホスト間で同じセットアップ順序を持つミドルウェアは，並列にセットアップを行います。 セットアップ例を「図2-11 セットアップ例」で示します。 同一AbstractSystemCollection内に指定したAbstractSystemのうち，ミドルウェア識別子にhitachi.Cosminexusを指定したミドルウェアは同時にセットアップを行ないます。その場合のセットアップ順序は，同じ値を指定してください。異なる値を指定した場合，指定されているうちの最小の値が有効となります。 |
|
|
10 |
ティア種別 |
ミドルウェア識別子にhitachi.Cosminexusを指定した場合に仮想サーバマネジャのティアを表します。 |
|
|
11 |
接続先ネットワーク名 |
構成パターン内の要素が属するネットワーク名を表します。同じネットワーク名の要素は同一のネットワークに属することを表します。 |
|
|
12 |
UOC |
UOC種別 |
構成パターンテンプレートに登録するUOCの種別（サイジング）を表します。 |
|
UOCクラス名 |
UOCのパッケージ名を含むクラス名を表します。 |
||
|
jarファイル名 |
UOCのjarファイル名を表します。この値はcsdtmpregisterコマンドの-dオプションで指定するディレクトリからの相対パスを記述してください。 |
||
|
UOCパラメータ名 |
UOCへの入力パラメータの名前を表します。 |
||
|
UOCパラメータ値 |
UOCへの入力パラメータの値を表します。 |
||
|
13 |
仮想ネットワークデバイス用途 |
構成パターンが使用する仮想ネットワークデバイスの用途を表します。物理構成定義ファイルに記載する仮想ネットワークデバイスの用途の中から，構成パターンの仮想ネットワークデバイスとして使用する値を設定します。 |
|
|
14 |
デフォルトゲートウェイ設定フラグ |
接続先ネットワークに，デフォルトゲートウェイ情報を設定することを表します。 |
|
注 構成パターンテンプレートファイルに記述したUOCの情報は，マスターイメージ登録時にマスターイメージ定義ファイルに同様の記述をしてください。構成パターンテンプレートだけへの記述である場合，マスターイメージにUOC情報は反映されません。
注※1 構成パターンテンプレートとコンポーネントテンプレートを関連づけるための名前を示します。
注※2 AbstractSystemCollection要素間で重複した識別子を指定しないでください。
注※3 マスターイメージ定義ファイルにパッチ適用の設定がされている場合は，同一順序内でミドルウェアセットアップからミドルウェア更新まで続けて実施します。その際の処理順序は「図2-11 セットアップ例」の注意事項を参照してください。
|
|
![[図データ]](GRAPHICS/ZU020900.GIF)
- 注 マスターイメージ定義ファイルにパッチ適用の設定がされている場合の処理順序は次のとおりです。
-
-
(E)のセットアップ
-
(E)の更新
-
(F)のセットアップ
-
(F)の更新
-
(A)と(C)のセットアップ
-
(A)と(C)の更新
-
(B)と(D)のセットアップ
-
(B)と(D)の更新
-
(5) 指定項目
「表2-12 構成パターンテンプレートファイルのパラメータの指定方式」にテンプレート内の可変値のパラメータ指定方式を表し，「表2-13 構成パターンテンプレートファイルのXML記述文法」にXMLファイルの要素ごとの文法を示します。
|
項番 |
項目 |
形式 |
|---|---|---|
|
1 |
テンプレート名 |
英数字記号（”#”，”-“， “@”，”(“，”)”，” _”） 1〜32文字 |
|
2 |
UOCクラス名 |
英数字，ピリオド（.），ドル記号（$）およびアンダースコア（_）※1 |
|
3 |
jarファイル名 |
相対パス名。ただし，半角空白は指定できません。 1〜160文字 csdtmpregisterまたはcsdtmpupdateコマンドの-dオプションで指定したディレクトリからの相対パスの形式。jarファイルは-dオプションで指定したディレクトリ内に置く必要があります。 |
|
4 |
UOC種別 |
次の値を指定します。 サイジングUOC：sizing |
|
5 |
UOCパラメータ名 |
英数字記号 1〜32文字 |
|
6 |
UOCパラメータ値 |
文字列（日本語可） 1〜1024文字 |
|
7 |
識別子 |
英数字と_ 1〜32文字 |
|
8 |
要素の説明 |
文字列（日本語可） 1〜255文字 |
|
9 |
要素の名前 |
文字列（日本語可） 1〜255文字 |
|
10 |
コンポーネントID |
1〜65535の整数 |
|
11 |
デプロイ一時停止フラグ |
trueまたはfalse すべて小文字とします。 |
|
12 |
ティア |
英数字と_ 1〜32文字 |
|
13 |
セットアップ順序 |
1〜65535の整数 |
|
14 |
ティア種別 |
ミドルウェア識別子がhitachi.Cosminexusの場合に，仮想サーバマネジャのティアを表す次のどれかの値を指定します。
|
|
15 |
接続先ネットワーク名 （management，またはbusinessの接頭辞を付けて，ネットワークを表現します） |
英数字と_ （スペース） 1〜32文字 次のどちらかの形式（“management.”または“business.”を含めて10〜32文字の文字列）
コンポーネントテンプレートのItem(NIC)に指定した数以下にしてください。Item(NIC)よりも多く接続先ネットワーク名を指定した場合は，csdmiregisterコマンド実行時にエラー(KFUD23127-E)になります。 コンポーネントテンプレートのItem(NIC)に指定した数より少ない場合，差分のItem(NIC)は未使用として扱います。 |
|
16 |
仮想ネットワークデバイス用途 |
ASCII文字※2 1〜255バイト |
|
17 |
デフォルトゲートウェイ設定フラグ |
trueまたはfalse すべて小文字とします。 |
注※1 パッケージ名およびクラス名の先頭は英数字だけです。1〜1024文字で指定してください。
注※2 JP1/ITRMへの指定値です。指定時にチェックされるため，ISCMは使用文字の確認はしません。
|
項番 |
タグ名 |
属性 |
出現回数 |
説明 |
|||||
|---|---|---|---|---|---|---|---|---|---|
|
1 |
Envelope |
− |
1 |
ルート要素を表します。 |
|||||
|
2 |
xmlns |
1 |
"http://schemas.dmtf.org/ovf/envelope/1"を指定してください。 |
||||||
|
3 |
xmls:ovf |
1 |
"http://schemas.dmtf.org/ovf/envelope/1"を指定してください。 |
||||||
|
4 |
xmls:csd |
1 |
"http://www.hitachi.co.jp/soft/csd"を指定してください。 |
||||||
|
5 |
csd:type |
1 |
patternを指定します。構成パターンテンプレートであることを表します。 |
||||||
|
6 |
csd:name |
1 |
テンプレート名を指定します。 表2-20の項番7で設定した値と同じ値を設定してください。 |
||||||
|
7 |
References |
− |
1 |
空要素として指定 |
|||||
|
8 |
ProductSection（parameter） |
− |
0-1 |
構成パターンテンプレート特有のパラメータを指定します。 |
|||||
|
9 |
ovf:class |
1 |
parameterを指定します。構成パターンテンプレートのパラメータであることを表します。 |
||||||
|
10 |
Info |
− |
1 |
テキストノードに親要素の説明（コメント）を記述します。 |
|||||
|
11 |
Property |
− |
0-1 |
親要素ProductSectionが持つパラメータを指定します |
|||||
|
12 |
ovf:key |
1 |
deploy.pauseを指定。 デプロイ中に一時停止するかを指定します。 |
||||||
|
13 |
ovf:type |
1 |
boolean |
||||||
|
14 |
ovf:value |
1 |
true | <<false>> |
||||||
|
15 |
ProductSection（uoc.UOC種別） |
− |
0-1 |
サイジングUOCの情報を指定します。 |
|||||
|
16 |
ovf:class |
1 |
uoc.sizingを指定。 サイジングUOCのパラメータであることを表します。 |
||||||
|
17 |
Info |
− |
1 |
テキストノードに親要素の説明（コメント）を記述します。 |
|||||
|
18 |
Property |
− |
1 |
− |
|||||
|
19 |
ovf:key |
1 |
"クラス名" SizingUocを実装したクラス名を指定します。 |
||||||
|
20 |
ovf:type |
1 |
string |
||||||
|
21 |
ovf:value |
1 |
keyに指定したクラスを含むjarファイル名を指定します。 csdtmpregisterコマンドの-dオプションで指定したディレクトリからの相対パスで指定します。 |
||||||
|
22 |
Value |
− |
0-20 |
− |
|||||
|
23 |
ovf:key |
1 |
UOCへのパラメータ名を指定します。 |
||||||
|
24 |
ovf:value |
1 |
UOCへのパラメータ値を指定します。 |
||||||
|
25 |
VirtualSystemCollection |
− |
1 |
AbstractSystemの集まりを表します。 |
|||||
|
26 |
ovf:id |
1 |
任意の識別子を指定します。必須ですが，ISCMではコメントとして扱われます。 |
||||||
|
27 |
Info |
− |
1 |
テキストノードに親要素の説明（コメント）を記述します。 |
|||||
|
28 |
Name |
− |
0-1 |
テキストノードに要素の名前（コメント）を指定します。 |
|||||
|
29 |
AbstractSystem |
− |
1-20 |
AbstractSystemを1つ以上指定します。 |
|||||
|
30 |
ovf:id |
1 |
コンポーネントIDを指定します。親要素VirtualSystemCollection内でほかのAbstractSystemと重複できません。 表2-20の項番17で設定した値と同じ値を設定してください。 |
||||||
|
31 |
Info |
− |
1 |
テキストノードに親要素の説明（コメント）を記述します。 |
|||||
|
32 |
Name |
− |
0-1 |
テキストノードに要素の名前（コメント）を指定します。 |
|||||
|
33 |
ProductSection （class=tier.ティア） |
− |
1-5 |
複数指定する場合には，親要素AbstractSystem内でティアの値が重複しないよう設定してください。 |
|||||
|
34 |
ovf:class |
1 |
ティアを指定します。 表2-16の項番56で設定した値と同じ値を設定してください。 |
||||||
|
35 |
Info |
− |
1 |
テキストノードに要素の説明（コメント）を記述します。 |
|||||
|
36 |
Property （key=order） |
− |
0-1 |
指定した場合には，この構成パターンテンプレートファイル内のその他のティアについても，この要素を必ず指定してください。また，その場合value属性に指定するセットアップ順序は重複してはいけません。 |
|||||
|
37 |
ovf:key |
1 |
orderを指定。 セットアップ順序であることを表します。 |
||||||
|
38 |
ovf:type |
1 |
uint16 |
||||||
|
39 |
ovf:value |
1 |
構成パターン内でのティアのセットアップ順序を指定します。小さい番号から順にセットアップします。省略した場合には任意の順番となります。 |
||||||
|
40 |
Property （key=tiertype） |
− |
0-1 |
ティア種別を指定します。ミドルウェア識別子にhitachi.Cosminexusの場合に指定できます。ミドルウェア識別子がhitachi.Cosminexusで，ティア種別を指定しない場合，combined-tierとして動作します。 |
|||||
|
41 |
ovf:key |
1 |
tiertypeを指定。 ティア種別であることを表します。 |
||||||
|
42 |
ovf:type |
1 |
string |
||||||
|
43 |
ovf:value |
1 |
ミドルウェア識別子がhitachi.Cosminexusの場合に，仮想サーバマネジャのティアを表す値を指定します。 |
||||||
|
44 |
NetworkConnectionSection |
− |
1 |
− |
|||||
|
45 |
Info |
− |
1 |
テキストノードに親要素の説明（コメント）を記述します。 |
|||||
|
46 |
Network（name=management.接続先ネットワーク名） |
− |
1 |
− |
|||||
|
47 |
ovf:name |
1 |
AbstractSystemが属する管理用の接続先ネットワーク名にmanagement接頭辞を付けて指定します。 |
||||||
|
48 |
csd:purpose |
0-1 |
接続先ネットワークが使用する，仮想ネットワークデバイス名の用途を指定します（物理構成定義ファイルに記載した物理ホストが保持する仮想ネットワークデバイスの用途）。 |
||||||
|
49 |
csd:defaultGateway |
0-1 |
接続先ネットワークに対して，デフォルトゲートウェイ情報を設定することを示すフラグ。省略した場合はtrueとなります。 tureのときは，NICに，IPアドレス設定ファイルに指定したデフォルトゲートウェイ情報を設定します。 |
||||||
|
50 |
Description |
− |
0-1 |
テキストノードに親要素の説明（コメント）を記述します。 |
|||||
|
51 |
Network（name=business.接続先ネットワーク名） |
− |
VMware: 0-9※1 HVM: 1-3※2 |
− |
|||||
|
52 |
ovf:name |
1 |
AbstractSystemが属する業務用の接続先ネットワーク名にbusinessの接頭辞を付けて指定します。 |
||||||
|
53 |
csd:purpose |
0-1 |
接続先ネットワークが使用する，仮想ネットワークデバイス名の用途を指定します（物理構成定義ファイルに記載した物理ホストが保持する仮想ネットワークデバイスの用途）。 |
||||||
|
54 |
csd:defaultGateway |
0-1 |
接続先ネットワークに対して，デフォルトゲートウェイ情報を設定することを示すフラグ。省略した場合はtrueとなります。 tureのとき，NICに，IPアドレス設定ファイルに指定したデフォルトゲートウェイ情報を設定します。 |
||||||
|
55 |
Description |
− |
0-1 |
テキストノードに親要素の説明（コメント）を記述します。 |
|||||
|
56 |
AbstractSystemCollection |
− |
1 |
AbstractSystemの集まりを表します。 AbstractSystemCollection内に記載できるAbstractSystem（子要素）の構成は次のとおりです。
ミドルウェア識別子にhitachi.Cosminexusを使用する場合，仮想サーバマネジャにおける，仮想サーバグループを表します。 AbstractSystemCollection内に指定したAbstractSystemのうち，ミドルウェア識別子にhitachi.Cosminexusを使用するものを同一の仮想サーバグループとします。 サイジングでのデプロイするホスト数は，AbstractSystemCollection要素単位で決定します。同一AbstractSystemCollectionに含まれる複数のコンポーネントでは，サイジング時のnumberOfHost値を，同じ値とする必要があります。一致していない場合，同一AbstractSystemCollection内のコンポーネントごとに返却されたnumberOfHost値のうち最小のものをサイジング結果のnumberOfHost値として動作します。 |
|||||
|
57 |
ovf:id |
1 |
任意の識別子を指定します。必須ですがISCMではコメントとして扱われます。 |
||||||
|
58 |
Info |
− |
1 |
テキストノードに親要素の説明（コメント）を記述します。 |
|||||
|
59 |
Name |
− |
0-1 |
テキストノードに要素の名前（コメント）を指定します。 |
|||||
|
60 |
AbstractSystem |
※3 |
※3 |
※3 |
|||||
注※1 VMwareの制限値です。上限値はプログラムでチェックしません。
注※2 JP1/DPMの制限値です。下限値と上限値はプログラムでチェックしません。
注※3 AbstractSystemタグについては，項番29〜55と同一の内容です。