4.3.4 ドキュメントの保管方法

ISOなどの規格を取得する場合、さまざまな運用の作業記録や証跡が必要です。
ドキュメントの保管方法では、エビデンスについてどのように格納するのかを設計する必要があります。

Ops IではAttachment定義でエビデンスをルールに基づいて管理するコンテナを作成します。
その後、Distribution定義で顧客やサービスごとにリポジトリを振り分けることが可能です。
コンテナについての詳細は、「コンテナ」をご参照ください。


【Attachment】

Attachmentでは、コンテナ名/フォルダ名などの命名ルールを定義します。
タイムスタンプや識別子を入力することができます。 タイムゾーンについては、YAML定義で指定します。
なお、ワークフロー実行時のタイムスタンプは、実行ユーザーのユーザー設定時のタイムゾーンとなるため、フォルダ名のタイムゾーンと異なる時刻設定になる可能性があります。ユーザー設定時のタイムゾーンを指定しておくことを推奨します。 AttachmentのYAML定義については「Attachment」を参照してください。

(図)AttachmentとDistributionの概念図

(図)AttachmentとDistributionの概念図 (図)AttachmentとDistributionの概念図


【Distribution】

Distributionでは、配布先、リポジトリ、グループを定義します。

(図)Distributionの概念図

(図)Distributionの概念図 (図)Distributionの概念図

AttachmentとDistribution のYAML定義の詳細は「Attachment」および「Distribution」を参照してください。

注意

  • 一度登録した配布ルールは削除しないでください。また、配布ルールを複数作成する場合は、別ファイルにして登録してください。
  • 顧客ユーザー以外のユーザーがワークフローにファイルを添付した場合、DistributionのYAML定義でドキュメントの配布先グループのtypeに”customer”を設定している配布ルールは適用されません。

(表)ドキュメント管理設計項目と概要

項目 定義手段 設計のポイント
・Attachment
・Distribution
YAMLによる定義
(GitLab)
お客様のサービスを考慮して、ドキュメントを管理するリポジトリ構成、グループによる参照範囲、証跡などのファイル命名ルール、振り分け保管ルールを検討しておきます。

リポジトリやグループの考え方については、「ドキュメント」を参照してください。


(図)ドキュメント管理方法の概念図

(図)ドキュメント管理方法の概念図 (図)ドキュメント管理方法の概念図

以下の表は、VMの貸出を例としたドキュメントコンテナの設計項目の一覧になります。Distributionによって「vm/create/」や「vm/delete/」などのディレクトリパスでGitLabでの振り分け先などを定義します。例えば、VM生成時の実行ログの場合、「/vm/create/log」配下にエビデンスを配置します。


(表)VMの貸出を例としたドキュメントコンテナの設計

リポジトリ ファイル 関連するワークフロー 配布パス(配布先/コンテナ名/フォルダ名)
種別 ワークフロー/ステップ 配布先 コンテナ名 フォルダ名
サービス共通
VM生成時のチェックリストひな形 UI(参照) 2(1) VMの貸出 - VM生成の確認 /vm/create/ template -
VM削除時のチェックリストひな形 UI(参照) 2(2) VMの削除 - VM削除の確認 /vm/delete/ template -
受注管理システム
VM生成時の記入済みチェックリスト UI(保管) 2(1) VMの貸出 - VM生成の確認 /vm/create/ checklist 実施日時
VM削除時の記入済みチェックリスト UI(保管) 2(2) VMの削除 - VM削除の確認 /vm/delete/ checklist 実施日時
顧客管理システム
生産管理システム