ドキュメント

マンデート

このページでは、CoRoidが人間なしで実行可能な処理内容を確認し、実際に実行された内容を確認し、処理を停止することもできます。

「マンデート概要は、CoRoidが人に頼まずに実行できる作業を指定する場所です。ナビゲーション内では品質管理の隣に位置し、2つの部分で構成されています:概要現在設定されている内容が表示され、設定ここで設定を変更できます。

概要で確認できる情報

概要では1つの質問に答えます:CoRoidが人に頼まずに何を実行するか?

最初の行には例えば「CoRoidは自動的にセキュリティ修正を開始し、影でマージ処理を学習中です。他のすべてのステップは人の指示を待ちます」といった文が記載されます。CoRoidが独自にプルリクエストの修正やブロックも行う場合は、2行目にその旨が記載されます。その下にはマンデートで定められた4つのステップが作業の順序通りに示されます:

ステップ意味
作業開始CoRoidは、あなたの目標の1つに基づき、誰からも依頼されていない作業を開始します。
マージCoRoidがpull requestをマージします。
デプロイCoRoidが環境にデプロイします。
ロールバックCoRoidが失敗したデプロイを元に戻します。

各ステップには以下のいずれかが記載されます:

  • 人の指示を求めます。許可が付与されていないため、人の手で処理されます。
  • 影で学習中。許可が付与されていますが、実際に行う内容のみが記録されます。いつからどのような作業を行うかが記載されます。
  • 自動で実行します。有効な許可が付与されており、どの作業に対してどのように通知するかが記載されます。
  • CoRoidによって停止されました。CoRoidがそのステップの許可を自ら停止しました。理由を確認するには開いてください。
  • セキュリティ修正のみ(作業開始):CoRoidはセキュリティ設定に基づきセキュリティ修正を開始し、それ以外の作業は人の手で行われます。

ステップの許可は設定で開くか、そのステップ用の新しい許可を作成します。

ステップの下には:

  • 常に人の判断が必要です:保護されたパスと、プロジェクト内でCoRoidが開いたままにしているプルリクエストの数です。許可の内容に関係なく、保護されたパスへの変更はCoRoidによってマージまたはデプロイされることはありません。
  • 目標:CoRoidが向かう方向、使用可能な予算、およびその作業の今後の扱いです。
  • プロジェクト:一時停止中のプロジェクトや許可が制限されているプロジェクトには行が表示されます。それ以外のプロジェクトは組織の設定に従います。

オーナーや管理者は概要の上部から自律性を一時停止できます。

設定を開始する

  1. 「マンデート → 設定」を開いて「プリセットから開始」または新規 許可を選択して、1つのステップを設定します。
  2. 許可は影で開始されます。実際の作業でしばらく実行させてみてください。
  3. 許可を開いて、実行される内容を確認してください。記録内容に納得できたら、「有効にする。
  4. SlackやTelegramで通知を受け取りたい場合は、「CoRoidの機能」の下にある設定 → 接続 → 通知経路。

許可を影に戻したり、自律性を一時停止したりすることはいつでも可能です。

設定

設定ではまず組織の設定が表示され、その後に各プロジェクトの設定が続きます。各行には現在の設定が記載されており、クリックするとサイドパネルで編集画面が開きます。ページ内で直接編集することはありません。

グループ行
自律性一時停止、保留や一時停止の状態が表示され、復旧予備
許可許可ごとに1行が表示され、プリセットから開始」と新規許可
目標目標ごとに1行が表示され、新規目標
制限保護されたパス、デプロイアクション、開かれたプルリクエスト、エージェント
履歴マンデートの変更やそれに基づく決定のすべてが記録されます。

プロジェクトのページには、独自の一時停止設定、各許可の状況、および履歴が表示されます。目標や制限は組織全体で共有されます。

許可

「許可」とは、CoRoidが人に頼まずに実行できる作業のことです。行には例えば「人が依頼した作業のマージ」といった名称が付けられ、適用範囲が記載されます:

各プロジェクトで低優先度に分類され、1日最大5回まで実行されます。事前に通知され、停止指示を10分間待ちます。

編集画面では、ステップ、適用対象の作業、カバーする変更のリスクレベル、対象プロジェクト、制限、除外するパス、および通知方法などを個別に設定できます。

デプロイ権限では、1回のデプロイに含めてCoRoidがデプロイできるマージ済みプルリクエストの数も制限できます。より大規模なリリースは人がデプロイするため、まとめて失敗するバッチが人の手を介さず本番環境に到達することはありません。

1つのグラントは4つのステップのうち1つ、またはCoRoidがプルリクエストで実行する2つの処理のうち1つを対象とします:

  • プルリクエストを修正する。CoRoid自身の作業であるpull requestでチェックに失敗した場合、CoRoidはそれを修正するための処理を開始します。その作業のためのグラントがなければ、失敗内容はレビュー担当者に委ねられます。「失敗したチェックを修正」を自分で選択した場合、グラントは不要です。
  • プルリクエストをブロックする。CoRoidのレビュー機能が修正が必要な問題を検出すると、変更を要求するため、pull requestは人間の対応を待ちます。プロジェクト用のグラントがなければ、レビュー結果はコメントとなり、チェックは失敗しません。ブロック用のグラントは、そのプロジェクト内のすべてのpull requestを対象とし、誰が作成したかやリスクレベルに関係なく適用されますが、グラントで除外指定されたパスには適用されません。

