SourcePipeline 사용
  • PDF

SourcePipeline 사용

  • PDF

SourcePipeline 서비스에서 제공하는 사양을 확인하고 사용 시나리오용어를 충분히 숙지했다면 SourcePipeline 이용을 시작하기 위한 준비를 완료한 것입니다. 이제 다음으로 먼저 할 일은 SourcePipeline을 생성하고 파이프라인 프로젝트를 작성하는 것입니다. SourcePipeline 생성, 실행 및 관리는 네이버 클라우드 플랫폼 콘솔에서 진행합니다.

사용자 권한

로그인 계정에 따른 SourcePipeline 이용 권한을 확인하고, 필요에 따라 콘솔의 Services > Management & Governance > Sub Account 메뉴에서 서브 계정 권한을 설정해 주십시오.

  • 고객 계정: SourcePipeline의 모든 기능을 제약 없이 이용 가능
  • 고객이 생성한 서브 계정: SourcePipeline을 사용하려면 다음 권한 중 하나가 필요
    • NCP_FIN_INFRA_MANAGER: 고객 계정과 동일하게 SourcePipeline을 포함한 네이버 클라우드 플랫폼 내 모든 서비스 이용 가능 (단, 마이페이지의 일부 관리 기능 제외)
    • NCP_FIN_SOURCEPIPELINE_MANAGER : SourcePipeline 서비스 내 모든 기능 이용 가능
참고

SourcePipeline 생성 준비

SourcePipeline을 생성 및 사용하기 위해서는 먼저 SourceCommit, SourceBuild, SourceDeploy, Object Storage 서비스를 이용해야 합니다.
자세한 사용법은 각 서비스의 사용 가이드를 참고해 주십시오.

항목 설명 가이드
SourceCommit 소스 코드와 파일들을 안전하게 저장할 수 있는 프라이빗 Git 리포지토리 서비스 SourceCommit
SourceBuild 독립된 빌드 서버를 실시간으로 생성하여 다수의 빌드 요청을 동시에 처리하는 서비스 SourceBuild
SourceDeploy 서버 그룹에 대한 배포를 자동화해주는 배포 서비스 SourceDeploy
Object Storage 사용자가 언제 어디서나 원하는 데이터를 저장하고 탐색할 수 있도록 파일 저장 공간을 제공하는 서비스 Object Storage

SourcePipeline 생성

파이프라인을 생성하는 방법은 다음과 같습니다.

  1. 네이버 클라우드 플랫폼 콘솔에 접속해 주십시오.
  2. Services > Developer Tools > SourcePipeline 메뉴를 차례대로 클릭해 주십시오.
  3. [파이프라인 생성] 버튼을 클릭하여 새로운 파이프라인을 생성해 주십시오.
  4. 파이프라인 생성 화면이 나타나면 다음 단계를 차례대로 진행해 주십시오.

1. 기본 설정

기본 설정 정보를 입력한 후 [다음] 버튼을 클릭해 주십시오.

  • 파이프라인 이름은 알파벳, 숫자, 특수문자(-_)만 포함할 수 있습니다.
  • 파이프라인 설명은 3~500글자의 제한이 있습니다.

2. 파이프라인 구성

연동할 작업을 설정해 파이프라인을 구성할 수 있습니다.

참고
  • 파이프라인 구성 시 SourceDeploy 서비스에서 배포 승인 단계를 사용하고 있다면 승인 단계 그대로 사용할 수 있습니다. 단, SourceCommit 이벤트 트리거로 파이프라인을 실행 시에는 승인 단계를 사용할 수 없습니다.
  • 파이프라인 구성 시 배포 승인 관련 이메일(email), 문자(sms) 전송 기능을 제공합니다. (제공 예정)

파이프라인 구성 화면은 다음과 같습니다.

SourcePipeline-create_ko

