6.8 Distribution

以下にDistribution定義と定義例を示します。Distributionの詳細については「ドキュメントの保管方法」を参照してください。

（表）Distribution定義

ラベル デフォルト値 必須※ 説明
apiVersion: Yes APIバージョン
1.0を指定する
kind: Yes distributionを指定する
type: No resourceを指定する
Ops Iの運用機能に追加する新しい定義であることを示す
name: Yes Distribution定義の内部名
nameは以下のルールに従う必要があります。
  • 本YAMLファイルのディレクトリ名を指定
  • 入力可能な文字は以下の通り
    • 半角英数字：
      a～z A～Z 0～9
    • 半角の特殊文字：
      _ . ( ) -
  • 先頭文字が半角英数字かアンダーバー（_）
  • その他の注意点は「YAMLファイル作成時の注意」2～4を参照
label: No YAMLファイルに記載する運用機能の表示名
includes: No このYAMLファイルで利用する関連YAMLファイルを記載
メモメモ
  • 記載するYAMLファイルはこのYAMLファイル登録前にOps Iに登録されている必要があります。
  • includesラベルを指定することにより、他のYAMLファイルで定義した内容を取り込むことができます。
- kind: Yes 読み込むYAMLファイルの種類
  name: Yes 読み込むYAMLファイルの内部名
description: No このYAMLファイルに対する詳細説明
rules: Yes Distributionのルール
- name: Yes ルール名
  label: Yes ルールの表示名
  group: Yes 配布先グループについて設定します。
type: Yes ドキュメントの配布先のグループを決定するルールを指定します。指定できるタイプは以下です。
  • fixed：
    すべてのドキュメントが固定グループに保存されます。
  • customer：
    ドキュメントは顧客名と同じ名前のグループに格納されます。
    ただし、顧客ユーザー以外のユーザーがワークフローにファイルを添付した場合、このルールは適用されず、優先度に従い他のルールが適用されます。
指定したタイプに関わらず、ドキュメントの配布先となるグループは事前に作成してください。
name: No タイプに"fixed"を指定した場合に格納されるグループ名を指定します。
  repository: Yes 配布先リポジトリについて設定します。
type: Yes ドキュメントの格納先のリポジトリを決定するルールを指定します。指定できるタイプは以下です。
  • fixed：
    すべてのドキュメントが固定リポジトリに保存されます。
指定したタイプに関わらず、ドキュメントの配布先となるリポジトリは事前に作成してください。リポジトリ作成方法は「ドキュメント」を参照してください。
name: No タイプに"fixed"を指定した場合に格納されるリポジトリ名を指定します。
  directory: Yes 配布先ディレクトリについて設定します。
type: No 指定できるタイプは以下です。
  • fixed：
    すべてのドキュメントがpathで指定したディレクトリに保存されます。
path: Yes ドキュメントが格納されるディレクトリのパスを指定します。
Windows/Linuxのファイル名・フォルダ名で使用不可な文字・文字列は指定できません。
  branch: Yes ドキュメントが格納されるブランチを指定します。ブランチは、mainブランチを使用してください。
※入れ子関係にないラベルの必須が「No」の場合は、定義が必須ではありません。入れ子関係にあるラベルの場合は、下層ラベルの必須は、上層ラベルの必須が「Yes」である場合に適用されます。

＜定義例＞

apiVersion: 1.0
kind: distribution

type: resource
name: VM Creation and Deletion
label: VM Creation and Deletion
description: VM生成時の添付ファイルに対し、カスタマーごとにグループを分類する。

rules:
  - name: VM Creation and Deletion
    label: VM Creation and Deletion
    group:
      type: customer    
    repository:
      type: fixed
      name: Evidence
    directory:
      type: fixed
      path: /vm
    branch: main