VM 배포
사용자는 DevOps Console을 통해서 VM 배포를 등록/관리 할 수 있습니다.
VM 배포를 등록하기 전에 사용 가능한 VM서버 그룹(VM서버 그룹)이 있어야 하며 등록된 VM 배포는 빌드 파이프라인(Deploy to VM)에서 사용할 수 있습니다.
사용자는 아이콘으로 배포 방식을 구분할 수 있습니다.
(SSH 방식) VM 배포
(Agent 방식) VM 배포
참고
배포 방식에 따른 차이: 표. SSH 방식 vs 에이전트 방식
VM 배포 시작하기
VM 배포를 시작하려면 다음 절차를 따르세요.
- 메인 페이지에서 프로젝트 카드를 클릭하세요. 프로젝트 대시보드 페이지로 이동합니다.
- 왼쪽 메뉴에서 빌드/배포 > VM 배포 메뉴를 클릭하세요. VM 배포 페이지로 이동합니다.
항목 설명 배포 그룹명 배포 그룹의 이름을 표시합니다. VM 배포 결과 (성공)/(전체): 전체 배포 대상이 되는 VM서버의 수와 배포 성공한 VM서버의 수를 표시합니다. - 녹색: 전체 성공
- 파란색: 실행 중
- 붉은색: 부분 실패
- 회색: 준비, 중단
배포 시간 배포 시간을 표시합니다. 삭제 VM 배포를 삭제합니다. 표. VM 배포 표시 항목
VM 배포 추가하기
VM 배포를 추가하려면 다음 절차를 따르세요.
- 메인 페이지에서 프로젝트 카드를 클릭하세요. 프로젝트 대시보드 페이지로 이동합니다.
- 왼쪽 메뉴에서 빌드/배포 > VM 배포 메뉴를 클릭하세요. VM 배포 페이지로 이동합니다.
- VM 배포 페이지의 오른쪽 위의 VM 배포 추가 버튼을 클릭하세요. VM 배포 추가 팝업창이 열립니다.
- VM 배포 추가 팝업창에서 정보 입력 후 저장 버튼을 클릭하세요.
항목 설명 배포 그룹 배포 그룹명을 입력하세요. 실행 방식 실행 방식을 선택하세요. - 파일 전송 및 명령어 실행: 일반적으로 VM에 파일을 배포하는 경우 선택합니다.
- 명령어만 실행: VM에 별도 파일 전송 없이 명령어만 실행할 경우 선택합니다.(ex. 도커 명령어)
배포 방식 배포 방식을 선택 배포 순서 배포대상 서버가 복수개인 경우 병렬로 배포할지 순차적으로 배포할지 선택하세요. 배포 대상 VM 배포대상 서버를 설정하세요. - 설정 버튼 클릭 시 배포 대상 VM 설정 팝업창이 열립니다.
파일 배포 전 명령어 파일 배포 전에 수행해야 하는 명령어를 작성합니다. 전송할 파일 - Source: 빌드 파이프라인이 실행되는 경로(Jenkins workspace) 이후의 파일 경로를 입력하세요.
- Target: VM서버에서 파일이 배포될 경로를 입력하세요.
- 추가 버튼을 이용하여 파일을 추가할 수 있습니다.
파일 배포 후 명령어 파일 배포 후에 수행해야 하는 명령어를 작성합니다. 자동 복원 설정 자동 복원 설정 여부를 선택 - 배포가 실패하면 직전 성공한 배포로 복원됩니다.
- 배포 방식이 Agent인 경우 활성화 됩니다.
아티팩트 저장소 롤백에 사용될 아티팩트 저장소 사용 여부를 선택 - 배포 방식이 Agent인 경우 활성화 됩니다.
저장소명 아티팩트 저장소를 사용하는 경우에만 노출됩니다. - 이미 등록한 아티팩트 저장소의 목록이 표시
표. VM 배포 추가 입력 항목
Note
배포 대상 VM 설정 팝업창에는 자신이 사용 가능한 서버그룹이 표시됩니다.
자세한 사항은 VM서버 그룹을 참고 하세요.
VM 배포 상세보기
VM 배포의 상세정보를 확인하려면 다음 절차를 따르세요.
- 메인 페이지에서 프로젝트 카드를 클릭하세요. 프로젝트 대시보드 페이지로 이동합니다.
- 왼쪽 메뉴에서 빌드/배포 > VM 배포 메뉴를 클릭하세요. VM 배포 페이지로 이동합니다.
- VM 배포 페이지의 VM 배포 목록에서 상세보기를 원하는 VM 배포를 클릭하세요. VM 배포 상세 페이지로 이동합니다.
- 이력 탭에서 서버 목록을 클릭하세요. 배포 상세 팝업창이 열립니다.
- 배포 상세 팝업창에서 상세 이력을 볼 수 있습니다.
- 실행 파이프라인의 로그 버튼을 클릭하면 파이프라인 로그 팝업창이 열립니다.
- 파이프라인 로그 팝업창에서 상세 로그를 조회할 수 있습니다.
- 배포 서버 별 이력 목록에서 로그를 조회할 서버의 로그 버튼을 클릭하면 VM Agent 로그 팝업창이 열립니다.
- VM Agent 로그 팝업창에서 상세 로그를 조회할 수 있습니다.
항목 설명 중단 / 배포 시작 중단, 배포 시작 버튼이 활성화 됩니다. 롤백 이전 버전으로 롤백을 할 수 있습니다. 이력 탭 배포 이력이 표시됩니다. 파이프라인 정보 탭 해당 VM 배포에 연결된 빌드 파이프라인 정보가 표시됩니다. 로그 빌드 파이프라인의 로그를 볼 수 있습니다. 표. VM 배포 상세 화면 항목항목 설명 실행 파이프라인 로그 빌드 파이프라인의 로그를 볼 수 있습니다. 배포 서버 별 이력 로그 배포 에이전트의 로그를 볼수 있습니다. - AGENT 타입의 경우 만 표시
표. 배포 상세 화면 항목
VM 배포 삭제하기
목록에서 삭제하기
VM 배포를 삭제하려면 다음 절차를 따르세요.
- 메인 페이지에서 프로젝트 카드를 클릭하세요. 프로젝트 대시보드 페이지로 이동합니다.
- 왼쪽 메뉴에서 빌드/배포 > VM 배포 메뉴를 클릭하세요. VM 배포 페이지로 이동합니다.
- VM 배포 페이지의 VM 배포 목록에서 삭제를 원하는 VM 배포의 X 아이콘을 클릭하세요.
- 확인 팝업창에서 확인 버튼을 클릭하여 VM 배포 삭제를 완료하세요.
상세 페이지에서 삭제하기
VM 배포를 삭제하려면 다음 절차를 따르세요.
- 메인 페이지에서 프로젝트 카드를 클릭하세요. 프로젝트 대시보드 페이지로 이동합니다.
- 왼쪽 메뉴에서 빌드/배포 > VM 배포 메뉴를 클릭하세요. VM 배포 페이지로 이동합니다.
- VM 배포 페이지의 VM 배포 목록에서 삭제를 원하는 VM 배포를 클릭하세요. VM 배포 상세 페이지로 이동합니다.
- VM 배포 상세 페이지에서 삭제 버튼을 클릭하세요.
- 확인 팝업창에서 확인 버튼을 클릭하여 VM 배포 삭제를 완료하세요.
VM 배포 명령어에 환경변수 사용하기
파일 배포 전 명령어, 파일 배포 후 명령어, 전송할 파일의 Source 경로, 전송할 파일의 Target 경로에 환경변수를 사용 할 수 있습니다.
명령어 내부에 $ 표시자나 ${} 표시자를 사용하여 빌드 파이프라인의 환경변수를 사용할 수 있습니다.
배경색 변경
echo ${BUILD_NUMBER}
echo $JOB_NAMEecho ${BUILD_NUMBER}
echo $JOB_NAME명령어가 실행되는 VM서버의 환경변수를 참고하고 싶은 경우, \ 를 추가 해주면 됩니다.
배경색 변경
echo \${PATH}
echo \$LANGecho \${PATH}
echo \$LANGVM 배포 중단하기
배포 상세 페이지에서 진행 중인 VM 배포를 중단할 수 있습니다. 배포 상세 페이지의 최근 배포 상태 영역의 중단 버튼을 클릭하면, VM 배포가 중단됩니다.
배포 중단이 가능한 상태는 아래 표 내용과 같으며, 해당 상태일 경우에만 중단 버튼이 표시됩니다.
| 방식 | 상태값 | 설명 |
|---|---|---|
| SSH | 요청 | 빌드 파이프라인이 실행 중인 상태 |
| AGENT | 요청 | 빌드 파이프라인이 실행 중인 상태 |
| AGENT | 빌드 완료 | 빌드 파이프라인이 완료된 상태
|
| AGENT | 준비 | 빌드 파이프라인이 완료된 후 AGENT가 배포를 수행할 수 있는 상태 |
| AGENT | 진행중 | AGENT가 배포를 실행 중인 상태 |
표. 배포 중단이 가능한 상태
VM 배포 상태값 이해하기
배포 상세 페이지에서 VM 배포의 현재 상태를 확인할 수 있습니다.
상태값 | 설명 |
|---|---|
| 미수행 | 최초 생성 후 한번도 실행되지 않은 상태 |
| 요청 | 빌드 파이프라인이 실행 중인 상태 |
| 성공 | 빌드/배포가 성공한 상태 |
| 실패 | 빌드 또는 배포 중 실패한 상태 |
표. SSH 배포 상태값 설명
상태값 | 설명 |
|---|---|
| 미수행 | 최초 생성 후 한번도 실행되지 않은 상태 |
| 요청 | 빌드 파이프라인이 실행 중인 상태 |
| 빌드 완료 | 빌드 파이프라인이 완료된 상태
|
| 준비 | 빌드 파이프라인이 완료된 후 AGENT가 배포를 수행할 수 있는 상태 |
| 진행중 | AGENT가 배포를 실행 중인 상태 |
| 성공 | 빌드/배포가 성공한 상태 |
| 실패 | 빌드 또는 배포 중 실패한 상태 |
| 중단 | 빌드 또는 배포 중 중단한 상태
|
표. AGENT 배포 상태값 설명