これら2つはグラントになる前からCoRoidが既に実行していた処理です。各組織ではこれらが有効なグラントとして設定されており、グラントとして定義されたことで何かが変わることはありません。特定のプロジェクトに限定するか、グラントを無効化すればCoRoidはそれらの処理を実行しなくなります。一時停止しても同様です。

グラントの設定画面には、該当するステップで要求される項目のみが表示されます。作業の開始、修正、ロールバックの判断は変更が発生する前に行われるため、リスクレベルや除外パスの設定はありません。ブロック用のグラントには「誰の作業か」という概念はなく、すべてのpull requestを対象とします。

CoRoidはもはや作業の実装について問い合わせることはありません。作業の開始自体がその時点での決定事項となるのです。実装用のグラントにはそれが明記されており、無効化することも可能です。

グラントはシャドウ状態で開始される

新しいグラントは何も許可しません。シャドウCoRoidはグラントが許可していた内容を記録するため、依存する前にそれを確認できます。有効にするそれによりグラントが実際に適用されます。

グラントの許可範囲を拡大する編集を行うと、有効なグラントが再びシャドウ状態に戻ります。範囲を狭める編集ではそうなりません。

グラントが許可していた内容

グラントを開いて確認:

  • CoRoidがそのグラントをどれだけ利用したか、シャドウ状態で許可されていた内容;
  • マージ用のグラントの場合、過去30日間のデータ:その種類の作業のプルリクエストが何件マージされたか、グラントが許可していたマージ件数、マージされなかった理由、後から元に戻されたり修正されたりフォローアップされたマージ件数;
  • グラントが有効になるために必要な条件。

「低」レベルに分類される変更用のグラント低ルールによってその評価になります。 評価が「中」の場合の変更に対するマンデートはモデルに依存するため、実績が記録された場合にのみ有効になります。対象クラスのプルリクエストについて、評価済みが30件以上あり、誤承認がなく、さらに不正な変更を仕込んだテストが10件以上あり、そのすべてをブロックしていることが条件です。それまでは、マンデートに不足している条件が表示されます。

プリセットから開始

プリセットから開始マンデートに、すべてシャドーモードのマンデートをまとめて設定します。

プリセット追加内容
修正目標に沿って作業を開始
マージ修正し、評価が「低」の場合はマージ
リリースマージし、指定した1つの環境にデプロイ
クローズドループリリースし、デプロイに失敗した場合はその環境をロールバック
依存関係を最新の状態に保つ評価が「低」の依存関係の更新をマージ

プリセットはグラントを有効にすることはなく、既に設定済みの内容を追加することもありません。

プロジェクトでグラントの範囲を限定できる

組織で設定されたグラントはすべてのプロジェクトのデフォルトとなります。プロジェクトページでグラントを選択し、そのプロジェクトでの適用を無効にしたり、レベルを下げたり、制限を縮小したり、除外パスを追加したりできます。プロジェクトが組織よりも広い権限を得ることはできません。

CoRoidが自らグラントを停止した場合

  • 保留中。CoRoidのレビュー担当者やリスク判定基準が変更され、新しい条件での評価がまだ行われていないためです。評価が完了すれば、グラントは自動的に再び有効になります。
  • ブレーカーによって一時停止。グラントが許可したマージのうち、後から元に戻されたり修正されたりフォローアップされたものの割合が、同じプロジェクトで人間が行ったマージの割合よりも高くなった場合です。1回の失敗ではこの状態にはなりません。グラントには両方の件数が表示されます。人間が一時停止を解除し、その理由を記載します。

グラントがマージできる内容

マージ用のグラントは、対象となる作業の範囲を明示します。ただし、適用されるのはそのグラントのレベル以下に分類される変更のみです。

作業対象範囲
人間が依頼した作業人間が依頼したタスクのためにCoRoidが作成したpull request
目標に沿った作業あなたが設定した目標に基づきCoRoidが開始した作業のためのpull request
依存関係の更新DependabotやRenovateによるpull request(GitLabでは、プロジェクトやグループのアクセストークンを持つボットがrenovate/ブランチ)で作成したプルリクエストで、npmパッケージを更新し、同じバージョン系列のパッチ版またはマイナーバージョンへ移行し、公開から少なくとも7日経っており、新しいインストールスクリプトがなく、ロックファイルが一致しているもの。package.json、かつ未解決のセキュリティ勧告がないこと。このような更新は7日が経過すると低リスクと評価されます。
信頼できるユーザーpull requestとは、付与名を付けたメンバーによるもので、そのベース以降のすべてのコミットがそのメンバーのリンク済みGitHubアカウントから作成・コミットされ、かつGitHubが署名を検証した場合を指します。GitLab上では、そのメンバーのリンク済みGitLabアカウントが開いたマージリクエストにおいて、GitLabがすべてのコミットの署名を検証し、各コミットの作成者およびコミッターのメールアドレスがそのメンバーがGitLab上で確認したものと一致する場合に限ります。ウェブエディタで作成されたコミットや他者がプッシュしたコミットは、人の判断を待ちます。

