3.7.5 YAMLファイルの登録状況確認方法

Ops Iに対するYAMLファイルの登録操作の状況確認をするために、API「gitops-logs」を実行します。

APIを実行するためには、API認証作業を行う必要があります。詳細は「JP1 Cloud Service 運用統合 APIリファレンス」の「APIリファレンス概要＞前提知識」を参照ください。

API実行例を以下に示します。

＜実行例＞ /api/v1/gitops-logs

【操作ログの見方】

API「gitops-logs」の操作ログからYAMLファイルの操作の成功/失敗や、失敗原因であるファイルのエラー（構文/依存関係）を確認することができます。

gitops-logsの結果は操作ログの「result」を確認します。resultで出力される結果は以下です。

• applied：成功
• recovered：復旧済
• failed：失敗

failedの場合、YAMLファイルは登録に失敗しています。登録が失敗の場合「detail」に以下が表示され、場所の特定と失敗原因を確認することができます。

• column：エラーが発生した列
• data：エラーが発生した行データ
• line：エラーが発生した行
• message：エラーの詳細メッセージ

recovered（復旧済）は、過去のCommitで依存関係によるエラーによってfailedとなったYAMLファイルが、それ以降のCommitで依存関係によるエラーが解消し、その結果YAMLファイル登録状況が回復した状態です。（依存関係によるエラーの解消の例：依存関係があるYAMLファイルが正常に登録または削除された場合など。）

【操作ログがない場合】

API「gitops-logs」のYAMLファイルの操作ログがない場合は、GitLab上でCommitされていてもOps Iにドキュメントとして認識されておらず、Ops Iに反映されていません。
原因として以下などが考えられます。

• 登録したファイルがYAMLファイルではない
• Commit先のリポジトリがドキュメント登録対象外
• ファイルの拡張子、ファイル名（manifest.yaml）が異なる