AVM Docs
ドキュメント
AVM のドキュメントは、実際の運用に沿って構成されています。 アプリケーションの起動方法、コアコンセプトの理解、 インベントリデータのインポート、canonical reference へのリンク、 そしてアラートの確認までを順にたどれます。
AVM を試す
ライブデモ
あらかじめデータが投入された環境で AVM を試せます。セットアップは不要です。
🔒 アクセス用認証情報は公式アナウンスで案内します。
おすすめの読み進め方
AVM を初めて使う場合は、この順番で読むのがおすすめです。 基本的な利用方法から始めて、コアモデルを理解し、 その後に運用ワークフローへ進む流れになっています。
1. Getting Started
AVM をローカルで起動し、UI を開き、 asset から alert までの最初のワークフローを理解します。
2. Concepts
AVM の主要な考え方を学びます。 具体的には、asset、software、alias、 canonical linking、vulnerability、alert です。
3. Matching
正規化、canonical linking、version-aware evaluation を通じて、 AVM が raw software inventory をどのように レビュー可能な findings に変えるのかを確認します。
ドキュメントマップ
Docs は、セットアップ、概念、運用、構造の観点で分かれています。
Getting Started
AVM を起動し、最初の運用フローを理解するための もっとも早い入り口です。
Concepts
プロジェクトの基本的な考え方と、 なぜ AVM がブラックボックスな matching を避けるよう設計されているのかを説明します。
Matching
AVM が software record と vulnerability data を どのように対応付けるのかを段階的に説明します。
Import
CSV と JSON のインベントリが、 preview 可能な staged workflow を通じて どのようにシステムへ入るのかを説明します。
Admin
sync job、未解決レビュー、alias maintenance、 recalculation、運用設定を説明します。
Data Model
AVM の構造を説明します。 asset、software、canonical reference、 vulnerability、alert、run が対象です。
目的別に読む
AVM をローカルで試したい
Getting Started から始めてください。
設計思想を理解したい
Concepts を読み、 その後に Data Model を読むのがおすすめです。
なぜ alert が存在するのか理解したい
Matching を読んでください。
inventory を取り込みたい
Import を読んでください。
システムを運用・保守したい
Admin を読んでください。
構造全体を把握したい
Data Model を読んでください。
この Docs で期待できること
運用重視
これらの Docs は、コードを読むためだけではなく、 システムを使い、理解するために書かれています。
確認可能なロジック
AVM は aliasing、canonical linking、alert generation を 理解しやすい形で見せることを目指しています。
段階的な拡張
ドキュメント構成は、全面的な再設計をしなくても ページごとに拡張していけるようにしています。
オープンソース向け
contributor、evaluator、operator が プロジェクトを素早く理解できるような構成を意図しています。
ドキュメントの原則
Inspectable
AVM は、何を match したのか、なぜ match したのか、 どこに review が必要なのかを説明できるべきです。
Operational
Docs は、実装詳細を説明するだけでなく、 operator がシステムを使えるよう支援するものであるべきです。
Structured
Concepts、workflow、data structure は、 ページをまたいでも明確につながっているべきです。
Practical
重要なページは、まず実際の利用上の疑問に答えるものであるべきです。