メインコンテンツまでスキップ

Dockerインストール及び起動 - v3.0.25以上

目次​

  • [exem-ndm-agent] インストール準備
  • [exem-ndm-agent] インストール
  • [exem-ndm-agent] 実行
  • [exem-ndm-agent] パッチ
  • [exem-ndm-agent] Silent インストール

▶ [exem-ndm-agent] インストール準備

  • Linux インストールファイル
    • setup_exem-ndm-agent_[バージョン].bin
  • root 権限
危険

NDM Agent は root 権限で実行される必要があります。 したがって、インストール時は root 権限で進める必要があります。

▶ [exem-ndm-agent] インストール

◈ インストール進行中のデータ入力参考事項​

  • 入力文言の最後の角括弧の内側が default として適用される。何も入力しない場合は角括弧内部の値を使用
    • ex) Enter EXEM_HOME[/root/exem]: ➝ 入力しない場合はデフォルト値を使用

❶ setup ファイル実行​

① [ install(patch) ] 選択

❷ [ exemONE ] エージェント追加​

  • NDM Agent サービス登録のための API Token 発行
    • ① : ネットワークデバイス選択
    • ② : エージェント名 登録
    • ③ : 更新により エージェント ID 及び アクセストークン を発行
    • ④⑤ : エージェント ID 及び アクセストークン を別途保存した後、NDM Agent インストール時に入力必須
    • ⑥ : 有効化後に保存
      • 有効化しないと収集されません。

❸ インストールオプション設定​

NONameRequiredDefaultDescription
①EXEM_HOMEOsetup ファイル実行位置に exem フォルダを追加exemONE agent をインストールするディレクトリ設定
②RECEIVER_IPOX (デフォルト値なし)ndm agent と接続する receiver の ip
③RECEIVER_PORTO9010ndm agent と接続する receiver の port
④AGENT_NAMEOndm-agent[ exemONE エージェント追加 ] エージェント名 入力
⑤AGENT_IDOX (デフォルト値なし)[ exemONE エージェント追加 ] エージェント ID 入力
⑥ACCESS_TOKENOX (デフォルト値なし)[ exemONE エージェント追加 ] アクセストークン 入力

⑦ オプションをすべて入力すると、設定確認後に次の段階へ進行

❹ インストール完了​

① Docker イメージ Load 及びインストール完了

▶ [exem-ndm-agent] 実行

❶ 実行/停止方法​

  • ${EXEM_HOME}/ndm ディレクトリの start.sh と stop.sh を使用して実行/停止

❷ 正常実行確認方法​

  • docker ps

❸ バージョン確認方法​

  • [簡単なバージョン確認方法] ${EXEM_HOME}/ndm/pkg_version.sh

  • [詳細なバージョン確認方法] docker exec < Container_ID > /home/exemone/bin/exem-ndm-agent -v

▶ [exem-ndm-agent] パッチ

備考

◈ 既存に実行中の ndm agent がある場合は終了後、下記の手順に従ってパッチ

◈ パッチ注意事項

  • パッチ進行時は既存に設定した ${EXEM_HOME} ディレクトリを変更せずに進める必要がある
    • パッチ時に ${EXEM_HOME}/ndm/data/ndm_id ファイルが維持されてこそ、既存と同一の ndm として認識
      • 該当ファイルがない場合は新規インストールを進行 新規エージェント_ID、アクセストークンの入力が必要
      • 手動パッチ時は該当ファイルをバックアップして ${EXEM_HOME}/ndm/data フォルダに保存した後に起動する必要がある
  • setup ファイルの patch メニュー使用時は自動的に既存の ndm_id を維持するため、setup ファイルを使用したパッチを推奨

❶ setup ファイル実行​

  • インストールオプション選択
    • ① [ install(patch) ] 選択

❷ インストールオプション設定​

① 設定していた EXEM_HOME を入力

  • setup ファイルが実行された位置を基準に default 値が設定される

② すでにインストールされているかを確認した後、パッチの可否を選択

③ EXEM_HOME を除いた残りのオプションは既存にインストールしていたオプションどおりに default 値が設定される

④ インストール以降に変更されたオプション(ex. RECEIVER_IP/PORT)は反映されないため、該当の設定値を必ず確認した後に進行

❹ パッチ完了​

① 既存バージョン → 新規バージョン適用確認

② Docker イメージ Load 及びインストール完了

▶ [exem-ndm-agent] Silent インストール

▣ インストール時に入力する設定をあらかじめ定義しておき、インストールを速く進行可能​

❶ setup_exem_ndm.silent 設定ファイル生成​

  • インストールに必要な設定を下記の表を参考に setup_exem_ndm.silent ファイル内にあらかじめ作成
NameDefaultDescription
INSTALL_PATH\<current path>/exemexem-ndm-agent をインストールする位置(path)
APP_NAMEndm-agentexem-ndm-agent の名前
RECEIVER_IPなし(必須入力)exem-ndm-agent と接続する receiver の IP
RECEIVER_PORT9010exem-ndm-agent と接続する receiver の PORT
AGENT_IDagent id登録された exem-ndm-agent の ID (再インストール時に設定)
ACCESS_TOKENaccess token登録された exem-ndm-agent の TOKEN (再インストール時に設定)
  • setup_exem_ndm.silent 例
root ~# cat setup_exem_ndm.silent 
INSTALL_PATH=/root/exem/ndm
APP_NAME=ndm-agent
RECEIVER_IP=10.20.30.40
RECEIVER_PORT=9010
AGENT_ID=6fd1c0c0-test-test-test-6d42d41fe5ad
ACCESS_TOKEN=9252a5b3-test-test-test-67012383f8b5

❷ setup ファイル及び設定ファイルでインストール実行​

  • setup ファイルのパラメータとして ❶ setup_exem_ndm.silent 設定ファイルで生成したファイルを入力
./setup_exem-ndm-agent_3.0.25.2.bin ./setup_exem_ndm.silent

❸ インストール結果​

=====================================================
EXEM NDM Agent Docker Installer
=====================================================
=====================================================
Package extracted to: /root/temp_ndm_setup
Package version: 3.0.25.2
exemOne NDM Agent Docker Installer
=====================================================
Already installed in [/root/exem/ndm]. Patching?[Y]: Y

=====================================================
Existing version: 3.0.25.2
New version: 3.0.25.2
=====================================================
Loading Docker image...
Loaded image: maxgauge/exem-ndm-agent:v3.0.25.2
Docker image loaded: maxgauge/exem-ndm-agent:v3.0.25.2
=====================================================
Patch completed
=====================================================
VERSION=3.0.25.2
NDM_HOME=/root/exem/ndm
IMAGE=maxgauge/exem-ndm-agent:v3.0.25.2
RECEIVER_ADDR=10.20.30.40:9010
AGENT_ID=6fd1ad30-6b6e-test-test-6d4afd4fe5ad
START_SCRIPT_PATH=/root/exem/ndm/start.sh
STOP_SCRIPT_PATH=/root/exem/ndm/stop.sh
=====================================================
xmSuccess(0): patch completed