API를 사용하여 GitHub 연결 설정

이 페이지는 Universal Broker를 사용하여 GitHub 연결을 설정하는 API 사용 예시를 제공합니다. 필요한 만큼 통합을 위해 조직 연결을 반복하십시오.

더 쉬운 경험을 위해 snyk-broker-config CLI 도구를 사용할 것을 권장합니다. API는 자동화와 더 많은 제어를 가능하게 하지만, Broker 배포, 자격 증명, 연결 및 통합에 대한 명확한 이해가 필요합니다.

이후의 모든 호출에서 api.snyk.io를 필요한 경우 지역별 해당 URL로 바꾸십시오. 예: api.eu.snyk.io. URL 목록은 API URL을 참조하십시오.

조직에 Broker 앱 설치하기

Universal Broker 앱은 OAuth를 통해 Broker 서버와의 안전한 연결 및 통신을 용이하게 합니다.

조직(Organization) 레벨에서 Broker 앱을 설치하십시오. 그룹(Group) 레벨 설치는 지원되지 않습니다. 조직에 Snyk 앱 설치 엔드포인트를 사용하십시오. API를 호출할 때마다 Snyk Broker 앱 ID를 사용하십시오. Snyk Broker 앱 ID는 각 지역마다 다릅니다.

배포 생성하기

다음 호출을 사용하여 배포(deployment)를 생성하십시오.

curl --location --request POST 'https://api.snyk.io/rest/tenants/TENANT_ID/brokers/installs/INSTALL_ID/deployments?version=2024-02-08~experimental' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Authorization: token YOUR_SNYK_TOKEN' \
--data-raw '{ \
    "data": { \
        "type": "broker_deployment", \
        "attributes": { \
            "broker_app_installed_in_org_id":"ORG_ID_WHERE_APP_WAS_INSTALLED", \
            "metadata": { \
                "deployment_name": "My Universal Broker Deployment", \
                "cluster": "Cluster X Region Y or whatever you need to not lose your deployment." \
            } \
        } \
    } \
}'

이것은 DEPLOYMENT_ID (data.id)를 반환합니다. 예:

{ ... "data": { "id": "12345678-1234-1234-1234-123456789012", "type": "broker_deployment", "attributes": { "install_id": "12345678-1234-1234-1234-123456789012", "metadata": { "deployment_name": "My Universal Broker Deployment", "cluster": "Cluster X Region Y or whatever you need to not lose your deployment." } } }, ... }

이 시점에서 Broker 클라이언트를 실행하기 시작할 수 있습니다.

Broker 배포 실행하기

필요한 경우 일반적인 -e BROKER_SERVER_URL=https://broker.REGION.snyk.io \를 사용하여 원하는 환경을 대상으로 지정하십시오. URL 목록은 Broker 서버 URL을 참조하십시오.

docker run --restart=always \ -p 8000:8000 \ -e ACCEPT_CODE=true \ -e DEPLOYMENT_ID=<DEPLOYMENTID> \ -e CLIENT_ID=<CLIENTID> \ -e CLIENT_SECRET=<CLIENTSECRET> \ -e UNIVERSAL_BROKER_ENABLED=true \ -e PORT=8000 \ -e BROKER_HA_MODE_ENABLED=true \ snyk/broker:universal

명령이 실행 중일 때 출력에 다음과 같은 메시지가 나타나야 합니다.

{"name":"snyk-broker","hostname":"c918a4e1535a","pid":1,"level":30,"msg":"Found deployment 12345678-1234-1234-1234-123456789012. Waiting for connections. (polling)","time":"2024-06-18T20:15:20.572Z","v":0}

자격 증명 참조 생성하기

curl --location --request POST 'https://api.snyk.io/rest/tenants/TENANT_ID/brokers/installs/INSTALL_ID/deployments/DEPLOYMENT_ID/credentials?version=2024-02-08~experimental' \ --header 'Content-Type: application/vnd.api+json' \ --header 'Authorization: token YOUR_SNYK_TOKEN' \ --data-raw '{ \ "data": { \ "type": "deployment_credential", \ "attributes": [ \ { "comment": "This is github token service account XYZ (example)", "environment_variable_name": "MY_GITHUB_TOKEN", "type": "github" }] } }'

