エージェントのインストールと管理

Classic/VPC環境で利用できます。

エージェントのインストールと管理で、エージェントのサポート環境とインストール方法について説明します。また、エージェントに使用するコマンドとエージェントに関連して発生し得る問題の解決策を説明します。

エージェントのサポート環境

エージェントのサポート環境は次の通りです。

• 韓国

• シンガポール

• 日本

エージェントのインストール

SourceDeployを利用してサーバにリリースするには、当該サーバに SourceDeploy用のエージェントがインストールされている必要があります。

エージェントをインストールするには、以下の手順に従って行います。

• 1. API認証キー作成
• 2. インストールコマンド作成

1. API認証キー作成

エージェントをインストールして使用するには、API認証キーが必要です。

API認証キーを作成する方法は、次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。
2. 画面右上の My Account > アカウントとセキュリティ管理メニューを順にクリックします。
3. ログインパスワードを入力した後、 [確認] ボタンをクリックします。
4. セキュリティ管理 > アクセス管理メニューを順にクリックします。
5. [新規 API認証キー作成] ボタンをクリックします。
   • 作成された APIがリストに表示されます。

2. インストールコマンド作成

インストールコマンドはサーバにアクセスして作成するか、Init Scriptで作成できます。

作成方法に応じて以下をご参照ください。

• サーバアクセス後に作成
• Init Scriptに作成

サーバアクセス後に作成

インストールコマンドをサーバにアクセスして作成・実行する方法は、次の通りです。