영역 설명
작업 추가 연동할 작업을 설정(아래 순서 2번 참고)
② 미설정 영역 위 ① 작업으로 추가된 작업이 표시(아래 순서 3~4번 참고)
  • 파이프라인 실행 대상으로 설정된 상태는 아님
  • 작업 대상으로 설정되면 ③ 설정 영역으로 이동
  • ③ 설정 영역 작업 연결을 마친 설정 영역(아래 순서 5번 참고)
  • 파이프라인 실행 순서에 맞게 작업이 체인 형태로 표시
  • 작업 대상에서 삭제하면 ② 미설정 영역으로 이동
  • Trigger 설정 트리거 이벤트를 설정(아래 순서 6번 참고)

    파이프라인을 구성하는 방법은 다음과 같습니다.

    1. 파이프라인 구성 화면에서 [작업추가] 버튼을 클릭해 주십시오.

    2. 작업 설정 팝업 창에서 설정 정보를 입력한 후 [확인] 버튼을 클릭해 주십시오.

      • 이름: 작업의 이름은 현재 파이프라인 내에서 유일한 이름
      • 타입: SourceBuild 또는 SourceDeploy 선택. 선택한 서비스 타입에 따라 표시되는 입력 정보 항목이 달라짐.
      • [SourceBuild를 선택한 경우]
        • 프로젝트: SourceBuild 프로젝트 선택. 선택 시 연결정보가 항목 아래 표시됨.
        • 연결정보 영역
          • 타입: SourceBuild 프로젝트 생성 시 또는 설정 변경 시 빌드 대상 항목에서 선택한 타입(SourceCommit, Github, Bitbucket)
          • 리파지토리: 연결된 리포지토리 정보 표시
          • 브랜치: 연결된 리포지토리의 브랜치 정보 표시, 파이프라인 구성에 필요한 브랜치로 변경 가능
      • [SourceDeploy를 선택한 경우]
        • 프로젝트: SourceDeploy 프로젝트 선택
        • 스테이지: 선택한 SourceDeploy 프로젝트의 스테이지 선택
        • 시나리오: 선택한 SourceDeploy 프로젝트의 시나리오 선택, 선택 시 연결정보가 항목 아래 표시됨
        • 연결정보영역
          • 타입: 배포 시나리오 생성 또는 설정 변경 시, 배포 파일 위치 항목에서 선택한 타입(SourceBuild, Object Storage) 표시
          • 정보: 배포 시나리오의 배포 파일 위치 항목에서 선택한 타입에 따라 설정한 빌드 프로젝트 이름 또는 Object Storage 경로 정보 표시
    3. 파이프라인 구성 화면에서 미설정 영역에 있는 작업 중에서 설정할 작업의 i-SourcePipeline-add을 클릭해 주십시오.

      • 작업의 설정 상태를 상세 확인하거나 수정하려면 해당 작업의 i-SourcePipeline-set을 클릭해 설정 확인 및 수정해 주십시오.(위 순서 2번 참고)
      • 작업을 삭제하려면 i-SourcePipeline-delete-02을 클릭한 후 팝업 창에서 [삭제] 버튼을 클릭해 주십시오.
    4. 선행 작업 선택 팝업 창에서 선행 작업을 선택한 후 [확인] 버튼을 클릭해 주십시오.

      • 설정한 작업은 오른쪽의 설정 영역으로 이동합니다.
      • 선행작업 없음을 선택한 경우 첫 번째 작업으로 설정됩니다.
      • 선행 작업을 선택한 경우 해당 작업은 선행 작업의 다음 작업으로 설정됩니다.
    5. 설정 영역에서 파이프라인이 작업 순서에 맞게 설정되었는지 확인해 주십시오.

      • 작업의 설정 상태를 상세 확인하거나 수정하려면 해당 작업의 i-SourcePipeline-set을 클릭해 설정 확인 및 수정해 주십시오.(위 순서 2번 참고)
      • 작업 순서를 변경하려면 해당 작업의 i-SourcePipeline-add을 클릭한 후 원하는 선행 작업을 선택한 다음 [확인] 버튼을 클릭해 주십시오.
      • 해당 작업을 첫 번재 작업으로 설정하려면 선택된 선행 작업을 클릭하여 선택 해제를 한 후 선행작업 없음을 선택한 다음 [확인] 버튼을 클릭해 주십시오.
      • 설정 영역에 첫 번째 작업(선행작업 없음이 설정된 작업)이 2개 이상 있는 경우 파이프라인을 구성할 수 없습니다. 선행 작업을 선택해 작업 순서를 설정하거나 불필요한 경우 삭제해 주십시오.
      • 작업을 삭제하려면 해당 작업의 i-SourcePipeline-delete-02을 클릭한 후 팝업 창에서 [삭제] 버튼을 클릭해 주십시오. 설정 영역에서 삭제한 작업은 프로젝트에서 완전히 삭제되지 않고 미설정 영역으로 이동합니다.
    6. 트리거 이벤트를 설정하려면 Trigger 항목의 체크 박스를 클릭하여 선택해 주십시오.

      • 트리거 이벤트를 설정하면 설정한 트리거의 리포지토리/브랜치(SourceCommit)에 push 이벤트가 발생할 때 해당 파이프라인이 자동으로 실행됩니다. 단, SourceCommit 서비스의 콘솔 상에서, Web 편집 등의 커밋(commit) 이벤트 발생 시에는 실행되지 않습니다.
      • 트리거 이벤트를 추가하려면 Repository, Branch 항목에서 SourceCommit에 등록된 리포지토리와 브랜치를 선택한 후 [추가] 버튼을 클릭해 주십시오.
      • 설정한 트리거 이벤트를 삭제하려면 i-SourcePipeline-delete-01을 클릭하여 트리거 목록에서 삭제해 주십시오.
    7. 파이프라인 구성이 완료되면 [다음] 버튼을 클릭해 주십시오.

    3. 최종 확인

    설정 내용을 확인한 후 [파이프라인 생성] 버튼을 클릭해 주십시오.

    SourcePipeline 화면

    파이프라인 기본 정보를 확인하는 방법은 다음과 같습니다.

    1. 네이버 클라우드 플랫폼 콘솔에 접속해 주십시오.
    2. Services > Developer Tools > SourcePipeline 메뉴를 차례대로 클릭해 주십시오.
    3. 파이프라인 목록에서 파이프라인 기본 정보를 확인해 주십시오.

    파이프라인 목록 화면의 각 항목에 대한 설명은 다음과 같습니다.

    SourcePipeline-screen_ko

    영역 설명
    ① 메뉴명 현재 확인 중인 메뉴명과 운영 중인 SourcePipeline 개수
    파이프라인 생성 새로운 파이프라인 생성
    파이프라인으로 이동 파이프라인 실행 화면으로 이동
    설정 변경 파이프라인 설정 변경
    삭제 파이프라인 삭제
    ⑥ 검색 영역 검색창 및 목록에 표시할 항목 수 표시
    ⑦ 파이프라인 목록 생성한 파이프라인의 기본 정보 확인
    ⑧ trigger 보기 파이프라인에 설정된 트리거 이벤트 확인

    트리거 이벤트 확인

    트리거 이벤트를 확인하는 방법은 다음과 같습니다.

    1. 네이버 클라우드 플랫폼 콘솔에 접속해 주십시오.
    2. Services > Developer Tools > SourcePipeline 메뉴를 차례대로 클릭해 주십시오.
    3. 파이프라인 목록에서 확인 대상 파이프라인 이름에 있는 trigger 열의 [보기] 버튼을 클릭해 주십시오.
    4. 트리거(Trigger) 정보 팝업 창에서 설정된 트리거 이벤트를 확인해 주십시오.

    SourcePipeline 실행

    파이프라인을 실행하는 방법은 다음과 같습니다.

    1. 네이버 클라우드 플랫폼 콘솔에 접속해 주십시오.
    2. Services > Developer Tools > SourcePipeline 메뉴를 차례대로 클릭해 주십시오.
    3. 파이프라인 목록에서 실행 대상 파이프라인 이름을 클릭해 주십시오.
      • 또는 파이프라인 이름 왼쪽에 있는 체크 박스를 선택한 후 [파이프라인으로 이동] 버튼을 클릭해 주십시오.
    4. 파이프라인 탭 화면에서 [파이프라인 실행하기] 버튼을 클릭해 주십시오.
      • 파이프라인을 실행하기 전에 리포지토리의 브랜치와 배포 시나리오를 변경할 수 있습니다. 단, 변경된 설정은 이번 파이프라인 실행에만 적용됩니다.
      • 파이프라인이 실행되면 작업결과 탭으로 이동하며 작업 결과 목록에 작업 상태가 Ready에서 Running으로 표시됩니다.
    5. 작업결과 탭 화면에서 진행 상황을 확인해 주십시오.
      • 파이프라인 실행 중 작업을 취소하려면 해당 작업에 있는 [취소] 버튼을 클릭해 주십시오. 취소되면 작업 상태가 Canceled로 표시됩니다.
      • 작업 상태가 실패, 취소, 오류인 경우 [재실행] 버튼이 표시됩니다. [재실행] 버튼은 맨 마지막에 실행한 작업에만 표시됩니다.
      • 작업 결과에 대한 자세한 내용은 SourcePipeline 작업 결과 확인을 참고해 주십시오.

    SourcePipeline 작업 결과 확인

    파이프라인 작업 결과를 확인하는 방법은 다음과 같습니다.

    1. 네이버 클라우드 플랫폼 콘솔에 접속해 주십시오.

    2. Services > Developer Tools > SourcePipeline 메뉴를 차례대로 클릭해 주십시오.

    3. 파이프라인 목록에서 작업 결과 확인 대상 파이프라인 이름을 클릭해 주십시오.

      • 또는 파이프라인 이름의 체크 박스를 선택한 후 [파이프라인으로 이동] 버튼을 클릭해 주십시오.
    4. 파이프라인 상세 화면에서 작업결과 탭을 클릭해 주십시오.

    5. 파이프라인 작업 결과 목록에서 확인 대상 작업을 클릭해 작업 결과를 확인해 주십시오.

      SourcePipeline-result-detail_ko

      • 작업별 상세 결과를 확인하려면 i-SourcePipeline-log을 클릭해 주십시오. SourceBuild, SourceDeploy 서비스의 작업 결과 화면으로 이동합니다. 이때 SourceBuild, SourceDeploy의 사용 권한이 없을 경우 로그 확인이 제한될 수 있습니다.
      • 작업 상태가 실패, 취소, 오류인 경우 SourcePipeline을 재실행할 수 있습니다.
      • SourceBuild, SourceDeploy의 사용법은 각 서비스의 사용 가이드를 참고해 주십시오.

    SourcePipeline 재실행

    실패, 취소, 오류가 발생한 맨 마지막 파이프라인 작업 이력에 대해서 재실행할 수 있습니다.
    파이프라인의 작업 구성이 변경되지 않은 경우도 재실행할 수 있습니다.

    파이프라인을 재실행하는 방법은 다음과 같습니다.

    1. 네이버 클라우드 플랫폼 콘솔에 접속해 주십시오.
    2. Services > Developer Tools > SourcePipeline 메뉴를 차례대로 클릭해 주십시오.
    3. 파이프라인 목록에서 재실행 대상 파이프라인 이름을 클릭해 주십시오.
      • 또는 파이프라인 이름의 체크 박스를 선택한 후 [파이프라인으로 이동] 버튼을 클릭해 주십시오.
    4. 파이프라인 상세 화면에서 작업결과 탭을 클릭해 주십시오.
    5. 파이프라인 작업 결과 목록에서 [재실행] 버튼을 클릭해 주십시오.
      • 작업 상태가 실패인 경우 해당 작업의 i-SourcePipeline-log을 클릭해 해당 SourceBuild 또는 SourceDeploy 서비스의 작업 결과 화면에서 실패 원인을 파악하고, 재설정한 후에 [재실행] 버튼을 클릭해 주십시오.
    6. 작업이 계속 실패하는 경우 위 5번을 반복하면서 실패 원인을 제거해 주십시오.

    SourcePipeline 설정 변경

    파이프라인 설정을 변경하는 방법은 다음과 같습니다.

    1. 네이버 클라우드 플랫폼 콘솔에 접속해 주십시오.
    2. Services > Developer Tools > SourcePipeline 메뉴를 차례대로 클릭해 주십시오.
    3. 파이프라인 목록에서 설정 변경 대상 파이프라인 이름의 체크 박스를 선택한 후 [설정 변경] 버튼을 클릭해 주십시오.
      • 생성된 파이프라인 이름을 클릭하면 파이프라인 실행 화면으로 이동하므로 선택에 유의해 주십시오.
    4. 기본 정보 영역에서 파이프라인 설명을 변경해 주십시오.
      • Source Phase를 수정한 경우, Build / Deploy Phase가 초기화됩니다.
    5. 파이프라인 구성, Trigger 설정 영역에서 파이프라인에 연결된 작업과 트리거 이벤트 설정을 변경해 주십시오.
    6. 설정 변경을 완료한 후 [적용] 버튼을 클릭해 주십시오.
    참고

    파이프라인 설정을 변경하려면 로그인한 계정이 고객 계정 또는 NCP_INFRA_MANAGER 권한을 가지고 있는 서브 계정이거나 파이프라인 사용자 계정(서브 계정)이 선택한 파이프라인에 대해 파이프라인 상세 권한 중 changeProject 권한을 가지고 있어야 합니다.

    SourcePipeline 삭제

    파이프라인을 삭제하는 방법은 다음과 같습니다.

    1. 네이버 클라우드 플랫폼 콘솔에 접속해 주십시오.
    2. Services > Developer Tools > SourcePipeline 메뉴를 차례대로 클릭해 주십시오.
    3. 파이프라인 목록에서 삭제 대상 파이프라인을 선택한 후 [삭제] 버튼을 클릭해 주십시오.
      • 생성된 파이프라인 이름을 클릭하면 파이프라인 실행 화면으로 이동하므로 선택에 유의해 주십시오.
    4. 파이프라인 프로젝트 삭제 확인 팝업 창에서 내용을 확인한 후 [삭제] 버튼을 클릭해 주십시오.
    참고

    파이프라인을 삭제하려면 로그인한 계정이 고객 계정 또는 NCP_INFRA_MANAGER 권한을 가지고 있는 서브 계정이거나 파이프라인 사용자 계정(서브 계정)이 선택한 파이프라인에 대해 파이프라인 상세 권한 중 deleteProject 권한을 가지고 있어야 합니다.


    이 글이 도움이 되었나요?