yamory の使い方

yamory へようこそ! yamory の基礎知識と使い方をご紹介します。

exec

exec コマンドついて、以下に記します。

概要

exec コマンドは yamory-cli をインストールしたローカルホストのスキャンを行ないます。

スキャンにはアクセストークンが必要です。
アクセストークンは、チーム設定画面より発行できます。
発行手順などはこちらを参照してください。

アクセストークンは、コマンドフラグで指定してください。

コマンドフラグ

フラグ 必須 説明
--token/-T ホストスキャンのアクセストークン
--title/-t yamory サービス上表示されるスキャン対象の名前 (省略時は hostname コマンドの値)
--identifier/-i ホスト識別子。ホスト識別子には 半角英数字, -, _ のみ使用できます。
--distribution/-d ホストの OS
--version/-v ホストのバージョン
--openSystem/-o 公開ホストの設定を true または false で指定
--tags ホストタグ名をカンマ区切りで指定
--useSudo スキャン時に sudo を使用するか否かを指定。デフォルト true

--identifier フラグについて

yamory のホストスキャン機能では、ホストの一意性を特定するためにマシン ID(/etc/machine-id の値)を使用していますが、クラウド環境などでコピーしたイメージを利用する際にマシン ID が同値となり、意図せずスキャン結果を上書きしてしまうことがあります。
そのような場合に --identifier フラグを設定することでスキャン情報の上書きを回避できます。
--identifier フラグには、チーム内でホストごとに一意の値になるように設定してください。

--distribution フラグ、および --version フラグについて

ホストの OS(--distribution フラグ)、およびバージョン(--version フラグ)が指定されている場合、 OS の自動判別が無効になります。
なお、現在 --distribution フラグに指定できる値は以下の通りです。

  • Amazon Linux: amazon-linux
  • CentOS: centos
  • Debian: debian
  • Oracle Linux: oracle-linux
  • Red Hat Enterprise Linux: redhat
  • Ubuntu: ubuntu

--openSystem フラグについて

公開ホスト(外部ネットワークからパブリックアクセスが可能なホスト)として使用するかを指定することができます。
公開ホストの場合は true、非公開ホストの場合は false を指定します。
--openSystem フラグが未指定の場合、前回スキャン情報があればその状態を引き継ぎ、初回スキャン時は公開ホストとして登録されます。
本パラメータはトリアージレベルの計算に使用されます。

--useSudo フラグについて

yamory のホストスキャンでは、一部のディストリビューションにおいてホスト情報を取得するコマンドを実行する際に
no password で sudo コマンドを実行できるか確認し、実行できる場合、sudo コマンドを使用してホスト情報を取得しています。
スキャンを実行するユーザーにコマンドの実行制限がない場合、 --useSudo フラグに false を指定すると sudo を使用せずにスキャンすることができます。
--useSudo フラグ は以下のディストリビューションでのみ有効です。

  • Amazon Linux
  • CentOS
  • Oracle Linux
  • Red Hat Enterprise Linux