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

印刷する
共有
PDF

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

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

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

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

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

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

項目	サポート環境
ターゲットサーバ	NAVERクラウドプラットフォームで作成した Serverまたは Auto Scaling Group
OS	CentOS, Ubuntu, Rocky
Pythonバージョン	2.6、2.7バージョン

参考

NAVERクラウドプラットフォームの Secure Zone内に作成したサーバは、SourceDeployでリリースすることはできません。

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

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

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

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

1. API認証キー作成

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

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

NAVERクラウドプラットフォームポータルにアクセスします。
マイページ > アカウント管理 > 認証キー管理 メニューを順にクリックします。
ログインパスワードを入力し、 [確認] ボタンをクリックします。
[新規 API認証キー作成] ボタンをクリックします。

作成された APIがリストに表示されます。

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

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

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

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

注意

コンソールで Init Scriptを作成してエージェントをインストールする場合、プロジェクトを作成する前に Init Scriptにインストールコマンドを作成し、リリースターゲットとなる Serverまたは Auto Scalingの作成時に登録してください。

サーバアクセス後に作成

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

SourceDeployリリースプロジェクトに設定したリリースターゲットサーバにアクセスします。
以下を参照してコマンドを入力します。
```
echo $'NCP_ACCESS_KEY=accesskey\nNCP_SECRET_KEY=secretkey' > /opt/NCP_AUTH_KEY
chmod 400 /opt/NCP_AUTH_KEY
Wget 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/download/install
	シンガポール(SGN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/sg-v1/download/install
	日本(JPN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/jp-v1/download/install
Classic	韓国(KR)	https://sourcedeploy-agent.apigw.ntruss.com/agent/v2/download/install

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

Init Scriptに作成

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

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

NAVERクラウドプラットフォームコンソールにアクセスします。
Services > Compute > Server メニューを順にクリックします。
Init Script メニューをクリックします。
[Script作成] ボタンをクリックします。
Script名 を入力し、OSタイプ を選択します。
以下を参照して Script を作成します。
```
#!/bin/bash
echo $'NCP_ACCESS_KEY=accesskey\nNCP_SECRET_KEY=secretkey' > /opt/NCP_AUTH_KEY
chmod 400 /opt/NCP_AUTH_KEY
Wget 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/download/install
	シンガポール(SGN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/sg-v1/download/install
	日本(JPN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/jp-v1/download/install
Classic	韓国(KR)	https://sourcedeploy-agent.apigw.ntruss.com/agent/v2/download/install

[Script作成] ボタンをクリックします。
作成した 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

devtools-devtools-4-4_process

エージェント削除

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

エージェントがインストールされたサーバにアクセスしてエージェントを停止します。
- エージェントの停止コマンドは、次の通りです。
```
service sourcedeploy stop
```
エージェントプロセスを確認して動作しているプロセスをすべて削除します。
- エージェントプロセスの確認および削除コマンドは、次の通りです。
```
ps -ef | grep main.py
```
```
kill -9 PID(ex.3587)
```
インストールされたエージェントファイルを削除します。
- エージェントファイルの削除コマンドは、次の通りです。
```
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/download/install
	シンガポール(SGN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/sg-v1/download/install
	日本(JPN)	https://sourcedeploy-agent.apigw.ntruss.com/agent/jp-v1/download/install
Classic	韓国(KR)	https://sourcedeploy-agent.apigw.ntruss.com/agent/v2/download/install

Wget Agentのダウンロードアドレス

サーバの状態が 運用中 になっているか確認します。

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

参考

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

プロセス1個実行

再起動コマンドを入力してエージェントを再起動してください。
```
service sourcedeploy restart
```
再起動しても正常に動作しない場合、エージェントを再インストールしてください。

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

有効な認証キーが入力されたか確認します。
```
cat /opt/NCP_AUTH_KEY
```
Init Scriptの最初の行に、#!/usr/bin/env python、#!/bin/perl、#!/bin/bashなどの形式で実行しようとするスクリプトパスを指定したか確認します。

この記事は役に立ちましたか?

What's Next

SourceDeploy のリソース管理

エージェントのサポート環境
エージェントのインストール
エージェントの実行コマンド
エージェント削除
エージェントのトラブルシューティング

タグ

SourceDeploy