이것은 자격 증명 참조 ID (data.id)를 반환합니다. 예:

{ ... "data": { "id": "12345678-1234-1234-1234-123456789012", "type": "deployment_credential", "attributes": { "comment": "test cred", "deployment_id": "12345678-1234-1234-1234-123456789012", "environment_variable_name": "MY_GITHUB_TOKEN", "type": "github" } }, ... }

attributes에 더 많은 객체를 추가하여 한 번의 호출로 최대 10개의 자격 증명을 생성할 수 있습니다. 이러한 객체는 서로 다른 유형일 수 있습니다.

... "attributes": [ \ { "comment": "This is github token service account XYZ (example)", "environment_variable_name": "MY_GITHUB_TOKEN", "type": "github" }, { "comment": "This is my other github token service account ABC (example)", "environment_variable_name": "MY_OTHER_GITHUB_TOKEN", "type": "github" }] ...

연결 생성하기

curl --location --request POST 'https://api.snyk.io/rest/tenants/TENANT_ID/brokers/installs/INSTALL_ID/deployments/DEPLOYMENT_ID/connections?version=2024-02-08~experimental' \ --header 'Content-Type: application/vnd.api+json' \ --header 'Authorization: token YOUR_SNYK_TOKEN' \ --data-raw '{ \ "data": { \ "type": "broker_connection", \ "attributes": { \ "name": "my github connection", \ "configuration": { \ "required": { \ "github_token": "CRED_REFERENCE_UUID", \ "broker_client_url":"http://your.broker.hostname:port" \ }, \ "type": "github" \ }, \ "deployment_id": "DEPLOYMENT_ID" \ } \ } \ }'

이것은 예시에 표시된 대로 연결 ID (data.id)를 반환합니다. 이 호출은 자격 증명 참조 UUID 대신 바로 사용할 수 있는 자격 증명 참조를 직접 반환한다는 점에 유의하십시오.

{ ... "data": { "id": "12345678-1234-1234-1234-123456789012", "type": "broker_connection", "attributes": { "deployment_id": "12345678-1234-1234-1234-123456789012", "name": "my github connection", "secrets": { "primary": { "encrypted": "not-yet-implemented", "expires_at": "1970-01-01T00:00:00.000Z", "nonce": "not-yet-implemented" }, "secondary": { "encrypted": "not-yet-implemented", "expires_at": "1970-01-01T00:00:00.000Z", "nonce": "not-yet-implemented" } }, "configuration": { "required": { "broker_client_url": "dummy", "github_token": "${MY_GITHUB_TOKEN}" }, "type": "github" } } }, ... }

자격 증명 참조가 누락된 경우 다음 메시지가 표시됩니다.

{"name":"snyk-broker","hostname":"029cda64bd98","pid":1,"level":50,"connection":"my github connection","msg":"Connection is missing environment variable value MY_GITHUB_TOKEN. Connection is disabled till value is provided. Restart broker once added.","time":"2024-06-18T14:29:06.910Z","v":0} {"name":"my github connection","hostname":"029cda64bd98","pid":1,"level":50,"id":"12345678-1234-1234-1234-123456789012","msg":"Connection is disabled due to (a) missing environment variable(s). Please provide the value and restart the broker client.","time":"2024-06-18T14:29:06.911Z","v":0}

환경 변수를 업데이트할 때는 Broker를 재시작해야 합니다. 새 환경 변수를 위한 Broker 재시작을 참조하십시오.

이제 조직 통합에서 연결을 사용할 수 있습니다.

연결을 사용하도록 조직 통합 연결하기

curl --location --request POST 'https://api.snyk.io/rest/tenants/TENANT_ID/brokers/connections/CONNECTION_ID/orgs/ORG_ID/integration?version=2024-02-08~experimental' \ --header 'Content-Type: application/vnd.api+json' \ --header 'Authorization: token YOUR_SNYK_TOKEN' \ --data-raw '{ \ "data": { \ "integration_id": "INTEGRATION_ID", \ "type": "github" \ } }'

필요한 만큼 통합을 위해 조직 연결을 반복하십시오.