6.8 Distribution

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

（表）Distribution定義

キー デフォルト値 必須※ 説明
apiVersion: Yes APIバージョン
1.0を指定する。
kind: Yes distributionを指定する。
type: No resourceを指定する。
Ops Iの運用機能に追加する新しい定義であることを示す。
name: Yes Distribution定義の内部名
nameは以下のルールに従う必要がある。
  • 本マニフェストファイルのディレクトリ名を指定
  • 入力可能な文字は以下の通り
    • 半角英数字：
      a～z A～Z 0～9
    • 半角の特殊文字：
      _ . ( ) -
  • 先頭文字が半角英数字かアンダーバー（_）
  • その他の注意点は「マニフェストファイル作成時の注意」2～4を参照
label: No マニフェストファイルに記載する運用機能の表示名
includes: No このマニフェストファイルで利用する関連マニフェストファイルを記載
メモメモ
  • 記載するマニフェストファイルはこのマニフェストファイル登録前にOps Iに登録されている必要があります。
  • includesキーを指定することにより、他のマニフェストファイルで定義した内容を取り込むことができます。
- kind: Yes 読み込むマニフェストファイルの種類
  name: Yes 読み込むマニフェストファイルの内部名
description: No このマニフェストファイルに対する詳細説明
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」の場合は、定義が必須ではありません。入れ子関係にあるキーの場合は、下層キーの必須は、上層キーを設定している場合に適用されます。

＜定義例＞

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