Universal Broker 설치 및 구성 기본 단계
전용 Snyk Learn 코스에서 Universal Broker에 대해 자세히 알아볼 수 있습니다. Snyk Learn: Universal Broker에서 장점, 구성, 아키텍처 등을 살펴보십시오.
snyk-broker-config CLI 도구를 사용하여 Universal Broker를 설치하고 구성하려면 다음 단계를 따르십시오. 이 도구는 단계를 안내하고 워크플로의 중요한 지점을 표시합니다.
snyk-broker-config CLI 도구 설치 및 설정
도구를 설치하려면 npm i -g snyk-broker-config를 사용하십시오.
snyk-broker-config CLI 도구는 Snyk Broker 연결을 설정하고 관리하기 위한 기본 가이드입니다. 각 통합 유형에 필요한 정보를 요청하면서 프로세스를 단계별로 안내하도록 설계되었습니다. 이 적응형 방식은 도구에서 직접 최신 매개변수 요구 사항을 받을 수 있도록 보장합니다.
새로운 Universal Broker 배포를 구성하는 기본 프로세스는 다음과 같습니다.
npm i -g snyk-broker-config를 실행하여snyk-broker-config도구 설치snyk-broker-config workflows connections create생성 워크플로를 따라 새로운 Universal Broker 연결 생성snyk-broker-config workflows connections integrate통합 워크플로를 따라 새로운 Universal Broker 연결 통합
매개변수 확인을 위해 CLI를 사용하는 방법
전체 설정을 실행하지 않더라도 snyk-broker-config CLI 도구를 사용하여 필요한 매개변수를 이해할 수 있습니다. 대화형 설정 또는 명령줄 도움말을 사용하십시오.
대화형 설정:
snyk-broker-config workflows connections create를 실행하고 프롬프트를 따릅니다. CLI는 GitLab, Artifactory 또는 Bitbucket Server와 같이 선택한 통합 유형에 따라 필요한 모든 필수 및 선택 매개변수를 요청합니다.명령줄 도움말:
snyk-broker-config명령에--help플래그를 사용하여 사용 가능한 옵션과 매개변수를 확인합니다. 예를 들어, GitLab 연결 유형 생성과 특별히 관련된 매개변수를 보려면 다음 명령을 사용하십시오.snyk-broker-config workflows connections create --type gitlab --help
연결 워크플로 예시
CLI를 사용하여 새로운 Broker 연결을 추가하는 일반적인 워크플로는 다음 단계를 포함합니다.
CLI 설치:
대화형 워크플로 시작:
그런 다음 CLI가 프로세스를 안내하며 다음을 요청합니다.
Snyk API 토큰: 환경 변수로 아직 내보내지 않은 경우 인증에 필요합니다.
Broker 연결이 사용되는 Snyk 조직 ID.
연결하려는 구체적인 통합 유형(예:
gitlab,artifactory,bitbucket-server).선택한 통합 유형에 대해 동적으로 식별된 URL, 토큰, 사용자 이름 또는 비밀번호와 같은 모든 필수 및 선택 매개변수. 화면상의 지침을 주의 깊게 따르십시오.
대화형 워크플로는 Broker 연결에 필요한 모든 매개변수가 올바르게 제공되었는지 확인하는 가장 간단한 방법입니다.
첫 번째 연결 생성
이 단계에서는 Snyk 플랫폼과 상호 작용하는 데 필요한 설치 ID(install ID), 클라이언트 ID(client ID) 및 클라이언트 시크릿(client secret)을 반환합니다.
설치 후 Universal Broker 연결 생성 워크플로를 시작합니다.
Snyk API 토큰을 입력하고 Enter를 누릅니다.
N을 입력하고 Enter를 누릅니다.
사전 준비 사항에서 생성한 Snyk Broker 관리 조직 ID를 붙여넣고 Enter를 누릅니다.
Broker 앱은 OAuth를 통해 Broker 서버와의 보안 연결 및 통신을 용이하게 합니다.
도구에 방금 설치된 Broker 앱의 자격 증명이 표시됩니다. 다른 자격 증명과 마찬가지로 이를 안전하게 보관하십시오. 클라이언트 시크릿이 표시되는 것은 이번이 유일합니다. 이러한 자격 증명을 분실하면 Snyk Broker 관리 조직을 삭제하고 다시 생성하여 처음부터 시작하거나, API를 사용하여 Universal Broker를 수동으로 재설치해야 합니다.
자격 증명을 저장했으면 Y를 입력하고 Enter를 누릅니다.
사용 편의성을 위해 INSTALL_ID를 환경 변수로 설정할 것을 권장합니다.
export INSTALL_ID=zzzz(Linux/Mac)set INSTALL_ID=zzzz(Windows)
연결 매개변수 입력
여기에는 연결에 필요한 자격 증명 참조(credential references) 생성이 포함됩니다. 각 배포는 최대 25개의 연결로 제한됩니다.
프롬프트에 따라 Y를 입력하고 Enter를 누릅니다.
생성하려는 연결 유형을 선택합니다.
이 예시는 GitHub 연결을 생성하는 것을 보여줍니다. 다른 모든 유형의 연결 생성도 동일한 프로세스를 따릅니다. 각 배포는 25개의 연결로 제한됩니다.
연결을 식별하는 데 도움이 되는 연결 이름을 입력합니다(예: github-connection-for-team-x).
Broker_client_url을 입력합니다. Snyk은 기본값을 사용할 것을 권장합니다. 컨테이너 통합에 필요한 다른 값을 입력할 수 있습니다.
자격 증명 참조를 생성합니다(실제 자격 증명 값이 아님). Broker 클라이언트가 실행될 때 실제 자격 증명 값을 포함할 환경 변수의 이름을 입력합니다(예: MY_GITHUB_TOKEN).
선택적으로, 이 연결을 추적하는 데 도움이 되는 주석을 입력할 수 있습니다.
다음 단계에서 Broker 클라이언트 컨테이너를 실행할 때 -e MY_GITHUB_TOKEN=<SECRET_TOKEN_VALUE>를 추가해야 합니다. 프로덕션 설정에서는 이러한 값이 시크릿 저장소에서 마운트됩니다.
이제 연결이 생성되었습니다.
연결 유효성 검사 (선택 사항)
다음 워크플로를 사용하여 연결에 대한 세부 정보를 표시할 수 있습니다.
Broker 앱 설치 여부를 묻는 메시지가 표시되면 Y를 입력한 다음 이전에 저장한 설치 ID를 붙여넣습니다.
INSTALL_ID를 내보내면 나중에 터미널 세션에서 이 선택적 단계를 피할 수 있습니다. 배포 세부 정보는 다음과 같습니다.
연결 세부 정보가 이어집니다: connection ID, connection type (broker_connection), attributes: deployment_id, identifier, name, and secrets-primary and secondary(각각 status, encrypted, expires_at, nonce 포함), configuration required: broker-client-url 및 github_token values, type: github.
Universal Broker를 사용할 조직과 연결 통합
새로 생성된 Broker 연결을 사용할 조직의 ID를 입력합니다.
이제 조직이 새로운 Broker 연결과 통합되었습니다.
Broker 클라이언트 실행
Broker 클라이언트가 시작되면 연결을 사용할 준비가 된 것이며, 이 경우 리포지토리를 가져올 수 있습니다.
연결이 구성되었는지 확인하려면 조직 설정 (Organization Settings) > 통합 (Integrations) 페이지의 통합 타일이 **구성됨 (Configured)**으로 표시되어 있는지 확인하십시오.
더 많은 조직과 연결 통합
연결을 다른 조직과 통합하려면 integrate 명령을 다시 실행하고 새로운 조직 ID를 입력하십시오. 여러 조직과 연결하기 위해 필요에 따라 반복하십시오.
테넌트의 모든 조직에 대해 필요한 만큼, 필요한 만큼의 많은 통합에 대해 이 단계를 반복하십시오.
Last updated