6.6 Library

以下にLibrary定義と定義例を示します。Libraryの詳細については「Library」を参照してください。

(表)Library 定義

ラベル デフォルト値 必須 説明
apiVersion: Yes APIバージョン
1.0を指定する
kind: Yes libraryを指定する
type: No containerを指定する
ドキュメント格納用のコンテナを作成する定義であることを示す
name: Yes Library定義の内部名
nameは以下のルールに従う必要があります。
  • 本YAMLファイルのディレクトリ名を指定
  • 入力可能な文字は以下の通り
    • 半角英数字:
      a~z A~Z 0~9
    • 半角の特殊文字:
      _ . ( ) -
  • 先頭文字が半角英数字かアンダーバー(_)
  • その他の注意点は「YAMLファイル作成時の注意」2~4を参照
label: Yes YAMLファイルに記載する運用機能の表示名
includes: No このYAMLファイルで利用する関連YAMLファイルを記載
メモメモ
  • 記載するYAMLファイルはこのYAMLファイル登録前にOps Iに登録されている必要があります。
  • includesラベルを指定することにより、他のYAMLファイルで定義した内容を取り込むことができます。
- kind: Yes 読み込むYAMLファイルの種類
  name: Yes 読み込むYAMLファイルの内部名
description: No このYAMLファイルに対する詳細説明
テンプレート機能を利用して記述することができる
nameRule: No -
type: fixed No コンテナ内に保存されるドキュメントの命名ルール。
fixedのみ指定可能
items: Yes -
- name: Yes コンテナ内のアイテムフォルダの内部名。
  label: Yes コンテナ内のアイテムフォルダの表示名。テンプレート機能を利用可能。
  description: No コンテナ内のアイテムフォルダの詳細説明。テンプレート機能を利用可能。
※入れ子関係にないラベルの必須が「No」の場合は、定義が必須ではありません。入れ子関係にあるラベルの場合は、下層ラベルの必須は、上層ラベルの必須が「Yes」である場合に適用されます。

<定義例>

apiVersion: 1.0
kind: library
type: container
name: Template of checklist
label: Template of checklist
description: VM生成、VM削除時に使用するチェックリストのひな型を入れるフォルダ

nameRule:
  type: fixed
  items:
    - name: create
      label: create
    - name: delete
      label: delete