6.4 Catalog
以下にCatalog定義と定義例を示します。サービスカタログの詳細については「サービスカタログ」と「データモデルの設計」を参照してください。
| ラベル | デフォルト値 | 必須※ | 説明 | ||
|---|---|---|---|---|---|
| apiVersion: | Yes | APIバージョン 1.0を指定する |
|||
| kind: | Yes | catalogを指定する | |||
| type: | No | resourceを指定する Ops Iの運用機能に追加する新しい定義であることを示す |
|||
| name: | Yes | Catalog定義の内部名 nameは以下のルールに従う必要があります。
|
|||
| label: | Yes | YAMLファイルに記載する運用機能の表示名 | |||
| includes: | No | このYAMLファイルで利用する関連YAMLファイルを記載
 メモ
|
|||
| - kind: | Yes | 読み込むYAMLファイルの種類 | |||
| name: | Yes | 読み込むYAMLファイルの内部名 | |||
| description: | No | このYAMLファイルに対する詳細説明 テンプレート機能を利用して記述することができる |
|||
| order: | No | このYAMLファイルで設定するカテゴリー表示順の優先順位 0～2147483647の整数を指定する。指定しない場合、および同じ値を設定した場合、CatalogのYAMLファイルを登録した順に表示される。 |
|||
| customers: | No | このYAMLファイルで設定するカテゴリーとカタログアイテムの表示を顧客により制限する場合、指定する。 顧客ユーザーは、自分自身に設定された顧客がここで指定された顧客に含まれない場合、このYAMLファイルのカテゴリーとカタログアイテムを参照することができない。 |
|||
| - (string) | Yes | カテゴリーとカタログアイテムを表示する顧客名 | |||
| groups: | No | このYAMLファイルで設定するカテゴリーとカタログアイテムの表示をグループにより制限する場合、指定する。 すべてのユーザーは、自分自身に設定されたいずれのグループもここで指定されたグループに含まれない場合、このYAMLファイルのカテゴリーとカタログアイテムを参照することができない。 |
|||
| - (string) | Yes | カテゴリーとカタログアイテムを表示するグループ名 | |||
| categories: | Yes | カテゴリーを設定 | |||
| - name: | Yes | カテゴリーの内部名 | |||
| label: | No | カテゴリーの表示名 | |||
| description: | No | カテゴリーの詳細説明 | |||
| items: | No | カテゴリー配下に置く個々のカタログアイテムを定義 | |||
| - workflow: | No | ワークフローを実行するカタログアイテムを定義。ワークフロー名を指定 | |||
| label: | No | カタログアイテムの表示名 | |||
| description: | No | カタログアイテムの詳細説明 | |||
| image: | No | アイコン画像のファイル名。このYAMLファイルと同じディレクトリ内にある画像を指定可能 | |||
| sub: | No | カテゴリーを階層化する際にサブカテゴリーを設定 | |||
| - name: | Yes | - | |||
| … | No | - | |||
| (sub): | No | - | |||
※入れ子関係にないラベルの必須が「No」の場合は、定義が必須ではありません。入れ子関係にあるラベルの場合は、下層ラベルの必須は、上層ラベルの必須が「Yes」である場合に適用されます。
＜定義例＞
apiVersion: 1.0
kind: catalog
type: resource
name: demo_catalog
label: デモ用サービスカタログ
description: |
デモ用サービスカタログです
includes:
- kind: workflow
name: create_vm_wf
categories:
- name: demo_catalog
label: デモ用カタログアイテム
sub:
- name: request_operation
label: リクエスト業務
items:
- workflow: create_vm_wf
label: VMの貸出
description: VMの貸出申請をする
image: sample1.png