LinuxでのLocal VM Scannerのセットアップ

Aikido VM Scanner は、システムにインストールする単一のパッケージで、依存関係を自動的にスキャン・識別し、環境の詳細なビューを提供します。

前提条件

最小システム要件: 最低 1GB の RAM。
推奨システム要件: 最低 2GB の RAM と 4 CPU。
システムに sudo / 管理者権限があることを確認してください
お使いのシステムやクラウドプロバイダーに適したコマンドを使用してください
root で実行する必要がある場合は、以下のように AIKIDO_TOKEN 環境変数を sudo の後に置いてください:
sudo AIKIDO_TOKEN=REPLACE_ME <install_command>

インストールとアップグレード

必ず sudo で実行し、AIKIDO_TOKEN を Aikido の Local VM scanning ページにある有効なトークンに置き換えてください。VM 環境(後で Aikido 上で確認できます)を指定するには、VM_TYPE 変数に production、staging、development のいずれかを設定することもできます。

VM Scanner Agent は 1 日に 1 回、午前 4:00 ～ 8:00(マシン時刻)の間のランダムな時刻に実行されます。

インストール後、最初のスキャンが自動的に開始されます。オンデマンドで実行したい場合は、以下を手動で実行できます。

/opt/aikido-vm-scanner-1.4.4/aikido-vm-scanner

Red Hat系システム(RHEL、CentOS、Fedora)の場合

x86_64

AIKIDO_TOKEN=REPLACE_ME VM_TYPE=production dnf install -y https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.4.4/aikido-vm-scanner.x86_64.rpm

Hash	aikido-vm-scanner.x86_64.rpm
MD5	0b7db4a7a77fd57d330c4b7e39b04264
SHA256	c56d375445e920d1f8870dc24dba40dfec06a7f7e761df1f916932a17eb98ee5

aarch64

AIKIDO_TOKEN=REPLACE_ME VM_TYPE=production dnf install -y https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.4.4/aikido-vm-scanner.aarch64.rpm

Hash	aikido-vm-scanner.aarch64.rpm
MD5	01b289dd41e2a2005ea864fb12f677be
SHA256	98c5ab94bd1b307d9670b73e98536dc3e876d7d5583481486fe0de976f178a6f

Debian系システム(Debian、Ubuntu)の場合

x86_64

curl -L -O https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.4.4/aikido-vm-scanner.amd64.deb
AIKIDO_TOKEN=REPLACE_ME VM_TYPE=production apt-get install -y ./aikido-vm-scanner.amd64.deb

Hash	aikido-vm-scanner.amd64.deb
MD5	54900ac3e8ec9cd95e893dfd0e1a2de5
SHA256	158cc661fe2f55f6254d1ec1dd6f1d6dc053499ef509cb5c59b48f0a1e526754

aarch64

curl -L -O https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.4.4/aikido-vm-scanner.arm64.deb
AIKIDO_TOKEN=REPLACE_ME VM_TYPE=production apt-get install -y ./aikido-vm-scanner.arm64.deb

Hash	aikido-vm-scanner.arm64.deb
MD5	2121aa77a82767a5ca4b21d4da993c9a
SHA256	a0e16051c7bc96e5eb050daed72512df1c2b11b73c4ec7dd66a2ef5a4fe7591f

追加設定

トークンの設定

何らかの理由でインストール時に AIKIDO_TOKEN を設定できない場合、インストール後に以下の2つの方法のいずれかでトークンを設定できます。

トークンを /opt/aikido-vm-scanner-1.4.4/.token に貼り付ける
/opt/aikido-vm-scanner-1.4.4/config.json の内容を変更する:

{
    "api_key": "AIKIDO_TOKEN_HERE",
    "exclude": []
}

ホスト名の変更

デフォルトでは、スキャン対象マシンのホスト名を自動的に取得し、Virtual Machines タブに表示するために Aikido に送信します。

報告されるホスト名を変更したい場合は、設定ファイルを使用して行うことができます。

{
    "hostname": "YOUR_HOSTNAME_HERE",
    "exclude": []
}

ファイルやパスの除外

config.json では、除外リストに項目を追加することでファイルやパスを除外できます。以下にいくつかの例を示します。

ディレクトリ内の単一ファイルを除外する:

{
    "exclude": [
        ...
        "./home/testing/app/package.json",
    ]
}

すべてのリリースサブディレクトリを除外する:

{
    "exclude": [
            ...
            "./home/testing/*/releases",
    ]
}

out フォルダおよびすべてのサブディレクトリ内の .json ファイルをすべて除外する:

{
    "exclude": [
        ...
        "./out/**/*.json",
    ]
}

スキャン対象からカタロガーを除外する(例: Golang カタロガーを除外):

{
    "exclude": [
    ],
    "select_catalogers": "-go"
}

出力チャネル

VM scanner の出力チャネルを制御したい場合は、インストール時に OUTPUT 変数を stdout、stderr、none のいずれかに指定できます。

rpm x86_64 の例:

AIKIDO_TOKEN=REPLACE_ME VM_TYPE=production OUTPUT=stderr dnf install -y https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.4.4/aikido-vm-scanner.x86_64.rpm

初回スキャンの無効化

rpm/deb パッケージがインストールされると、自動的に初回スキャンがトリガーされます。
この機能を無効にしたい場合は、インストール時に INITIAL_SCAN パラメータを 0 に設定してください。以下のようにします。

AIKIDO_TOKEN=REPLACE_ME INITIAL_SCAN=0 dnf install -y https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.4.4/aikido-vm-scanner.x86_64.rpm

CLI パラメータ

何らかの理由でコマンドラインからオンデマンドでスキャンを開始する必要がある場合、そのスキャンで使用する以下の CLI パラメータを指定できます。

  --api-key string
        API key for authentication
  --hostname string
        Hostname of the machine
  --select-catalogers string
        Comma-separated list of catalogers to use or remove
  --vm-type string
        Type of the virtual machine

これらの CLI パラメータは、config.json で指定されたものより優先されます。

CLI 経由でカスタムホスト名を設定する例:

/opt/aikido-vm-scanner-1.4.4/aikido-vm-scanner --hostname "My Custom VM"

CLI 経由で Golang カタロガーを除外する例:

/opt/aikido-vm-scanner-1.4.4/aikido-vm-scanner --select-catalogers "-go"

アンインストール

手動アンインストール

Red Hat系システム(RHEL、CentOS、Fedora)の場合

dnf remove -y aikido-vm-scanner

Debian系システム(Debian、Ubuntu)の場合

apt-get remove -y aikido-vm-scanner

ログ

ログは、最後に生成された SBOM とともに /var/log/aikido-vm-scanner-1.4.4 にあります。