에이전트 설치 및 관리

에이전트 설치 및 관리에서 에이전트 지원 사양 및 설치 방법에 대해 설명합니다. 또한 에이전트에 사용하는 명령어와 에이전트와 관련하여 발생할 수 있는 문제의 해결 방안을 설명합니다.

에이전트 지원 사양

에이전트 지원 사양은 다음과 같습니다.

에이전트 설치

SourceDeploy를 이용하여 서버에 배포하려면 해당 서버에 SourceDeploy용 에이전트가 설치되어 있어야 합니다.

에이전트를 설치하려면 다음 단계를 차례대로 진행해 주십시오.

• 1. API 인증키 생성
• 2. 설치 명령어 작성

1. API 인증키 생성

에이전트를 설치하고 사용하려면 API 인증키가 필요합니다.

API 인증키를 생성하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 포털에 접속해 주십시오.
2. 마이페이지 > 계정 관리 > 인증키 관리 메뉴를 차례대로 클릭해 주십시오.
3. 로그인 비밀번호를 입력한 후 [확인] 버튼을 클릭해 주십시오.
4. [신규 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
wget Agent 다운로드 주소
chmod 755 install
./install
rm -rf install

• accesskey에 1. API 인증키 생성에서 생성한 API 인증키의 Access Key ID를 입력해 주십시오.

• secretkey에 1. API 인증키 생성에서 생성한 API 인증키의 Secret Key를 입력해 주십시오.

  • Secert Key는 [보기] 버튼을 클릭하여 확인할 수 있습니다.
  주의

  API 인증키는 사용 중인 키를 사용해야 합니다. 사용 중지인 키를 사용할 경우, 에이전트가 정상 동작하더라도 인증에 실패하여 SourceDeploy를 통한 배포가 정상적으로 수행되지 않습니다.
  사용 중지인 키를 사용하려면 [사용] 버튼을 클릭하여 상태를 사용 중으로 변경해 주십시오.

• Agent 다운로드 주소에 사용 리전 및 환경에 해당하는 에이전트 다운로드 주소를 입력해 주십시오.

  환경	리전	Agent 다운로드 주소
  VPC	한국 (FKR)	https://deploy-agent.apigw.fin-ntruss.com/agent/v1/download/install

• NCP_AUTH_KEY는 서버 내 /opt 디렉터리 아래에 다음과 같이 생성되어야 합니다.
  

Init Script에 작성

설치 명령어를 Init Scrip에 작성한 경우 Server 또는 Auto Scaling에 등록해야 합니다.

설치 명령어를 Init Script에 작성한 후 Server 또는 Auto Scaling에 등록하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 콘솔에 접속해 주십시오.
2. Services > Compute > Server 메뉴를 차례대로 클릭해 주십시오.
3. Init Script 메뉴를 클릭해 주십시오.
4. [Script 생성] 버튼을 클릭해 주십시오.
5. Script 이름을 입력한 후 OS 타입을 선택해 주십시오.
6. 다음을 참고하여 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를 입력해 주십시오.

     • Secert Key는 [보기] 버튼을 클릭하여 확인할 수 있습니다.
     주의

     API 인증키는 사용 중인 키를 사용해야 합니다. 사용 중지인 키를 사용할 경우, 에이전트가 정상 동작하더라도 인증에 실패하여 SourceDeploy를 통한 배포가 정상적으로 수행되지 않습니다.
     사용 중지인 키를 사용하려면 [사용] 버튼을 클릭하여 상태를 사용 중으로 변경해 주십시오.

   • Agent 다운로드 주소에 사용 환경 및 리전에 해당하는 에이전트 다운로드 주소를 입력해 주십시오.

     환경	리전	Agent 다운로드 주소
     VPC	한국 (FKR)	https://deploy-agent.apigw.fin-ntruss.com/agent/v1/download/install

7. [Script 생성] 버튼을 클릭해 주십시오.
8. 생성한 Init Script를 Server 또는 Auto Scaling에 등록해 주십시오.
   • Server에 등록하려면 Server 메뉴를 클릭해 주십시오.
     • [서버 생성] 버튼을 클릭하여 Init Script를 등록할 수 있습니다. 자세한 Server 생성 방법은 Server 생성 가이드를 참고해 주십시오.
   • Auto Scaling에 등록하려면 Service > Compute > Auto Scaling > Launch Configuration 메뉴를 차례대로 클릭해 주십시오.
     • [Launch Configuration 생성] 버튼을 클릭하여 Init Script를 등록할 수 있습니다. 자세한 Launch Configuration 생성 방법은 Launch Configuration 생성 가이드를 참고해 주십시오.

에이전트 실행 명령어

에이전트 실행 명령어는 다음과 같습니다.

에이전트 시작

service sourcedeploy start

에이전트 중지

service sourcedeploy stop

에이전트 상태 확인

service sourcedeploy status

에이전트 재시작

service sourcedeploy restart

에이전트 프로세스 확인

에이전트 프로세스를 확인하여 에이전트가 정상적으로 실행되는지 확인할 수 있습니다.

에이전트 프로세스의 정상 실행 기준은 다음과 같습니다.

• VPC 환경에서 5개 실행
• Classic 환경에서 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/06/17 기준

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

  • 설치된 에이전트 버전이 이전 버전일 경우, 에이전트를 삭제한 후 재설치해 주십시오.
    • 에이전트 삭제는 에이전트 삭제를 참고해 주십시오.

• Init Script에 에이전트 설치 URL이 다음과 같이 입력되었는지 확인해 주십시오.

  • 사용 환경 및 리전에 따른 에이전트 다운로드 주소는 다음과 같습니다.

    환경	리전	Agent 다운로드 주소
    VPC	한국 (FKR)	https://deploy-agent.apigw.fin-ntruss.com/agent/v1/download/install

    wget Agent 다운로드 주소
    

• 서버 상태가 운영중인지 확인해 주십시오.

에이전트 프로세스가 정상적으로 실행되지 않는 경우

• 재시작 명령어를 입력하여 에이전트를 재시작해 주십시오.

  service sourcedeploy restart
  

• 재시작한 후에도 정상적으로 동작하지 않을 경우, 에이전트를 재설치해 주십시오.

에이전트가 설치되지 않는 경우

• 인증키 값이 정상적으로 입력되었는지 확인해 주십시오.

  cat /opt/NCP_AUTH_KEY
  

• Init Script 첫 줄에 #!/usr/bin/env python, #!/bin/perl, #!/bin/bash 등과 같은 형태로 실행하고자 하는 스크립트 경로를 지정했는지 확인해 주십시오.