GitHub - Docker를 사용하여 설치 및 구성

설치하기 전에 사전 준비 사항과 Docker를 사용한 설치에 대한 일반 지침을 검토하십시오.

이 통합은 온프레미스(On-premise) 또는 클라우드 GitHub 배포와 안전한 연결을 보장하는 데 유용합니다.

GitHub와 Broker 통합 구성

GitHub에서 Snyk Broker 클라이언트를 사용하려면 docker pull snyk/broker:github-com을 실행하십시오. 환경 변수의 정의는 GitHub - Snyk Broker용 환경 변수를 참조하십시오.

필요한 경우 고급 구성 페이지로 이동하여 GitHub 인스턴스가 개인 인증서를 사용하는 경우 Broker 클라이언트 구성에 CA(인증 기관)를 제공하거나 프록시 지원을 설정하는 등의 필요한 구성을 변경하십시오.

GitHub용 Broker 클라이언트 설정을 위한 Docker 실행 명령

다음 명령을 복사하여 오픈소스(Open Source), IaC, 컨테이너(Container), 코드 파일(Code Agent 포함) 및 Snyk Essentials 정보를 분석하기 위한 전체 구성이 완료된 Broker 클라이언트를 설정하십시오. 애플리케이션 자산을 식별하고 모니터링하며 위험의 우선순위를 지정하려면 Snyk Essentials를 활성화하십시오.

지역별 멀티 테넌트 설정 설치 시 스크립트에 BROKER_SERVER_URL을 설정하는 명령을 추가해야 합니다. 이는 데이터가 호스팅되는 지역의 Broker 서버 URL입니다. 사용할 명령과 URL은 Broker URL을 참조하십시오.

docker run --restart=always \
           -p 8000:8000 \
           -e BROKER_TOKEN=<secret-broker-token> \
           -e GITHUB_TOKEN=<secret-github-token> \
           -e BROKER_SERVER_URL=<broker-region-url> \
           -e PORT=8000 \
           -e BROKER_CLIENT_URL=<http://broker.url.example:8000 (dns/IP:port)> \
           -e ACCEPT_IAC=tf,yaml,yml,json,tpl \
           -e ACCEPT_CODE=true \
           -e ACCEPT_ESSENTIALS=true \
       snyk/broker:github-com

Snyk Essentials는 기본적으로 false로 설정되어 있습니다. 플래그를 true로 설정하여 활성화하십시오.

Broker 클라이언트 컨테이너 시작 및 GitHub 연결 확인

Broker 클라이언트 구성을 붙여넣어 Broker 클라이언트 컨테이너를 시작하십시오.

컨테이너가 가동된 후 GitHub 통합 페이지에 GitHub 연결이 표시되며 프로젝트 추가(Add Projects)를 할 수 있습니다.

GitHub용 Broker 기본 문제 해결

GitHub의 대용량 매니페스트 파일(> 1Mb) 지원

수정/업그레이드 PR 열기 또는 PR/정기 테스트가 실패하는 한 가지 이유는 대용량 매니페스트 파일(> 1Mb)을 가져오기 때문일 수 있습니다. 이 문제를 해결하려면 대규모 매니페스트 파일의 Snyk 오픈소스 스캔(SCA) (Docker 설정)에 대한 추가 지침을 따라 Broker에서 추가 변수를 활성화하십시오.

최대한의 보안을 보장하기 위해 Snyk은 이 규칙을 기본적으로 활성화하지 않습니다. 이 엔드포인트를 사용하면 경로에 특정 허용 파일 이름이 포함되지 않으므로 이론적으로 Snyk 플랫폼이 이 리포지토리의 모든 파일에 액세스할 수 있기 때문입니다.

GitHub용 Broker 추가 문제 해결

• docker logs <container id>를 실행하여 오류를 확인하십시오. 여기서 container id는 GitHub Broker 컨테이너 ID입니다.

• 관련 포트가 GitHub에 노출되어 있는지 확인하십시오.