SCM 통합 및 Snyk Broker
SCM 인스턴스가 공개적으로 액세스할 수 없는 경우 Snyk Broker가 필요합니다. Docker 또는 Helm을 사용하여 Snyk Broker를 설치하고 구성할 수 있습니다. Snyk Broker에 대한 자세한 내용은 Snyk Broker와 Snyk Essentials 사용을 포함한 Snyk Broker 설명서를 참조하십시오.
명령을 실행하기 전에 Snyk Broker 배포 환경에서 Snyk Essentials 플래그를 활성화하십시오.
GitHub에서 통합에 대해 허용된 액세스 가능한 엔드포인트 목록을 포함하는 모든 업데이트된 .json 파일을 찾을 수 있습니다.
클래식 Broker를 위한 통합 SCM 토큰
Broker 클라이언트 설정에 통합 SCM 토큰이 필요합니다. -e <SCM>_TOKEN 매개변수(예: -e GITHUB_TOKEN=xxx…)에서 SCM에 대한 액세스를 활성화하는 데 사용됩니다. 이는 Broker 및 Snyk Code의 작동에 필요한 특정 권한을 충족합니다.
다음 SCM 통합에 대해 통합 SCM 토큰을 생성할 수 있습니다.
GitHub 및 GitHub Enterprise SCM 토큰
형식: GITHUB_TOKEN= - GitHub 개인용 액세스 토큰. 범위: repo, read:org 및 admin:repo_hook.
GitLab SCM 토큰
형식: GITLAB_TOKEN= - GitLab 개인용 액세스 토큰. 범위: api.
유지 관리자 권한이 있는 GitLab 계정.
Azure 리포지토리(TFS) SCM 토큰
형식: AZURE_REPOS_TOKEN= - Azure Repos 개인용 액세스 토큰. 범위: 사용자 지정 정의, 코드: 읽기 및 쓰기_.
Bitbucket 서버/데이터 센터 SCM 토큰
형식: BITBUCKET_USERNAME=, BITBUCKET_PASSWORD= – Bitbucket 서버 사용자 이름 및 암호 또는 Bitbucket 서버 개인용 액세스 토큰. 범위: 리포지토리 관리자.
Universal Broker용 GitHub 서버 앱
GitHub 서버를 공개적으로 사용할 수 없는 경우 내부 네트워크에 배포된 프록시인 Universal Broker를 통해 액세스를 제공하여 Snyk과의 아웃바운드 연결 및 통신을 용이하게 할 수 있습니다.
Universal Broker의 설정 프로세스에는 다음이 포함됩니다.
Universal Broker용 GitHub 앱 만들기
GitHub 서버 앱을 Universal Broker와 함께 사용하려면 GitHub 서버 인스턴스에 자체 GitHub 앱을 만들어야 합니다. 다음에 나오는 미리 정의된 GITHUB-SERVER-URL을 사용하여 Snyk 서비스에 필요한 모든 권한을 포함하여 이 작업을 수행할 수 있습니다.
위 URL에서 다음을 바꿉니다.
{{GITHUB-SERVER-URL}}: GitHub 서버 인스턴스의 기본 URL로 바꿉니다.{{SNYK-ENV}}: Snyk 계정의 테넌시로 바꿉니다. 이 값은 URL로 인코딩해야 합니다. 가장 일반적인 값은 다음과 같습니다.Snyk US-01: https%3A%2F%2Fapp.snyk.io
Snyk EU: https%3A%2F%2Fapp.eu.snyk.io
Snyk AU: https%3A%2F%2Fapp.au.snyk.io
Snyk US-02: https%3A%2F%2Fapp.us.snyk.io
값을 바꾼 후 해당 URL로 이동합니다. 그러면 필요한 모든 세부 정보가 미리 채워진 GitHub 서버 인스턴스의 앱 생성 화면으로 이동합니다. 그런 다음 페이지 끝으로 스크롤하여 모든 계정 라디오 버튼이 선택되어 있는지 확인한 후 GitHub 앱 만들기 버튼을 클릭합니다.
GitHub 서버 앱을 만들 때 ClientId 및 AppId가 표시됩니다. 이는 앱의 자격 증명이므로 안전하게 저장하고 비밀로 취급해야 합니다.
GitHub 서버 앱을 만든 후 페이지 상단에 개인 키를 만들라는 배너가 표시됩니다. 클릭하여 앱에 대한 개인 키를 만듭니다.
개인 키를 생성하면 .pem 파일 다운로드가 시작됩니다. 이는 비밀로 취급하고 안전하게 보관해야 합니다.
이제 GitHub 서버 앱을 Snyk 조직의 리포지토리에 설치할 준비가 되었습니다. 동일한 페이지 상단으로 스크롤하여 왼쪽 패널에서 앱 설치를 선택할 수 있습니다. 새로 만든 앱을 선택하고 오른쪽에 있는 설치 버튼을 클릭합니다.
GitHub 조직에 앱을 설치할 위치를 선택합니다. 특정 리포지토리 또는 GitHub 조직의 모든 리포지토리에 설치할 수 있습니다.
GitHub 조직의 리포지토리 하위 집합에 앱을 설치하도록 선택하면 앱은 해당 리포지토리에서만 작동합니다. 나중에 이 화면으로 돌아와 추가 리포지토리에 추가하려는 경우 앱이 설치된 위치를 편집할 수 있습니다.
앱을 설치하면 InstallationID가 할당됩니다. 이는 페이지 URL의 마지막 숫자입니다. Universal Broker 연결을 설정하는 데 필요하므로 해당 번호를 기록해 둡니다.
GitHub 서버 앱에 대한 Universal Broker 연결 만들기
GitHub 서버 앱을 Universal Broker와 함께 사용하려면 snyk-broker-config 도구를 사용하여 github-server-app 유형의 연결을 만들어야 합니다. 자세한 내용은 Universal Broker 설명서를 참조하십시오. 연결이 생성되면 원하는 하나 이상의 조직과 통합할 수 있습니다.
통합을 설정하려면 다음이 필요합니다.
Snyk 지역의 기본 API 주소, Snyk 지역 호스팅에 대한 API URL 목록 참조.
통합을 설정하려는 Snyk 조직 ID.
유효한 Snyk API 토큰.
snyk-broker-config도구 설치됨테넌트 관리자 역할
이러한 전제 조건이 있으면 다음 명령을 사용하십시오.
snyk-broker-config workflows connections create,github-server-app옵션을 선택하고 워크플로에서 묻는 정보를 제공합니다.snyk-broker-config workflows connections integrate새로 만든 연결을 원하는 조직에 통합하고 메시지가 표시되면 조직 ID를 붙여넣습니다.
Snyk의 통합 페이지를 방문하여 통합이 구성되었는지 확인하십시오.
자세한 내용은 Universal Broker 설명서를 참조하십시오.
Last updated