別紙:エージェントのインストール手順

M:Arthurのログインサーバーに、エージェントをインストールする手順をご説明します。

1. はじめに

本手順は、M:Arthurに利用するエージェントをお客様の環境にインストールするための手順です。
本手順を実施するのはログインサーバーのみになります。

本手順を実施するにあたって、OpenPBSまたはSlurmがすでにインストールされている必要があります。
その他の前提条件につきましては、別紙:前提とする設定についてをご確認ください。

以下の　2.　以降の手順で、エージェントのインストールをお願いいたします。

2. [お客様作業]アクティベーションコードの発行

お客様から管理者のメールアドレス等をご連絡頂いた後、弊社にてお客様のアカウントを作成いたします。 作成後、メールにてログイン情報をお送りいたします。

  • 弊社からお送りする情報
    • 管理コンソールのログインURL
    • 登録Eメールアドレス
    • パスワード

上記の情報を基にログインできましたら、本マニュアルのアクティベーション作成とログインサーバー登録の章を参考にアクティベーションを作成します。
以下の情報がお手元にあることを確認して、次の手順に進みます。

  • アクティベーション時に実行するコマンド
    • コマンドにアクティベーション情報が含まれています。

3. [お客様作業]エージェントインストールの実施

3.1.~3.2.の手順で、エージェントのインストールをお願いいたします。

3.1. コマンドのコピー

管理コンソールのアクティベーションコード発行画面(【Setting】>【Server】>【Activation】)で、追加した行の右端のコピーアイコン(下図の赤枠)を押下すると、実行するコマンドがクリップボードにコピーされます。
アイコンにマウスを合わせると、コピーされるコマンドが表示されます。

activation_copy_icon

コピーされるコマンドには、アクティベーションコード(--code)、アクティベーションID(--id)と、アクティベーションの作成時に選んだHPC Type(--hpc)が含まれています。コマンドを手で書き換える必要はありません。
アクティベーションの作成のしかたは、アクティベーション作成とログインサーバー登録をご確認ください。

3.2. コマンドの実行

コピーしたコマンドを、ログインサーバーで実行します。
コマンドは1行で、下記のような内容です(--code・--id の値は、アクティベーションごとに異なります。--hpc は、アクティベーションで選んだジョブスケジューラーの種類で、pbs または slurm です)。

$ curl -fsSL https://agent.m-arthur.com/install.sh | sudo -E sh -s -- --code "xxxxx" --id "xxxxx" --hpc pbs

このコマンドは、弊社の登録スクリプトをダウンロードして実行します。登録スクリプトは、次の作業をすべて行います。OSごとにコマンドを使い分ける必要はありません。

  • エージェント(amazon-ssm-agent)のインストールと、M:Arthurへの登録(AWSが提供する登録ツールを使い、エージェントの署名も検証します)
  • CloudWatch Agent(amazon-cloudwatch-agent)のインストールと、ジョブのログ(OpenPBSのサーバーのログ、またはSlurmのログ)を収集するための設定・起動
  • Proxyを入力した場合は、エージェントがProxyを利用するための設定
  • 登録と、エージェント・CloudWatch Agentの起動の確認

正常に終了すると、最後に下記のように表示されます。数分後に、管理コンソールのサーバーの一覧に表示されます。

[M:Arthur] CloudWatch Agent is running.
[M:Arthur] Completed. Managed instance ID: mi-xxxxxxxxxxxxxxxxx
[M:Arthur] The server will appear in the management console in a few minutes.
  • 実行には、sudoの権限と、curlが必要です。rootユーザーで実行する場合も、そのまま実行いただけます。
  • ログインサーバーから agent.m-arthur.com と *.amazonaws.com へのHTTPS(443番ポート)の通信が必要です。
  • 対応しているCPUアーキテクチャは、x86_64 と aarch64 です。
  • すでに登録済みのサーバーで実行した場合は、登録は変更されず、エージェントの再起動と、CloudWatch Agentの設定のみが行われます。
  • CloudWatch Agentの設定は、AlmaLinux / Rocky Linux などのRHEL系のOSと、Ubuntu / Debianに対応しています。
  • WARNING: --hpc is not given と表示された場合は、ジョブのログが収集されません。アクティベーションコード発行画面から、コマンドをコピーし直して実行してください。

以上でインストール作業は完了です。
User Guideに沿って運用を開始いただけます。

4. インストールできなかった場合

登録スクリプトは、実行のたびに、画面に表示した内容と、サーバーの環境の情報をログファイルに記録します。インストールできなかった場合は、必要な通信先に接続できるかの確認の結果と、エージェントのログなども合わせて記録します。

  • ログファイル: /var/lib/m-arthur/agent-install.log(rootのみ読み取り可)
  • アクティベーションコードと、Proxyのユーザー名・パスワードは、ログには記録されません(**** と記録されます)

インストールできなかった場合は、画面に Installation failed と表示されます。下記のコマンドでログファイルを取り出し、弊社サポートまでお送りください。

$ sudo cp /var/lib/m-arthur/agent-install.log ~/m-arthur-agent-install.log && sudo chown "$USER" ~/m-arthur-agent-install.log