6.5 Script
以下にScript定義と定義例を示します。スクリプトの詳細については「 UI設計」を参照してください。
ScriptのYAMLファイル内で定義するアクションのスクリプトのバージョンは、UIのUIバージョンにあわせる必要がありますが、Scriptは常に以下のapiVersion1.0のYAML定義になります。UIバージョンの詳細は「UIバージョン」を参照してください。
| ラベル | デフォルト値 | 必須 | 説明 | |
|---|---|---|---|---|
| apiVersion: | 1.0 | Yes | APIバージョン | |
| kind: | Yes | スクリプトの際はscriptを指定する | ||
| type: | No | スクリプトの際はresourceのみ指定可能 | ||
| name: | Yes | Script定義の内部名。本YAMLファイルのディレクトリ名を指定 | ||
| label: | Yes | YAMLファイルの表示名 | ||
| includes: | No | このYAMLファイルで利用する関連YAMLファイルを記載 | ||
| - kind: | Yes | 読み込むYAMLファイルの種類 | ||
| name: | Yes | 読み込むYAMLファイルの内部名 | ||
| description: | No | このYAMLファイルに対する詳細説明 | ||
| actions: | Yes | アクションを定義 | ||
| - name: | Yes | アクション名 | ||
| file: | Yes | アクションの内容を記述したスクリプトファイルのパス。スクリプトのYAMLファイルが保存されているディレクトリが起点となる。 例） 作成したスクリプトをsample.jsとし、scriptのYAMLファイルが保存されているディレクトリにsample.jsが保存されている場合、当該スクリプトのファイルパスは以下となる。 sample.js |
||
アクションが定義可能なコンポーネントの一覧については、以下を参照してください。
- UIのYAML定義がUIバージョン1.0の場合：「アクションのスクリプト（UIバージョン1.0）」
- UIのYAML定義がUIバージョン1.1の場合：「アクションのスクリプト（UIバージョン1.1）」
＜定義例＞
apiVersion: 1.0
kind: script
type: resource
name: create_vm
label: create_vm
description: VM生成を行うカスタムスクリプトです。
actions:
- name: create_vm_action
file: create_vm_action.js
節構成
6.5.1 アクションのスクリプト（UIバージョン1.0）
6.5.2 アクションのスクリプト（UIバージョン1.1）