온보딩 GitHub 대상 DevOps 변경 속도 — 작업 공간

  • 릴리스 버전: Yokohama
  • 업데이트 날짜 2025년 01월 30일
  • 읽기10분

    • GitHub DevOps 변경 작업 공간 플레이북을 사용하여 인스턴스에 연결하여 리포지토리, 계획, 파이프라인을 검색, 구성, 임포트합니다.

    시작하기 전에

    주제에 지정된 DevOps 변경 속도 시작하기 작업을 완료합니다.

    필요한 역할: sn_devops.admin 또는 sn_devops.tool_owner

    프로시저

    1. 다음으로 이동 작업 공간 > DevOps 변경 작업 공간 그리고 다음 옵션 중 하나를 사용하여 온보딩 GitHub할 플레이북을 엽니다.
      옵션단계
      홈페이지
      1. 도구 연결을 선택합니다.
      2. 도구 연결 모달에서 적절한 범주(오케스트레이션, 코드, 계획 또는 소프트웨어 품질)에서 도구를 선택합니다. 예를 들어 코딩 도구로 연결 GitHub 하려는 경우 코딩 도구 범주를 선택합니다.
      애플리케이션 모듈
      1. 기본 탐색에서 애플리케이션 ( 애플리케이션 아이콘.)을 선택합니다.
      2. 기존 애플리케이션을 선택하거나 새로 만듭니다. 애플리케이션을 생성하려면 다음 문서를 참조하십시오 애플리케이션 생성 - 작업 공간.
      3. 권장 작업 창에서 도구 연결 카드를 선택합니다.
      4. 도구에 연결 모달에서 적절한 범주의 도구를 선택합니다. 예를 들어 코딩 도구로 연결하려면 GitHub코드 범주 아래를 선택합니다GitHub.
      도구 모듈
      1. 기본 탐색에서 도구 ( 도구 아이콘)를 선택합니다.
      2. 역량 목록에서 적절한 범주를 선택합니다. 예를 들어 코딩 도구로 연결하려면 GitHub코딩 범주를 선택합니다.
      3. 도구 연결을 선택합니다.
      4. 도구 연결 모달에서 을 선택합니다 GitHub.
      중요사항:
      도구에 연결하는 동안 파이프라인, 계획 또는 리포지토리와 같은 도구 객체를 검색하고 추적하려면 애플리케이션 모듈에서 도구를 연결해야 합니다.
    2. 도구 이름 필드에 도구 이름을 입력합니다.

      GitHub에 연결

    3. 다음을 선택합니다.

      온보딩 작업을 완료하는 데 도움이 되는 플레이북이 DevOps 열립니다.

    4. 플레이북을 사용하여 연결 및 구성을 완료합니다.
      1. 자격 증명 유형 필드에서 다음 자격 증명 유형 중 하나를 선택합니다.
        • 기본 인증
        • 인증 코드가 있는 OAuth 2.0
        • JSON 웹 토큰(JWT)을 사용하는 OAuth 2.0
      2. 자격 증명을 입력합니다.
        기본 인증

        인스턴스의 사용자 이름 및 암호/액세스 토큰을 GitHub 입력합니다.

        GitHub 기본 인증 자격 증명 유형입니다.
        인증 코드가 있는 OAuth 2.0

        인증 코드 자격 증명이 있는 기존 OAuth 2.0 기록을 선택하거나 인증 코드 자격 증명이 있는 OAuth 2.0 기록을 생성합니다. 자세한 내용은 앱 제공자에 대한 GitHub 자격 증명 기록 생성(인증 코드) 문서를 참조하십시오.

        인증 코드가 있는 GitHub OAuth 2.0 자격 증명 유형

        주:
        GitHub 앱을 사용하여 연결하고 권한 검사에 문제가 있는 경우 GitHub 앱의 클라이언트 ID 접두사를 DevOps 속성: GitHub 앱에 대한 클라이언트 ID 지정자에서 사용할 수 있는지 확인합니다. 자세한 내용은 DevOps 속성에 클라이언트 ID 추가 문서를 참조하십시오.
        JSON 웹 토큰(JWT)을 사용하는 OAuth 2.0
        JWT에서 OAuth 2.0을 사용하여 연결하려면 먼저 다음을 수행해야 합니다.
        필수 조건을 완료한 후 커넥트 플레이북 활동을 계속할 DevOps 변경 속도 수 있습니다.
        1. 이미 존재하는 JWT 자격 증명 기록을 사용하려면 기존 JWT 자격 증명 기록 사용 옵션을 선택합니다. 이 옵션을 선택하지 않으면 새 JWT 자격 증명 기록을 만들기 위한 필드가 표시됩니다. 다음 단계로 진행합니다.
        2. JKS 인증서 필드에서 기존 JKS 인증서를 선택합니다. JWT 제공자를 고유하게 식별하기 위해 입력한 이름입니다. JKS 인증서는 셸 명령을 사용하여 sys_certificate 레코드를 만듭니다.

          자세한 내용은 JKS 인증서에 대한 GitHub JWT 서명 키 만들기 문서를 참조하십시오.

        3. 서명 키 필드에 JKS 인증서에 할당할 서명 키를 입력합니다. JKS 인증서를 생성하는 동안 입력한 익스포트 암호입니다.
        4. GitHub 앱 ID 필드에서 GitHub 앱의 앱 ID를 선택합니다(GitHub의 GitHub 앱 구성 정보 섹션에서 확인 가능). 다음 이미지는 GitHub 앱 ID, 클라이언트 ID 및 클라이언트 암호에 액세스할 수 있는 GitHub 앱 구성의 정보 섹션 예제를 표시합니다.

          GitHub 앱의 정보 페이지입니다.

        5. 클라이언트 ID 필드에서 GitHub 앱의 클라이언트 ID를 선택합니다(GitHub의 GitHub 앱 구성 정보 섹션에서 확인 가능).
        6. 클라이언트 암호 필드에서 GitHub 앱의 클라이언트 암호(GitHub의 GitHub 앱 구성 정보 섹션에서 사용 가능)를 선택합니다.
        7. 토큰 URL 필드에서 인스턴스가 토큰을 검색하고 새로 고치는 데 사용하는 토큰 엔드포인트의 위치를 선택합니다.

          클라우드 버전의 경우 https://api.github.com/app/installations/<installation_id>/access_tokens를 입력합니다.

          엔터프라이즈 버전의 경우 https://<HOST_URL>/api/v3/app/installations/<installation_id>/access_tokens를 입력합니다.

          설치 ID의 경우 GitHub의 GitHub 앱 구성에 있는 앱 설치 섹션으로 이동하고 기어 아이콘을 선택하여 앱을 구성합니다. 설치 ID는 웹 페이지 URL에 있습니다. 예를 들어 https://github.com/settings/installations/<installation_id>.

          JWT 자격 증명 유형을 사용하는 GitHub Oauth 2.0.

        GitHub 앱 - JWT를 사용하여 OAuth 자격 증명을 만든 경우 도구 기록 페이지에서 GitHub 앱으로 구성 옵션을 사용할 수 있습니다.

        주:
        GitHub 앱을 사용하여 연결하고 권한 검사에 문제가 있는 경우 GitHub 앱의 클라이언트 ID 접두사를 DevOps 속성: GitHub 앱에 대한 클라이언트 ID 지정자에서 사용할 수 있는지 확인합니다. 자세한 내용은 DevOps 속성에 클라이언트 ID 추가 문서를 참조하십시오.

        OAuth2.0 자격 증명에 대한 자세한 내용은 다음 문서를 참조하십시오 GitHub 에 대한 OAuth 2.0 자격 증명 설정DevOps 변경 속도.

      3. 옵션: GitHub 앱을 사용하여 Oauth 2.0 자격 증명을 만든 경우 연결하기 전에 GitHub 앱 슬러그 이름 필드에 값을 입력하여 도구의 권한 요구 사항을 확인합니다.
        앱의 설정 페이지에서 앱 슬러그 이름을 찾을 수 있습니다.
      4. 옵션: GitHub 인스턴스가 에 MID 서버연결되어 있는 경우 MID 서버 옵션을 선택하고 상세 정보를 입력합니다.

        MID 서버에 대한 자세한 내용은 MID 서버 선택을 참조하십시오.

        주:
        OAuth 인증 코드 부여 유형은 MID 서버가 있는 GitHub 및 GitHub Enterprise에 대해 지원됩니다.
      5. 연결을 선택합니다.

        GitHub를 DevOps 변경 속도에 연결합니다.

      6. 권한 검사는 입력한 자격 증명에 대해 실행됩니다.

        필요한 권한과 사용 가능한 권한이 표시됩니다. 더 나은 권한으로 자격 증명을 입력하려면 자격 증명 다시 입력을 선택합니다. 필요한 모든 권한에 대한 자세한 내용은 의 도구에 필요한 DevOps 권한권한을 참조하십시오GitHub.

        OAuth 2.0의 경우 앱 슬러그 이름을 입력 GitHub 하지 않은 경우 권한 요구 사항을 확인하지 않고 도구가 연결됩니다.

      7. 다음을 선택합니다.

        권한 점검

    5. 도구에 대한 액세스 권한을 지정합니다.
      1. 도구에 대한 액세스를 제어하려면 유지 관리자 필드에 도구에 대한 액세스 권한을 부여해야 하는 그룹을 추가합니다.
        그룹의 이러한 사용자가 수행할 수 있는 작업은 할당된 역할에 따라 다릅니다.
        • DevOps 도구 소유자 역할: 도구를 보고 편집할 수 있습니다.
        • DevOps 앱 소유자 역할: 도구를 보고 도구 객체(예: 계획, 리포지토리 및 파이프라인)의 파이프라인 단계(해당되는 경우)를 연결, 검색 및 임포트하고 수정할 수 있습니다.
        • DevOps 관리자 역할: 모든 도구를 편집할 수 있습니다.
        • 기타 DevOps 역할: 도구를 볼 수 있습니다.
        주:
        그룹을 선택하지 않고 이 단계를 건너뛰면 도구 소유자 역할이 있는 DevOps 모든 사용자가 도구를 편집할 수 있습니다.
      2. 도구에 대한 액세스를 제어하도록 선택하면 모든 앱 소유자가 도구 객체를 보고 애플리케이션에 연결할 수 있음 옵션을 선택할 수 있게 됩니다.

        이 옵션을 사용하면 앱 소유자 역할을 가진 DevOps 모든 사용자가 도구에 액세스할 수 있습니다. 선택하면 도구 개체의 기록 데이터를 보고, 연결하고, 검색하고, 가져오고, 파이프라인 단계(해당되는 경우)를 수정할 수 있습니다.

      3. 할당을 선택합니다.

      도구 액세스 지정

    6. 데이터를 전송하도록 인스턴스에서 웹후크를 DevOps 변경 속도자동으로 GitHub 구성합니다.
      이 작업은 다음 웹후크를 구성합니다.
      • push: 리포지토리 커밋, 분기 및 태그를 수집하기 위해
      • workflow_job: 파이프라인 데이터를 수집하기 위해
      • issues: 문제(작업 항목) 데이터를 수집하기 위해
      주:
      실시간 알림은 현재 정보를 유지관리하고 특히 변경 요청을 자동화하는 데 이상적이므로 이 작업의 일부로 구성을 완료하는 것이 좋습니다. 그렇지 않으면 속성을 예로 설정하여 Enable Polling 추적된 리포지토리 또는 파이프라인에 대한 데이터 시스템을 가져오는 야간 폴링을 활성화하여 나중에 수동으로 구성하여 웹후크를 설정할 수 있습니다.

      웹후크를 구성할 리포지토리를 선택하고 구성을 선택합니다.

      GitHub에서 구성할 리포지토리를 선택합니다.

      수동으로 구성하려면 수동으로 구성을 선택합니다. 자세한 내용은 에서 GitHub 수동으로 웹후크 구성 문서를 참조하십시오.

      중요사항:
      • 홈페이지 또는 도구 모듈에서 연결하는 경우 연결이 완료되고 요약 페이지로 이동합니다.
      • 애플리케이션 모듈에서 연결하는 경우 사용 가능한 리포지토리와 파이프라인이 검색됩니다. 이력 데이터를 추적하고 가져올 수 있습니다.
    7. 추적할 계획을 선택합니다.

      1. 업데이트를 추적하고 애플리케이션에 연결할 계획을 선택합니다.

        도구 온보딩이 완료되면 선택한 계획에 대한 작업 항목만 자동으로 임포트됩니다.

      2. 다음을 선택합니다.

        계획 플레이북 단계 추적

    8. 추적할 리포지토리를 선택합니다.
      1. 업데이트를 추적하고 애플리케이션에 연결할 리포지토리를 선택합니다.

      2. 다음을 선택합니다.

        추적할 리포지토리를 선택합니다.

      3. 리포지토리 데이터를 임포트하려면 날짜 범위를 선택하고 제출을 선택합니다.

        최대 90일 동안의 데이터를 임포트할 수 있습니다. 리포지토리와 연결된 워크플로우도 임포트됩니다.

    9. 추적할 파이프라인을 선택합니다.

      1. 업데이트를 추적하고 애플리케이션에 연결할 파이프라인을 선택합니다.

      2. 다음을 선택합니다.

      3. 선택한 파이프라인별로 마지막으로 성공한 실행에 해당하는 모든 단계 또는 스테이지가 임포트됩니다. 파이프라인 단계에 서비스 할당 활동에서 각 파이프라인 단계에 대해 다음을 선택할 수 있습니다.

        1. 파이프라인 단계 유형: 서비스를 할당할 단계 유형을 선택합니다.

          팁:
          Prod deploy 성공적인 파이프라인 실행을 프로덕션 배포로 식별할 수 있도록 프로덕션 배포를 DevOps 나타내는 단계의 단계 유형을 적어도 지정하십시오.

        2. 서비스: 파이프라인 단계가 매핑하는 애플리케이션 서비스를 선택합니다 CMDB .

          애플리케이션 서비스는 대략 환경에 매핑됩니다. 동일한 파이프라인 단계를 사용하여 다른 환경에 배포하는 경우 필드를 비워 둡니다. 서비스 정보를 사용하면 DevOps 인시던트, 중단 등과 같은 운영 메트릭을 식별하고 보고할 수 있습니다.

      4. 다음을 선택합니다.

        GitHub에서 파이프라인에 서비스를 할당합니다.

    10. 요약 페이지에서 도구 기록 보기를 선택하여 연결된 GitHub 도구의 세부 정보를 검토합니다.

      연결 요약

      파이프라인의 경우 GitHub Actions 비밀 생성, 에서 워크플로우 구성 GitHub정의 등과 같은 몇 가지 추가 단계를 수행해야 합니다. 자세한 내용은 GitHub Actions 구성 문서를 참조하십시오.

    결과

    도구를 DevOps 변경 속도에 성공적으로 온보딩 GitHub 했습니다.

    다음에 수행할 작업

    GitHub 도구가 온보딩된 후에도 계획을 수동으로 검색할 수 있습니다. GitHub에 계획 엔터티가 없으므로 리포지토리는 ServiceNow에서 해당 계획 기록을 검색하는 것으로 간주됩니다.

    1. 도구 기록 페이지에서 검색을 선택하여 계획을 검색합니다.
    2. 구성을 선택합니다. 계획이 추적되고 작업 항목에 대한 실시간 알림을 전송하기 위해 호출된 issues 웹후크가 생성됩니다.
    다음 정보는 GitHub에서 해당 문제가 업데이트될 때 ServiceNow의 작업 항목에 대해 업데이트됩니다.
    • 문제 제목 변경
    • 담당자 업데이트
    • 이전 문제
      주:
      문제가 전송되면 문제가 전송되는 리포지토리에서 동일한 항목이 이전됨으로 표시되고 전송되는 리포지토리에서 열립니다.
    • 문제 삭제
      주:
      GitHub에서 문제가 삭제되면 해당 작업 항목이 ServiceNow에서 삭제되지 않지만 작업 항목의 상태는 삭제됨으로 표시됩니다.

    업그레이드 고객인 경우 정기적으로 검색하거나 수동 검색을 통해 검색할 예약된 작업을 통해 리포지토리에 대한 계획이 검색됩니다. 계획이 검색되면 속성을 활성화 sn_devops.track.github.issues 하여 이전에 구성된 모든 리포지토리를 한 번에 재구성하여 모든 계획을 추적하고 작업 항목에 대한 문제 웹후크를 생성할 수 있습니다.

    주:
    계획의 이력 임포트는 지원되지 않습니다.