GitHub Enterprise
기능 가용성
GitHub Enterprise 통합은 Enterprise 플랜에서만 사용할 수 있습니다. 자세한 내용은 플랜 및 가격을 참조하십시오.
Snyk Enterprise 플랜 고객인 경우 Snyk은 GitHub Enterprise 통합을 사용할 것을 권장합니다. 자체 호스팅 GitHub Enterprise 제품을 사용하는 경우 GitHub Enterprise 통합을 사용해야 합니다.
GitHub Enterprise 통합의 전제 조건
인터넷에 액세스할 수 있는 리포지토리. 리포지토리가 인터넷에 액세스할 수 없는 경우 Snyk Broker를 사용해야 합니다. 이를 위해서는 시작 스크립트를 만들어야 합니다. 스크립트 및 지침은 Docker를 사용하여 GitHub Enterprise 설치 및 구성을 참조하십시오.
공개 또는 비공개 GitHub 프로젝트.
Snyk 조직 관리자 사용자 역할. 자세한 내용은 사전 정의된 역할을 참조하십시오.
필요한 PAT 및 GitHub 리포지토리 액세스 범위 권한. 자세한 내용은 GitHub 및 GitHub Enterprise 권한 요구 사항을 참조하십시오.
Snyk GitHub Enterprise 통합을 사용하기 위해 GitHub Enterprise 수준 플랜에 가입할 필요는 없습니다.
GitHub Enterprise 통합 기능
GitHub Enterprise 통합을 통해 다음을 수행할 수 있습니다.
통합된 모든 리포지토리에서 주기적인 보안 스캔 수행.
오픈소스 구성 요소에서 취약점 탐지.
GitHub의 상태 확인을 통해 자동화된 수정 및 업그레이드 제공.
GitHub Enterprise 통합 설정 방법
다음 단계에 따라 Snyk을 GitHub 리포지토리에 연결하십시오.
Snyk 권한으로 모니터링하려는 리포지토리에 대해 쓰기 수준 이상의 범위를 가진 GitHub Enterprise에서 전용 서비스 계정을 만듭니다. 자세한 내용은 GitHub 계정 유형 및 GitHub 통합에 필요한 액세스 범위를 참조하십시오. PR 확인에 필요한 웹훅을 만들려면 계정에 대한 리포지토리 권한이
Admin이어야 합니다. GitHub 사용자 지정 역할은 지원되지 않습니다.해당 계정에 대한 개인용 액세스 토큰 생성.
개인용 액세스 토큰 생성
개발자 설정에서 GitHub Enterprise에서 개인용 액세스 토큰(PAT) 또는 세분화된 PAT를 생성해야 합니다.
준수해야 하는 액세스 범위 요구 사항에 대한 자세한 내용은 GitHub 및 GitHub Enterprise 권한 요구 사항을 참조하십시오.
개인용 액세스 토큰을 승인하고 SSO를 활성화하는 방법
Snyk에서 통합 페이지로 이동하여 GitHub Enterprise 카드를 클릭합니다.
GitHub Enterprise URL과 생성한 서비스 계정에 대한 개인용 액세스 토큰(PAT)을 입력하고 변경 사항을 저장합니다. Snyk이 GitHub 인스턴스에 성공적으로 연결되면 선택할 수 있는 사용 가능한 리포지토리 목록이 표시됩니다.
GitHub Enterprise 조직이 SAML/SSO를 적용하는 경우 PAT가 생성된 후 GitHub에서 PAT 옆에 있는 SSO 구성을 선택합니다. 때로는 PAT 및 통합이 구성된 후 GitHub Enterprise 조직에서 SSO가 적용됩니다. 이 경우 이미 가져온 모든 프로젝트가 Snyk에 표시되지만 재테스트, PR 확인 등은 수행되지 않습니다. 이 문제를 해결하려면 SSO 구성 설정을 확인하여 GitHub Enterprise 조직이 승인됨인지 확인하십시오. 조직이 승인됨으로 표시되지만 문제가 계속되면 조직을 승인 취소한 다음 다시 승인해 보십시오.
GitHub Enterprise Cloud와 통합하려면 URL https://api.github.com을 추가하십시오. 자체 호스팅 GitHub Enterprise와 통합하려면 PAT 승인의 2단계에서 URL https://your.github-enterprise.host를 추가하십시오.
URL 뒤에 /와 같은 후행 문자가 없는지 확인하십시오. URL에 후행 문자가 있는 통합은 성공적으로 연결될 수 있지만 GitHub 파일에 대한 잘못된 링크를 제공할 수 있습니다.
GitHub에서 PAT 토큰이 변경되거나 만료되면 Snyk과의 통합이 작동하지 않습니다. 이 문제를 해결하려면 Snyk GitHub Enterprise 통합 설정에서 토큰을 업데이트하십시오.
GitHub 리포지토리 가져오는 방법
Snyk으로 가져올 리포지토리를 선택하고 선택한 리포지토리 추가를 클릭합니다.
Snyk은 선택한 리포지토리에서 전체 디렉토리 트리의 package.json과 같은 종속성 파일을 스캔하기 시작하고 리포지토리를 Snyk에 프로젝트로 가져옵니다.
가져온 프로젝트는 프로젝트 페이지에 나타나며 지속적으로 취약점을 확인합니다.
GitHub Enterprise 통합 사용
프로젝트 수준 보안 보고서 받기
Snyk은 고급 보안 보고서를 생성하여 리포지토리에서 발견된 취약점을 탐색하고 필요한 업그레이드 또는 패치로 리포지토리에 직접 수정 풀 리퀘스트를 열어 수정할 수 있도록 합니다.
다음 예는 프로젝트 수준 보안 보고서를 보여줍니다.
프로젝트 모니터링 및 자동 수정 풀 리퀘스트 생성
Snyk은 매일 또는 매주 프로젝트를 스캔합니다. 새로운 취약점이 발견되면 Snyk은 이메일로 알리고 리포지토리에 대한 수정 사항이 포함된 자동화된 풀 리퀘스트를 엽니다.
다음 예는 Snyk이 연 수정 풀 리퀘스트를 보여줍니다.
자동 수정 풀 리퀘스트 설정을 검토하고 업데이트하려면 다음을 수행하십시오.
Snyk에서 설정 > 통합 > GitHub Enterprise로 이동합니다.
자동 수정 풀 리퀘스트 섹션으로 스크롤한 다음 필요에 따라 옵션을 선택합니다.
새로운 풀 리퀘스트 테스트
PR 확인 기능을 사용하면 Snyk이 리포지토리에서 새로 생성된 모든 풀 리퀘스트에 대해 보안 취약점을 테스트하고 상태 확인을 GitHub로 보냅니다. 이를 통해 GitHub에서 직접 풀 리퀘스트가 새로운 보안 문제를 도입하는지 여부를 확인할 수 있습니다.
다음 예는 GitHub의 풀 리퀘스트 페이지에 Snyk 풀 리퀘스트 확인이 어떻게 나타나는지 보여줍니다.
풀 리퀘스트 테스트 설정을 검토하고 조정하려면 다음을 수행하십시오.
조직 설정 > 통합 > GitHub Enterprise로 이동합니다.
Snyk PR 상태 확인으로 스크롤합니다. 자세한 내용은 PR 확인 구성을 참조하십시오.
사용자에게 풀 리퀘스트를 할당하는 방법
기능 가용성
자동 할당 PR 기능은 비공개 리포지토리에서만 지원됩니다.
Snyk은 생성하는 풀 리퀘스트를 자동으로 할당하여 올바른 팀원이 처리하도록 할 수 있습니다.
PR에 대한 자동 할당은 GitHub 및 GitHub Enterprise 통합 및 GitHub를 통해 가져온 모든 프로젝트 또는 프로젝트별로 활성화할 수 있습니다.
사용자를 수동으로 지정하여 모두 할당하거나 마지막 커밋 사용자 계정을 기반으로 자동으로 선택할 수 있습니다.
GitHub Enterprise 통합의 모든 프로젝트에 대해 자동 할당 활성화
가져온 비공개 리포지토리의 모든 프로젝트에 대한 자동 할당 설정을 구성하려면 조직 설정 > 통합 > GitHub를 사용하여 Github 통합 설정으로 이동하고 풀 리퀘스트 할당자 활성화를 선택합니다.
그런 다음 매니페스트 파일을 마지막으로 변경한 사용자 또는 지정된 기여자에게 PR을 할당하도록 선택할 수 있습니다.
풀 리퀘스트 할당자의 경우 매니페스트 파일을 마지막으로 변경한 사용자 옵션은 Git 커밋이 아닌 블레임 데이터를 기반으로 합니다.
단일 프로젝트에 대해 자동 할당 활성화
가져온 비공개 리포지토리의 특정 프로젝트에 대한 자동 할당 설정을 구성하려면 다음 단계를 따르십시오.
조직의 프로젝트 탭에서 관련 비공개 리포지토리를 선택하고 확장한 다음 대상을 선택하고 설정 톱니바퀴를 클릭합니다. 그러면 프로젝트 페이지가 열립니다.
프로젝트 페이지에서 해당 특정 프로젝트에 대한 고유한 설정을 적용합니다. 오른쪽 상단의 설정 탭과 왼쪽 사이드바의 Github 통합 옵션을 선택합니다.
페이지 하단의 비공개 리포지토리에 대한 풀 리퀘스트 할당자 섹션으로 이동하여 통합 설정에서 상속 또는 이 프로젝트에 대해서만 사용자 지정을 선택합니다.
이 비공개 프로젝트에 대한 PR 자동 할당이 활성화되었는지 확인합니다.
매니페스트 파일을 마지막으로 변경한 사용자 또는 지정된 기여자에게 PR을 할당하도록 선택합니다.
GitHub Enterprise 통합을 연결 해제하는 방법
Snyk GitHub Enterprise 통합을 연결 해제하면 가져온 리포지토리에 대한 모든 스캔이 중단됩니다. PR 확인을 실행할 수 없으며 프로젝트가 Snyk 웹 UI에서 비활성화됩니다.
Snyk GitHub Enterprise 통합 설정으로 이동합니다.
페이지 하단에서 GitHub Enterprise 제거를 선택합니다.
확인 모달이 열립니다. 계속하려면 GitHub Enterprise 연결 해제를 선택합니다. \
GitHub Enterprise에서 연결 해제 확인
GitHub Enterprise가 연결 해제되면 가져온 Snyk 프로젝트가 비활성으로 설정되고 더 이상 경고, 풀 리퀘스트 또는 풀 리퀘스트에 대한 Snyk 테스트를 받지 않습니다.
언제든지 다시 연결할 수 있습니다. 그러나 모니터링을 위해 Snyk 프로젝트를 다시 시작하려면 통합을 다시 설정해야 합니다.
Broker 토큰(
필수): Snyk Broker를 사용하는 경우 Broker 토큰을 만들고 추가합니다.Snyk Broker용 Broker 토큰 얻기 페이지의 지침에 따라 Broker 토큰을 생성합니다.
통합 허브의 통합 설정 메뉴에서 Broker 토큰을 복사하여 붙여넣습니다.
API URL(
필수) - API URL을 입력합니다. 기본 URL은https://api.github.com입니다.개인 리포지토리 가져오기(
선택 사항): 소유한 리포지토리만 가져오려면 이 옵션을 활성화합니다.Backstage 카탈로그 추가(
선택 사항): Backstage 카탈로그를 추가하려면 SCM 통합용 Backstage 파일 페이지의 지침을 따르십시오.
Last updated