1. SourceDeployリリースプロジェクトに設定したリリースターゲットサーバにアクセスします。
2. 以下を参照してコマンドを入力します。

       echo $ 'NCP_ACCESS_KEY=accesskey\nNCP_SECRET_KEY=secretkey' > /opt/NCP_AUTH_KEY
   chmod 400 /opt/NCP_AUTH_KEY
       chmod 400 /opt/NCP_AUTH_KEY
       wget --header="x-ncp-region_code:region" "Agentのダウンロードアドレス"
       chmod 755 install
       ./install
       rm -rf install
   

   • 「accesskey」に1.API認証キー作成で作成した API認証キーの Access Key IDを入力します。
   • 「secretkey」に1.API認証キー作成で作成した API認証キーの Secret Keyを入力します。
     • Secret Keyは、 [見る] ボタンをクリックすると確認できます。
     注意

     API認証キーは、使用中のキーを使用する必要があります。使用停止ステータスのキーを使用する場合、エージェントは正常に動作していても認証に失敗するため、SourceDeployを介したリリースが正常に行われません。
     使用停止のキーを使用するには、 [使用する] ボタンをクリックしてステータスを使用中に変更してください。

   • Agent 다운로드 주소に使用リージョンと環境に該当するエージェントのダウンロードアドレスを入力します。

     環境	リージョン	Agentのダウンロードアドレス	ヘッダ情報
     VPC	韓国(KR)	https://sourcedeploy-agent.apigw.ntruss.com/agent/vpc-v2/download/install	x-ncp-region_code:KR
     	シンガポール(SGN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/vpc-v2/download/install	x-ncp-region_code:SGN
     	日本(JPN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/vpc-v2/download/install	x-ncp-region_code:JPN
     Classic	韓国(KR)	https://sourcedeploy-agent.apigw.ntruss.com/agent/v3/download/install

   • NCP_AUTH_KEYは、サーバ内の/optディレクトリに以下のように作成される必要があります。
     

Init Scriptに作成

インストールコマンドを Init Scriptに作成した場合、Serverまたは Auto Scalingに登録する必要があります。

インストールコマンドを Init Scriptに作成した後、Serverまたは Auto Scalingに登録する方法は、次の通りです。

1. NAVERクラウドプラットフォームコンソールで、 > Services > Compute > Serverメニューを順にクリックします。
2. Init Scriptメニューをクリックします。
3. [Script作成] ボタンをクリックします。
4. Script名を入力し、OSタイプを選択します。
5. 以下を参照して Scriptを作成します。

   #!/bin/bash
   echo $ 'NCP_ACCESS_KEY=accesskey\nNCP_SECRET_KEY=secretkey' > /opt/NCP_AUTH_KEY
   chmod 400 /opt/NCP_AUTH_KEY
   wget --header="x-ncp-region_code:region" "Agentのダウンロードアドレス"
   chmod 755 install
   ./install
   rm -rf install
   

   • accesskeyに1.API認証キー作成で作成した API認証キーの Access Key IDを入力します。
   • secretkeyに1.API認証キー作成で作成した API認証キーの Secret Keyを入力します。
     • Secret Keyは、 [見る] ボタンをクリックすると確認できます。
     注意

     API認証キーは、使用中のキーを使用する必要があります。使用停止ステータスのキーを使用する場合、エージェントは正常に動作していても認証に失敗するため、SourceDeployを介したリリースが正常に行われません。
     使用停止のキーを使用するには、 [使用する] ボタンをクリックしてステータスを使用中に変更してください。

   • Agentのダウンロードアドレスに、動作環境とリージョンに当てはまるエージェントのダウンロードアドレスを入力します。

     環境	リージョン	Agentのダウンロードアドレス	ヘッダ情報
     VPC	韓国(KR)	https://sourcedeploy-agent.apigw.ntruss.com/agent/vpc-v2/download/install	x-ncp-region_code:KR
     	シンガポール(SGN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/vpc-v2/download/install	x-ncp-region_code:SGN
     	日本(JPN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/vpc-v2/download/install	x-ncp-region_code:JPN
     Classic	韓国(KR)	https://sourcedeploy-agent.apigw.ntruss.com/agent/v3/download/install

6. [Script作成] ボタンをクリックします。
7. 作成した Init Scriptを Serverまたは Auto Scalingに登録します。
   • Serverに登録するには、Serverメニューをクリックします。
     • [サーバ作成] ボタンをクリックすると、Init Scriptを登録できます。Serverの詳しい作成方法は、Server作成ガイドをご参照ください。
   • Auto Scalingに登録するには、 > Services > Compute > Auto Scaling > Launch Configurationメニューを順にクリックします。
     • [Launch Configuration作成] ボタンをクリックすると、Init Scriptを登録できます。詳細な Launch Configurationの作成方法は、Launch Configuration作成ガイド(Classic)、Launch Configuration作成ガイド(VPC)をご参照ください。

エージェントの実行コマンド

エージェントの実行コマンドは次の通りです。

エージェントの起動

service sourcedeploy start

エージェントの停止

service sourcedeploy stop

エージェントのステータス確認

service sourcedeploy status

エージェントの再起動

service sourcedeploy restart

エージェントのプロセス確認

エージェントのプロセスを確認してエージェントが正常に実行されるか確認できます。

エージェントプロセスの正常実行基準は次の通りです。

• プロセス1個実行

ps -ef | grep main.py

エージェント削除

エージェントを削除する方法は次の通りです。

1. エージェントがインストールされたサーバにアクセスしてエージェントを停止します。
   • エージェントの停止コマンドは次の通りです。

     service sourcedeploy stop
     

2. エージェントプロセスを確認して動作しているプロセスをすべて削除します。
   • エージェントプロセスの確認、削除コマンドは次の通りです。

     ps -ef | grep main.py
     

     kill -9 PID(ex.3587)
     

3. インストールされたエージェントファイルを削除します。
   • エージェントファイルの削除コマンドは次の通りです。

     rm -rf /opt/sdagent
     

エージェントのトラブルシューティング

エージェントとの接続に失敗した場合

• エージェントのステータス確認コマンドを入力してエージェントが正常にインストールされたかどうか確認します。

  service sourcedeploy status
  

  

• インストールされたエージェントのバージョンを確認します。

  cat /opt/sdagent/Agent.ver
  

  例) 2021/05/27基準

  [VERSION]
  ver=2021/05/18/01
  

  • インストールされたエージェントのバージョンが古いバージョンである場合、エージェントを削除してから再インストールします。
    • エージェントの削除は、エージェント削除をご参照ください。

• Init Scriptにエージェントのインストール URLが以下のように入力されたか確認します。

  • 使用環境とリージョンに応じたエージェントのダウンロードアドレスは、次の通りです。

    環境	リージョン	Agentのダウンロードアドレス	ヘッダ情報
    VPC	韓国(KR)	https://sourcedeploy-agent.apigw.ntruss.com/agent/vpc-v2/download/install	x-ncp-region_code:KR
    	シンガポール(SGN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/vpc-v2/download/install	x-ncp-region_code:SGN
    	日本(JPN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/vpc-v2/download/install	x-ncp-region_code:JPN
    Classic	韓国(KR)	https://sourcedeploy-agent.apigw.ntruss.com/agent/v3/download/install

    wget --header="x-ncp-region_code:region" "Agentのダウンロードアドレス"
    

• サーバのステータスが運用中になっているか確認します。

エージェントプロセスが正常に実行されない場合

• 再起動コマンドを入力してエージェントを再起動してください。

  service sourcedeploy restart
  

• 再起動しても正常に動作しない場合は、下記の Linuxパッケージをインストールした後、エージェントを再インストールしてください。

  # CentOS, Rocky
  sudo yum install -y epel-release ca-certificates openssl-devel zlib-devel
  # Ubuntu
  sudo apt-get install -y build-essential ca-certificates libssl-dev zlib1g-dev
  

エージェントがインストールされない場合

• 認証キー値が正常に入力されたか確認します。

  cat /opt/NCP_AUTH_KEY
  

• Init Scriptの最初の行に、#!/usr/bin/env python、#!/bin/perl、#!/bin/bash などの形式で実行しようとするスクリプトパスを指定したか確認します。