第 6 章 注意・制限事項
B.3 トポロジーテンプレートの構造
B.3.1 parameters セクション
parameters
セクションでは、トポロジーテンプレートをインスタンス化する場合に使用する入力パラメータを定義します。
パスワードなど、利用者ごとに指定する必要があるパラメータを記述しておきます。
B.3.1.1 parameters セクションのデータ構造
parameters:
<param name>:
type: <string | number | json | comma_delimited_list | boolean>
label: <human-readable name of the parameter>
description: <description of the parameter>
default: <default value for parameter>
hidden: <true | false>
constraints: <parameter constraints>
表B-2 parameters セクション
名前 説明
param name 入力パラメータの名前
[必須]
type 入力パラメータのデータ型
• string
• number
• json
• comma_delimited_list
• boolean
名前 説明 [必須]
label 入力パラメータのラベル
※スタック作成（入力）画面にて、パラメータキーの名前として表示 されます。
description 入力パラメータの説明
default 入力パラメータを省力した場合のデフォルト値
hidden スタック作成（入力）画面にて、入力したパラメータの値をマスク表
示にする場合はtrueを設定します。
入力した値を表示にする場合はfalseを設定します。
• true
• false
※省略した場合はfalse
※パラメータとして指定されたパスワードなどを隠すために使用し ます。
constraints 入力パラメータの制約
「B.3.1.2 Parameter Constraints（66ページ）」を参照してください。
B.3.1.2 Parameter Constraints
parameters
セクションのParameter Constraints
の構造を以下に示します。constraints:
- <constraint type>: <constraint definition>
description: <constraint description>
表B-3 Parameter Constraints
名前 説明
constraint type 制約のタイプ
• length
• range
• allowed_values
• allowed_pattern
• custom_constraint [必須]
constraint definition 指定したconstraint typeに対応する制約値
※それぞれの制約の構文については以降の節で説明します。
[必須]
description 制約に違反した場合に利用者に表示されるメッセージを設定します。
省略時はデフォルトのメッセージが表示されます。
length
文字列型のパラメータに適用されます。文字数の最小値と最大値を定義します。
min
またはmax
の少なくとも1
つを指定する必要があります。length: { min: <lower limit>, max: <upper limit> }
range
数値型のパラメータに適用されます。指定可能である数値の最小値と最大値を定義します。
min
またはmax
の少なくとも1
つを指定する必要があります。range: { min: <lower limit>, max: <upper limit> }
allowed_values
数値型、文字型のパラメータに適用されます。指定できる値のリストを定義します。
allowed_values: [ <value>, <value>, ... ] 以下のように、記述することも可能です。
allowed_values:
- <value>
- <value>
- ...
設定例
parameters:
instance_type:
type: string
label: Instance Type
description: Instance type for compute instances constraints:
- allowed_values:
- m1.small - m1.medium - m1.large
allowed_pattern
文字型のパラメータに適用されます。指定できる値の正規表現を定義します。
allowed_pattern: <regular expression>
設定例
parameters:
user_name:
type: string label: User Name
description: User name to be configured for the application constraints:
- allowed_pattern: "[A-Z]+[a-zA-Z0-9]*"
description: User name must start with an uppercase character
custom_constraint
カスタマイズした制約を定義します。
custom_constraint: <name>
SSC
リソースプラグイン機能では、以下のcustom_constraint
を提供します。表B-4 custom_constraint
名前 確認内容
nec.ssc.ipv4_addr IPv4アドレスであること
nec.ssc.ipv6_addr IPv6アドレスであること
nec.ssc.flavor ssc_parameter.confの「ssc.flavor.<フレーバーID>」に設定されている フレーバーIDであること
nec.ssc.image ssc_parameter.confの「ssc.image.<イメージID>」に設定されているイ メージIDであること
nec.ssc.disk_profile ssc_parameter.confの「ssc.diskProfile.ext.<ディスクプロファイルID>」
に設定されているディスクプロファイルIDであること
nec.ssc.network NEC::SSC::NetのリソースID（論理ネットワーク名）
nec.ssc.tenant テナント名
nec.ssc.group グループパス
nec.ssc.resource_pool リソースプール名
nec.ssc.timezone OSのタイムゾーンであること
マ イ ク ロ ソ フ ト の タ イ ム ゾ ー ン の イ ン デ ッ ク ス 値(http://
support.microsoft.com/kb/973627)で定義されている16進数が有効
設定例
parameters:
net_gateway:
type: string
description: logical network gateway address constraints:
- custom_constraint: nec.ssc.ipv4_addr