3.3 ドキュメント

ドキュメントでは、運用業務の中で使用する添付ファイルを一元的に管理することができます。

（図）ドキュメントの概念図

添付ファイルとは、顧客ユーザーがサービス利用時、サービスカタログから申請を行う際に添付する申請書や、運用担当者がサービスの実行結果をまとめた報告書など、ワークフローの各ステップ作業において添付されるファイルです。
これらのファイルは、あらかじめ定義されたファイルの命名ルール（Attachment）、配布ルール（Distribution）に従って格納されます。

添付ファイルの管理は、グループによるアクセス制御と、リポジトリによるデータ管理を、それぞれどのような単位で行いたいかによって決定します。

グループを分けることで、格納されているドキュメントに対して、グループメンバーにしか参照させないなどのアクセス制御（参照範囲のコントロール）を行うことができます。ドキュメント配布先となるグループとリポジトリは事前に作成しておく必要があります。グループの作成手順は「グループ管理」を参照ください。また、リポジトリの作成は以下の手順で実施してください。

まず「リポジトリ管理」を参照しリポジトリを作成してください。
次に、リポジトリの設定を変更します。この変更は、対象のリポジトリが属するグループに対してGitロールのMaintainer権限を持っているユーザーで実施する必要があります。作成したリポジトリや設定変更のメニューが表示されない場合は、「グループ管理」を参考にGitロールの設定をMaintainer権限にしてください。
以下にリポジトリ設定の手順を示します。

1. GitのURL「https://git.<テナント名>.ops-integration.com/」にアクセスする。
2. Your Projectsの中から設定するリポジトリ（プロジェクト）を選択する。
3. 左ツリーメニューから「Settings」-「Repository」を選択する。
4. Protected branchesの行の「Expand」を選択する。
5. 表示されている表の「main(default)」の行の「Allowed to push」列のプルダウンを「Developers + Maintainers」に変更する。

リポジトリを削除する手順は、「JP1 Cloud Service 運用統合 APIリファレンス」の「APIリファレンス概要＞APIの詳細と実行例＞YAMLファイル（manifest.yaml）登録用のリポジトリを削除する」を参照ください。

なお、Ops Iのグループとユーザーを定義することで、GitLabのグループとそのグループメンバーは自動的に連動されます。また、添付ファイルの格納先には対象のリポジトリが属するグループに対してDeveloper以上の権限を持つGitロールが必要です。

（図）グループによるドキュメントのアクセス制御

リポジトリを分けることで、リポジトリ単位でデータを管理できます。
例えば、格納されているドキュメントは、リポジトリ単位でまとめてバックアップすることができるため、Customer（顧客）やServiceごとに添付ファイルをまとめてバックアップする運用を行いたい、といった場合には、リポジトリを顧客単位、Service単位とすることで実現することができます。ドキュメント配布先振り分けについての概念図を以下に示します。

（図）ドキュメント配布先振り分けの概念図

顧客単位にグループを設定し、顧客ごとに1つのリポジトリとした場合の概念図を以下に示します。
顧客ごとにアクセスを制御でき、顧客単位にバックアップ、保管などの管理を行う運用に対応できます。

（図）顧客ごとに1つのリポジトリとした場合の概念図

すべて同じグループ、リポジトリで運用することも可能です。
単一システムでの運用や、小規模な範囲でのデータ管理で、まとめて管理したい運用に対応できます。
初期状態では、この設定になっており、リポジトリは「global」グループの「global」リポジトリに、パスは/dist固定で格納されます。

（図）すべて同じグループ、リポジトリで運用した場合の概念図

ドキュメントは、操作できる対象や必要な機能をまとめた、複数のタブ（①～②）で構成されます。

（図）ドキュメント画面

それぞれのタブで提供する機能の概要を以下に示します。

（表）ドキュメントで提供する機能の概要

節構成

3.3.1 コンテナ
3.3.2 配布