マスターイメージ定義ファイルはXML形式で記述します。
サポートするXMLファイルの文字コードはUTF-8とします。XMLファイルにはXML宣言を記述し,XML宣言におけるencodingの値にUTF-8を指定してください。
タグは,「表2-20 マスターイメージ定義ファイルのXML文法」の順番に従って記述してください。従わない場合,エラーとなることがあります。
マスターイメージ定義ファイルのファイル名は任意です。
マスターイメージ定義ファイルの格納先は任意です。
マスターイメージ定義ファイルは,テンプレートの組み合わせや使用するUOCの情報など,マスターイメージ構築で使用する情報を定義するファイルです。マスターイメージ登録を行うcsdmiregisterコマンドと,マスターイメージ更新を行うcsdmiupdateコマンドで利用します。
次にマスターイメージ定義ファイルで定義する項目を示します。
表2-18 マスターイメージ定義ファイルの定義項目
項番 | 項目 |
---|---|
1 | マスターイメージ名,セクション,バージョン |
2 | マスターイメージの説明 |
3 | 構成パターンテンプレートとコンポーネントテンプレートの組み合わせ |
4 | サイジングUOC |
5 | ミドルウェアの固定パラメータ情報 |
6 | OS設定ファイルの固定パラメータ情報 |
7 | パッチ情報 |
表2-19 マスターイメージ定義ファイルのパラメータと指定方式
項番 | 項目 | 形式 | 説明 |
---|---|---|---|
1 | マスターイメージ名 | 英数字記号 1~32文字 | マスターイメージ名を指定します。 |
2 | セクション | 英数字記号 1~32文字 | セクションを指定します。 セクションとはマスターイメージ名の付加的な名称です。例えば,あるマスターイメージを2つの異なる物理配置に構築する場合に,マスターイメージ名が同じでも異なるセクションを設定すれば,2つの異なるマスターイメージとして登録することができます。 なお,uCSDでは,マスターイメージをマスターイメージ名+セクションの組み合わせで区別します。 注 セクション省略を含む |
3 | バージョン | VV-RR V:数字 R:数字 | マスターイメージのバージョンを指定します。 |
4 | マスターイメージの説明 | 文字列(日本語可) 1~255文字 | マスターイメージの説明(コメント)を記述します。 |
5 | 構成パターンテンプレート名 | 英数字記号 1~32文字 | マスターイメージのひな形として使う構成パターンテンプレート名を指定します。 |
6 | UOCクラス名 | 英数字,ピリオド(.),ドル記号($)およびアンダースコア(_) 注 ただし,パッケージ名およびクラス名の先頭は英数字1~1024文字 | UOCのクラス名(パッケージ名を含む)を指定します。 |
7 | jarファイル名 | 相対パス名。ただし,半角空白は指定できません。 1~160文字 | UOCで使用するjarファイルを指定します。 csdmiregisterコマンドまたはcsdmiupdateコマンドの-dオプションで指定するディレクトリに配置します。 |
8 | UOCパラメータ名 | 英数字記号 1~32文字 | UOCの入力パラメータの名称を指定します。 |
9 | UOCパラメータ値 | 文字列(日本語可)1~1024文字 | UOCの入力パラメータの名称に対応する値を指定します。 |
10 | コンポーネントID | 1~65535の整数 | 構成パターンテンプレートのコンポーネントIDを指定します。 構成パターンテンプレートに存在するすべてのコンポーネントIDに対応するComponent要素を記述します。 |
11 | コンポーネントテンプレート名 | 英数字記号 1~32文字 | コンポーネントIDに当てはめるコンポーネントテンプレートを指定します。 |
12 | ミドルウェア識別子 | CosminexusまたはHiRDBの場合,次の値です。 hitachi.Cosminexushitachi.HiRDBその他の場合,次の形式で指定する(optional.を含めて10~32文字の文字列) optional.任意の製品名任意の製品名:英数字と_.#-@()から成る文字列 | コンポーネントテンプレートのミドルウェアの識別子(hitachi.Cosminexusなど)を指定します。 |
13 | パラメータ名 | CsdU_A...A CsdU_:固定文字列 A...A: 英数字と_- 1~25文字 | コンポーネントテンプレートに登録された定義情報/OS設定ファイル情報の中で,固定化したいパラメータ名を指定します。 パラメータ名とは,ミドルウェア定義用・OS設定用テンプレートファイル,ミドルウェア定義用・OS設定用パラメータファイルで使用する可変部名称のことです。 |
14 | パラメータ値 | 文字列(日本語可) 1~1024文字 | 固定したいパラメータ名に対応する値を指定します。 |
15 | パッチ名 | 相対パス名。ただし,半角空白は指定できません。 1~247文字 | パッチ・ディレクトリからの相対パスでパッチスクリプトを指定します。 マスターイメージまたはVM単位で異なる可能性のあるものはコンポーネントテンプレートのミドルセットアップスクリプトではなくこちらに記載してください。 |
16 | パッチ・ディレクトリ | 絶対パス名。ただし,半角空白は指定できません。 定義に指定したパッチ・ディレクトリのパス長と,ディレクトリ内に格納したファイルのパス(パッチ・ディレクトリからの相対パス)の最大長を足した値が247文字以内に収まる長さ。 | パッチ・ディレクトリのパス。絶対パスを指定します。 パッチ・ディレクトリはuCSDで管理しない(uCSDには取り込まれない)ため,PaaS提供者,またはPaaS利用者が適切に管理してください。 |
17 | 適用順序 | 1~65535の整数 | パッチの適用順序を指定します。 適用順序はマスターイメージの一連のライフサイクル(登録・更新~削除まで)の中で,OSごとまたはミドルごとにユニークな番号とします。適用順序に65535を割り当てた場合,それ以降はパッチの追加ができなくなるので,小さい番号から順番に指定します。 なお,デプロイ後のマスターイメージにcsdmiupdateコマンドでパッチを追加する場合は,すでに指定した番号よりも大きい番号を指定します。 OS内またはミドル内での適用順序を指定するものであり,OS間またはミドル間の適用順序については,「表1-13 アップデート処理でのOS更新・ミドルウェア更新処理」「表1-36 デプロイ処理の流れ」を参照してください。 |
18 | VLAN ID | 0~4095の整数 | 業務LANで使用するVLAN IDを指定します。 リソース制約定義ファイルを使用している場合,利用者条件リソース制約定義ファイルの範囲内の値だけ指定できます。 範囲外を指定した場合はマスターイメージの登録が失敗します(KFUD23114-E)。 VLAN IDを指定しないで,かつリソース定義ファイルも指定しない場合は,次の値が仮定されます。
|
表2-20 マスターイメージ定義ファイルのXML文法
項番 | タグ名 | 属性 | 出現回数 | 説明 | ||||
---|---|---|---|---|---|---|---|---|
1 | MasterImage | - | 1 | - | ||||
2 | xmlns | 1 | "http://www.hitachi.co.jp/soft/xml/csd/service/masterimage_define"を指定してください。 | |||||
3 | name | 1 | マスターイメージ名を指定します。 | |||||
4 | section | 0-1 | マスターイメージのセクションを指定します。 マスターイメージ名+セクションの組み合わせは,他マスターイメージと重複できません。 | |||||
5 | version | 1 | マスターイメージのバージョンを指定します。 | |||||
6 | Description | - | 0-1 | テキストノードにマスターイメージの説明を指定します。 | ||||
7 | PatternTemplate | - | 1 | テキストノードに構成パターンテンプレート名を指定します。 表2-13の項番6で設定した値と同じ値を設定してください。 | ||||
8 | Parameter(uoc.UOC種別) | - | 0-1 | - | ||||
9 | type | 1 | uoc.sizingを指定します。 サイジングUOCであることを表します。 | |||||
10 | Property | - | 1 | - | ||||
11 | key | 1 | UOCクラス名 を指定します。 | |||||
12 | value | 1 | jarファイル名 を指定します。 csdmiregisterまたはcsdmiupdate(-d)コマンドで指定するディレクトリからの相対パスを指定します。 | |||||
13 | Value | - | 0-20 | 複数指定する場合には,親要素Property内でkeyの値が重複してはいけません。 | ||||
14 | key | 1 | UOCへの入力パラメータのキーを指定します。 | |||||
15 | value | 1 | キーに対応する,入力パラメータの値を指定します。 | |||||
16 | Component | - | 1-20 | - | ||||
17 | id | 1 | 構成パターンテンプレート内でこのコンポーネントを指すAbstractSystemのovf:idの値(コンポーネントID)を指定します。親要素内で重複してはいけません。 表2-13の項番30で設定した値と同じ値を設定してください。 | |||||
18 | template | 1 | コンポーネントテンプレート名を指定します。 表2-16の項番8で設定した値と同じ値を設定してください。 | |||||
19 | Vlan | - | 0-1 | - | ||||
20 | businessId | 1 | 業務LANで使用するVLAN IDを指定します。 | |||||
21 | Middleware | - | 0-5 | ミドルウェアの情報を設定します。 親要素Component内でidの値が重複してはいけません。 | ||||
22 | id | 1 | コンポーネントテンプレート内でこのミドルウェアを指すProductSectionのovf:classから”pp.”を取り除いた値を指定します。(例:hitachi.HiRDB) 表2-16の項番34で設定した値と同じ値を設定してください。 | |||||
23 | Parameter(fixed) | - | 0-1 | ミドルウェア定義情報を設定します。 | ||||
24 | type | 1 | fixedを指定します。 定義の固定化パラメータの情報であることを表します。 | |||||
25 | Property | - | 1-100 | 固定化パラメータ情報を設定します。複数指定する場合には,親要素Parameter内でkeyの値が重複してはいけません。 | ||||
26 | key | 1 | 固定化パラメータ名を指定します。 | |||||
27 | value | 1 | 固定パラメータ名に対応した値を指定します。 | |||||
28 | Parameter(patch) | - | 0-1 | ミドルウェアのパッチ情報を設定します。 | ||||
29 | type | 1 | patchを指定します。 パッチの情報であることを表します。 | |||||
30 | Property | - | 1-120 | パッチの情報を設定します。 複数指定する場合には,親要素Parameter内でkeyおよびorderの値が重複してはいけません。 | ||||
31 | key | 1 | パッチ名を指定します。 | |||||
32 | value | 1 | パッチ・ディレクトリを指定します。 | |||||
33 | order | 1 | パッチ適用順序を指定します。 | |||||
34 | Parameter(fixed) | - | 0-1 | OS設定ファイル情報を指定します。 | ||||
35 | type | 1 | fixedを指定します。 固定化パラメータの情報であることを表します。 | |||||
36 | Property | - | 1-10 | 固定化パラメータ情報を設定します。複数指定する場合には,親要素Parameter内でkeyの値が重複してはいけません。 | ||||
37 | key | 1 | 固定化パラメータ名を指定します。 | |||||
38 | value | 1 | 固定パラメータ名に対応した値を指定します。 | |||||
39 | Parameter(patch) | - | 0-1 | OSのパッチ情報を指定します。 | ||||
40 | type | 1 | patchを指定します。 パッチの情報であることを表します。 | |||||
41 | Property | - | 1-120 | パッチの情報を設定します。複数指定する場合には,親要素Parameter内でkeyおよびorderの値が重複してはいけません。 | ||||
42 | key | 1 | パッチ名を指定します。 | |||||
43 | value | 1 | パッチ・ディレクトリを指定します。 | |||||
44 | order | 1 | パッチ適用順序を指定します。 |
次にマスターイメージ定義ファイルの記述例を示します。
<?xml version="1.0" encoding="UTF-8"?> |