Snyk에서 조직 생성

이 페이지는 Snyk에서 조직(Organizations, Orgs)을 생성하기 위한 지침을 담고 있습니다.

• Snyk에서 조직을 생성하기 위한 데이터 생성

  • GitHub

  • GitLab

  • Bitbucket Server

  • Bitbucket Cloud

  • Azure

• 조직 생성 방법

  • API 사용

  • orgs:create 유틸리티 사용

• 권장 사항

가져오기(import)를 시작하기 전에 프로젝트를 채울 조직을 Snyk에 설정해야 합니다.

Snyk은 가져오려는 소스에 있는 조직 수만큼 Snyk에도 조직을 만들 것을 권장합니다. GitHub의 경우, GitHub 조직을 Snyk에 미러링하는 것을 의미합니다. snyk-api-import 도구는 Snyk에서 그룹(Groups) 및 조직(Organizations)을 사용할 때 이를 더 간단하게 만들어주는 유틸리티를 제공합니다.

orgs:data 유틸리티를 사용하여 Snyk에서 조직을 생성하는 데 필요한 데이터 생성

이 유틸리티는 GitHub.com, GitHub Enterprise, GitLab, Bitbucket Server 또는 Bitbucket Cloud 조직 구조를 Snyk에 미러링하는 데 필요한 데이터를 생성하는 데 도움이 됩니다. 이 유틸리티는 GitHub.com, GitHub Enterprise, GitLab, Bitbucket Server 또는 Bitbucket Cloud의 모든 조직이 Snyk의 조직이 되어야 한다고 가정합니다. 이것이 원하는 방식이 아니라면, 새 조직 생성 API 엔드포인트를 직접 사용하여 필요한 구조를 생성하는 것을 고려하십시오.

옵션

  --source             가져올 대상의 소스
                       (예: Github, Github Enterprise, Gitlab,
                       Bitbucket Server) [필수].
  --groupId            Snyk 그룹의 공개 ID (그룹 설정에서 확인 가능) [필수].
  --sourceUrl          조직을 나열할 수 있는 소스 API의 사용자 정의 기본 URL
                       (예: GitHub Enterprise URL).
  --sourceOrgPublicId  모든 지원되는 조직 설정을 복사하기 위한 템플릿으로
                       사용할 Snyk 조직의 공개 ID.
  --skipEmptyOrgs      대상이 없는 조직은 건너뜀 
                       (예: 리포지토리가 없는 Github 조직).

GitHub.com 및 GitHub Enterprise

1. GitHub.com 개인 액세스 토큰을 환경 변수로 설정합니다: export GITHUB_TOKEN=your_personal_access_token

2. 조직 데이터를 생성하기 위한 명령을 실행합니다.

• GitHub.com: snyk-api-import orgs:data --source=github --groupId=<snyk_group_id>

• GitHub Enterprise: snyk-api-import orgs:data --source=github-enterprise --groupId=<snyk_group_id> -- sourceUrl=https://ghe.custom.github.com/

이 명령은 group-<snyk_group_id>-github-<com|enterprise>-orgs.json 파일에 조직 데이터를 생성합니다.

GitLab.com 및 Hosted GitLab

1. GitLab 개인 액세스 토큰을 환경 변수로 설정합니다: export GITLAB_TOKEN=your_personal_access_token

2. 조직 데이터를 생성하기 위한 명령을 실행합니다.

• GitLab: snyk-api-import orgs:data --source=gitlab --groupId=<snyk_group_id>

• Hosted GitLab: snyk-api-import orgs:data --source=gitlab --groupId=<snyk_group_id> -- sourceUrl=https://gitlab.custom.com

이 명령은 group-<snyk_group_id>-gitlab-orgs.json 파일에 조직 데이터를 생성합니다.

Bitbucket Server

Bitbucket Server는 호스팅된 환경이며, 명령에 Bitbucket Server 인스턴스의 사용자 정의 URL을 제공해야 합니다.

1. Bitbucket Server 액세스 토큰을 환경 변수로 설정합니다: export BITBUCKET_SERVER_TOKEN=your_personal_access_token

2. 조직 데이터를 생성하기 위한 명령을 실행합니다.\ snyk-api-import orgs:data --source=bitbucket-server --groupId=<snyk_group_id> --sourceUrl=https://bitbucket-server.custom.com