付与のマージ方法

ファクトリー内のマージ計画では、付与が対象とするpull requestを指定します。CoRoidは今すぐマージ可能です。、そしてマージトレインがそれをマージします。マージが実行される瞬間に、CoRoidは再度マンデートを確認するため、一時停止、保留、使用限度超過、または計画作成後に新たなコミットが追加されるとマージが中断されます。

マージコミットには付与名とそのバージョンが記載されます。このマージは、付与で責任を負うと指定された人物にとっての履歴および付与の制限内での活動としてカウントされます。

裏側では、マージ計画が付与によるpull requestのマージを予定しており、最終的な判断は人が行います。

通知と停止

付与はマージに関する通知方法を定めます。

  • まず通知し、停止を待ちます。マージトレインがプルリクエストを処理すると、付与で責任を負う人物と作業を依頼した人物に通知が届きます。ウィンドウが閉じるまで、例えば10分後にはCoRoidがマージを実行しますが、誰かがボタンを押した場合は除きます。停止通知やマージ計画内、またはリンク済みアカウントを利用している場合はSlackやTelegramの投稿内でこのボタンを押すと、停止したpull requestは人の指示を待ちます。
  • 各操作の後マージが完了すると通知されます。

アカウントの連携

信頼できるユーザー向けの付与やCoRoidの承認機能では、どのGitHubまたはGitLabアカウントが自分のものかを把握する必要があります。SlackやTelegramでの停止機能も同様に、どのSlackまたはTelegramアカウントが自分のものかを知る必要があります。プロフィール → 連携アカウント、各アカウントを連携し、プラットフォームが確認します。CoRoidはアカウントのIDと名前のみを保持し、トークンは保存しません。GitLabの場合は、そこで確認した各メールアドレスのダイジェスト(実際のメールアドレスではありません)も保持し、これによりコミットが自分のものかを判断します。メールアドレスを追加した後は再び連携が必要です。連携解除これによりすべての情報が削除されます。組織が自己管理型のGitLabを接続している場合、オーナーまたは管理者が設定を完了すると、そのGitLab専用の項目が表示されます(GitLab上でのユーザーアカウントの連携)。

目標

「目標とは、CoRoidが独自に取り組むべき内容、対象プロジェクト、および使用可能な予算を示すものです。旧バージョンでは目標をマンデートと呼んでいました;目標ではその詳細を説明しています。

目標はCoRoidに目的と予算を与えます。目標が担当するシステムからの要求は、で説明されている手順に従って開始されます。作業が開始されるタイミング。CoRoidは目標の下で自らファイルを処理します。例えば、変更が期待した成果を得られなかった場合のフォローアップ作業には、有効な付与が必要です。作業を開始;それまでは人の指示を待ちます。セキュリティ関連の修正は例外で、セキュリティの設定に従って開始されます。

制限

付与の内容に関係なく、CoRoidが単独で行ってはならない事項:

  • 保護対象のパスこれらの変更はすべて人が決定します。CoRoidはサインインおよびアクセス、請求および支払い、秘密情報および認証情報、暗号化、データベースの移行、ロックファイル、CIパイプライン、コンテナおよびインフラを保護します。独自のパスを追加することも可能です。CoRoidが設定した制限を削除できるのはオーナーのみで、その理由は記録されます。
  • デプロイアクション付与が行える最大の操作:マージ、デプロイ、ロールバックであり、それぞれ許可、要求、または拒否が可能です。
  • 開いているプルリクエストCoRoidがプロジェクト内で開いている自身のプルリクエストの数です。上限に達すると、CoRoidが自ら開始した作業は待機状態になりますが、人の要求による作業は常に優先されます。
  • エージェントエージェントの処理範囲、および自動化処理やスケジュールによるタスク作成の可否。CoRoidのレビュー機能がpull requestをブロックするかどうかは付与で決定されます。

履歴

マンデートへの変更やその下で下された決定のすべてが、最新のものから順に記録されます:付与を公開または変更した人物、CoRoidに許可または禁止された操作とその理由、CoRoidが問い合わせた際の回答内容などです。

CoRoidがあなたに確認を求める場合

一部の操作には事前に人の回答が必要です。それぞれの項目は以下のセクションに記載されています。あなたの対応が必要ファクトリー内:CoRoidが実行を求める内容、対象、および理由。一度だけ承認これによりその操作を一回だけ実行できます。拒否これにより操作の実行を防ぎます。をご覧ください。ファクトリー。

変更可能な人物

オーナーや管理者はマンデートを変更できます。メンバーはそれをすべて閲覧可能です。CoRoid自体のエージェントやサービスアカウントは、一切変更できません。

グラントに基づいて下されたすべての決定内容は、CoRoidの情報と共に、そのグラントおよびバージョンも含めて組織の監査ログに記録されます。