6.8 Distribution
以下にDistribution定義と定義例を示します。Distributionの詳細については「ドキュメントの保管方法」を参照してください。
| ラベル | デフォルト値 | 必須 | 説明 | ||
|---|---|---|---|---|---|
| apiVersion: | 1.0 | Yes | APIバージョン | ||
| kind: | Yes | Distributionの際はdistributionを指定する | |||
| type: | No | Distributionの際はresourceのみ指定可能 | |||
| name: | Yes | Distribution定義の内部名。本YAMLファイルのディレクトリ名を指定 | |||
| label: | No | YAMLファイルの表示名 | |||
| description: | No | このYAMLファイルに対する詳細説明 | |||
| includes: | No | このYAMLファイルで利用する関連YAMLファイルを記載 | |||
| - kind: | Yes | 読み込むYAMLファイルの種類 | |||
| name: | Yes | 読み込む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ブランチを使用してください。 | |||
＜定義例＞
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