이 명령은 group-<snyk_group_id>-bitbucket-server-orgs.json 파일에 조직 데이터를 생성합니다.

Bitbucket Cloud

Bitbucket Cloud의 URL은 https://bitbucket.org/ 입니다.

1. Bitbucket Cloud 사용자 이름(Username)과 비밀번호(Password)를 환경 변수로 설정합니다: export BITBUCKET_CLOUD_USERNAME=your_bitbucket_cloud_username 및 export BITBUCKET_CLOUD_PASSWORD=your_bitbucket_cloud_password

2. 조직 데이터를 생성하기 위한 명령을 실행합니다.\ snyk-api-import orgs:data --source=bitbucket-cloud --groupId=<snyk_group_id>

이 명령은 group-<snyk_group_id>-bitbucket-cloud-orgs.json 파일에 조직 데이터를 생성합니다.

Azure

Azure의 경우 이 단계를 수동으로 수행해야 합니다. Azure에는 Azure 조직을 가져오기 위한 API 호출이 없으므로, 다음 명령을 실행하기 위해 Orgs 파일을 수동으로 생성해야 합니다. 파일 형식은 다음과 같아야 합니다.

{
   "orgs":[
      {
         "name":"THE_NAME_OF_AN_AZURE_ORG",
         "groupId":"YOUR_SNYK_GROUP_ID",
         "sourceOrgId":"THE_SNYK_ORG_ID_FROM_WHICH_TO_COPY_THE_SETTINGS_FROM"   // **선택 사항**
      },
      {
         "name":"THE_NAME_OF_ANOTHER_AZURE_ORG",
         "groupId":"YOUR_SNYK_GROUP_ID",
         "sourceOrgId":"THE_SNYK_ORG_ID_FROM_WHICH_TO_COPY_THE_SETTINGS_FROM"  // **선택 사항**
      }
   ]
}

파일이 생성된 후, orgs:create 명령에 입력할 수 있습니다.

조직 생성 방법

생성된 데이터 파일을 사용하여 새 조직 생성 API 엔드포인트를 통해 조직을 생성하거나 제공된 유틸리티를 사용하십시오.

API 사용

생성된 데이터를 새 조직 생성 엔드포인트에 입력하여 그룹 내에 조직을 생성합니다.

orgs:create 유틸리티 사용

1. SNYK_TOKEN 환경 변수에 Snyk API 토큰을 설정합니다.

2. 조직을 생성하기 위한 명령을 실행합니다: snyk-api-import orgs:create --noDuplicateNames --includeExistingOrgsInOutput --file=group-<snyk_group_id>-github-<com|enterprise>-orgs.json.

3. noDuplicateNames 플래그(선택 사항)를 사용하면 그룹 내에서 지정된 이름이 이미 사용 중인 경우 조직 생성을 건너뜁니다.

4. includeExistingOrgsInOutput 플래그(선택 사항, 기본값은 true)를 사용하여 새로 생성된 조직뿐만 아니라 기존 조직에 대한 정보도 로그에 기록합니다. 이 플래그를 false로 설정하려면 명령에서 다음과 같이 --no-includeExistingOrgsInOutput을 사용하십시오: snyk-api-import orgs:create --no-includeExistingOrgsInOutput --file=group-<snyk_group_id>-github-<com|enterprise>-orgs.json

이 명령에 필요한 파일 형식은 다음과 같습니다.

"orgs": [
  {
    "groupId": "<public_snyk_group_id>",
    "name": "<name_of_the_organization>",
    "sourceOrgId": "<public_snyk_organization_id>"
  }
]

• groupId - 조직이 생성될 Snyk 그룹의 공개 ID

• name - 조직을 생성할 때 사용할 이름

• sourceOrgId - 선택 사항 설정을 복사해올 Snyk 조직의 공개 ID

권장 사항

• 가져오기 알림을 받지 않으려면 알림 설정 엔드포인트를 사용하여 이메일 등의 알림을 비활성화하십시오.

• SCM(GitHub, GitLab, Bitbucket 등)에 추가 요청을 보내는 것을 피하기 위해 가져오기가 완료될 때까지 업데이트(통합 설정) 엔드포인트를 사용하여 Fix PR 및 PR 검사를 비활성화하십시오.