커스텀 제약조건으로 Cloud Build 리소스 관리

조직 정책 서비스를 사용하면 조직 리소스를 중앙에서 프로그래매틱 방식으로 제어할 수 있습니다. 조직 정책 관리자는 Google Cloud 리소스 계층 구조에서 Cloud Build 리소스와 이러한 리소스의 하위 요소에 적용되는 제약조건이라는 제한사항 집합인 조직 정책을 정의할 수 있습니다. 또한, 조직, 폴더, 프로젝트 수준에서 조직 정책을 시행하는 것이 가능합니다.

조직 정책 서비스는 다양한 Cloud Build 서비스에 사전 정의된 제약조건을 제공합니다. 그러나 조직 정책에서 제한되는 특정 필드를 더욱 세부적으로 맞춤설정 가능한 방식으로 제어하려면 커스텀 조직 정책도 만들면 됩니다.

이점

커스텀 조직 정책을 사용하여 특정 Cloud Build 리소스를 허용하거나 거부할 수 있습니다. 예를 들어 빌드 트리거 만들기 또는 업데이트 요청이 조직 정책에 설정된 대로 커스텀 제약조건 검증을 충족하지 못하면 요청이 실패하고 호출자에게 오류가 반환됩니다.

정책 상속

기본적으로 조직 정책은 정책을 적용하는 리소스의 하위 요소에 상속됩니다. 예를 들어 폴더에 정책을 적용하면 Cloud Build에서 폴더의 모든 프로젝트에 정책을 적용합니다. 이 동작 및 변경하는 방법에 대한 자세한 내용은 계층 구조 평가 규칙을 참조하세요.

가격 책정

사전 정의된 조직 정책과 커스텀 조직 정책을 포함한 조직 정책 서비스는 무료로 제공됩니다.

시작하기 전에

프로젝트 설정
1. 조직 ID를 알고 있어야 합니다.

필요한 역할

조직 정책을 관리하는 데 필요한 권한을 얻으려면 관리자에게 조직 리소스에 대한 조직 정책 관리자(roles/orgpolicy.policyAdmin) IAM 역할을 요청하세요. 역할 부여에 대한 자세한 내용은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.

커스텀 역할이나 다른 사전 정의된 역할을 통해 필요한 권한을 얻을 수도 있습니다.

또한 Cloud Build를 사용자 계정에 만드는 데 필요한 역할을 추가해야 합니다. Cloud Build 리소스에 대한 액세스 구성을 참조하세요. Cloud Build와 연관된 IAM 역할에 대한 자세한 내용은 IAM 역할 및 권한을 참조하세요.

커스텀 제약조건 만들기

YAML 파일을 사용하여 커스텀 제약조건을 만들어 제약조건이 적용되는 리소스, 메서드, 조건, 작업을 정의할 수 있습니다. 커스텀 제약조건은 조직 정책을 적용하는 서비스에 따라 달라집니다. Common Expression Language를 사용하여 커스텀 제약조건의 조건을 정의해야 합니다. Common Expression Language(CEL)는 GitHub 페이지를 참조하세요. CEL을 사용해서 커스텀 제약 조건에서 조건을 빌드하는 방법은 커스텀 제약 조건 만들기 및 관리의 CEL 섹션을 참조하세요.

다음 템플릿을 사용하여 커스텀 제약조건의 YAML 파일을 만듭니다.

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- cloudbuild.googleapis.com/RESOURCE_NAME
methodTypes:
- CREATE
- UPDATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

다음을 바꿉니다.

ORGANIZATION_ID: 조직 ID(예: 123456789)
CONSTRAINT_NAME: 새 커스텀 제약조건에 사용하려는 이름입니다. 커스텀 제약조건은 custom.으로 시작해야 하며 대문자, 소문자 또는 숫자만 포함할 수 있습니다(예: custom.enableBuildTrigger). 이 필드의 최대 길이는 프리픽스를 제외하고 70자입니다(예: organizations/123456789/customConstraints/custom.allowConstraint).
RESOURCE_NAME: 제한할 객체와 필드가 포함된 Cloud Build 리소스의 이름입니다(URI 아님). 예를 들면 BuildTrigger입니다.
CONDITION: 지원되는 서비스 리소스의 표현에 대해 작성된 CEL 조건입니다. 이 필드의 최대 길이는 1000자(영문 기준)입니다. 조건을 작성하는 데 사용할 수 있는 리소스에 대한 자세한 내용은 지원되는 리소스를 참조하세요. 예를 들면 "resource.github.name.contains('cloudbuild')"입니다.
ACTION: condition이 충족될 때 수행할 작업입니다. ALLOW 또는 DENY일 수 있습니다.
DISPLAY_NAME: 제약조건에 대한 사용자 친화적인 이름. 이 필드의 최대 길이는 200자(영문 기준)입니다.
DESCRIPTION: 정책을 위반할 때 오류 메시지로 표시할 제약조건에 대한 사용자 친화적인 설명입니다. 이 필드의 최대 길이는 2,000자(영문 기준)입니다.

커스텀 제약조건을 만드는 방법은 커스텀 조직 정책 만들기 및 관리를 참조하세요.

커스텀 제약조건 설정

새 커스텀 제약조건의 YAML 파일을 만든 후에는 조직에서 조직 정책에 사용할 수 있도록 설정해야 합니다. 커스텀 제약조건을 설정하려면 gcloud org-policies set-custom-constraint 명령어를 사용합니다.

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

CONSTRAINT_PATH를 커스텀 제약조건 파일의 전체 경로로 바꿉니다. 예를 들면 /home/user/customconstraint.yaml입니다. 완료되면 Google Cloud 조직 정책 목록에서 조직 정책으로 커스텀 제약조건을 사용할 수 있습니다. 커스텀 제약조건이 존재하는지 확인하려면 gcloud org-policies list-custom-constraints 명령어를 사용합니다.

gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

ORGANIZATION_ID를 조직 리소스 ID로 바꿉니다. 자세한 내용은 조직 정책 보기를 참조하세요.

커스텀 조직 정책 적용

불리언 제약조건을 참조하는 조직 정책을 만들고 해당 조직 정책을 Google Cloud 리소스에 적용하여 불리언 제약조건을 적용할 수 있습니다.

콘솔

Google Cloud 콘솔에서 조직 정책 페이지로 이동합니다.
조직 정책으로 이동
프로젝트 선택 도구에서 조직 정책을 설정할 프로젝트를 선택합니다.
조직 정책 페이지의 목록에서 제약조건을 선택하여 해당 제약조건의 정책 세부정보 페이지를 봅니다.
이 리소스의 조직 정책을 구성하려면 정책 관리를 클릭합니다.
정책 수정 페이지에서 상위 정책 재정의를 선택합니다.
규칙 추가를 클릭합니다.
시행 섹션에서 이 조직 정책 시행을 사용 설정할지 여부를 선택합니다.
선택사항: 태그로 조직 정책을 조건부로 만들려면 조건 추가를 클릭합니다. 조건부 규칙을 조직 정책에 추가하면 비조건부 규칙을 최소 하나 이상 추가해야 합니다. 그렇지 않으면 정책을 저장할 수 없습니다. 자세한 내용은 태그를 사용하여 조직 정책 설정을 참조하세요.
커스텀 제약조건인 경우 변경사항 테스트를 클릭하여 이 조직 정책의 효과를 시뮬레이션할 수 있습니다. 자세한 내용은 정책 시뮬레이터로 조직 정책 변경사항 테스트를 참조하세요.
조직 정책을 완료하고 적용하려면 정책 설정을 클릭합니다. 정책이 적용되는 데 최대 15분이 소요됩니다.

gcloud

불리언 제약조건을 시행하는 조직 정책을 만들려면 제약조건을 참조하는 정책 YAML 파일을 만듭니다.

      name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
      spec:
        rules:
        - enforce: true

다음을 바꿉니다.

PROJECT_ID: 제약조건을 시행할 프로젝트
CONSTRAINT_NAME: 커스텀 제약조건에 대해 정의된 이름. 예를 들면 custom.enableBuildTrigger입니다.

제약조건이 포함된 조직 정책을 시행하려면 다음 명령어를 실행합니다.

    gcloud org-policies set-policy POLICY_PATH

POLICY_PATH를 조직 정책 YAML 파일의 전체 경로로 바꿉니다. 정책이 적용되는 데 최대 15분이 소요됩니다.

커스텀 제약조건 테스트

커스텀 제약조건을 테스트하려면 제약조건에 의해 차단된 태스크를 완료하려고 시도하는 gcloud 명령어를 실행합니다.

예를 들어 제약조건에서 GitHub 트리거 이름에 'cloudbuild'가 포함되어야 한다고 가정합니다. 다음 스니펫에 표시된 것처럼 다른 트리거 이름으로 gcloud builds triggers create github 명령어를 실행하여 이 제약조건을 테스트할 수 있습니다.

gcloud builds triggers create github --name=github-trigger \
    --repo-owner=some-owner \
    --repo-name=some-repo \
    --branch-pattern=main \
    --build-config=cloudbuild.yaml \
    --project=my-project \

출력은 다음과 비슷합니다.

Operation denied by custom org policies: ["customConstraints/custom.enableBuildTrigger": "GitHub trigger name must include "cloudbuild"."]

Cloud Build 지원 리소스 및 작업

Cloud Build 리소스를 만들거나 업데이트할 때 다음 Cloud Build 커스텀 제약조건 필드를 사용할 수 있습니다.

빌드에 대한 제약조건은 트리거에 의해 트리거된 빌드에는 적용되지 않습니다.

Cloud Build BitbucketServerConfig
- resource.name
- resource.hostUrl
- resource.secrets.adminAccessTokenVersionName
- resource.secrets.readAccessTokenVersionName
- resource.secrets.webhookSecretVersionName
- resource.username
- resource.apiKey
- resource.peeredNetwork
- resource.sslCa
- resource.peeredNetworkIpRange
Cloud Build WorkerPool 구성
- resource.displayName
- resource.annotations
- resource.privatePoolV1Config.workerConfig.machineType
- resource.privatePoolV1Config.workerConfig.diskSizeGb
- resource.privatePoolV1Config.networkConfig.peeredNetwork
- resource.privatePoolV1Config.networkConfig.egressOpetion
- resource.privatePoolV1Config.networkConfig.peeredNetworkIpRange
Cloud Build BuildTrigger 구성
- resource.tags
- resource.resourceName
- resource.description
- resource.name
- resource.tags
- resource.triggerTemplate.projectId
- resource.triggerTemplate.repoName
- resource.triggerTemplate.branchName
- resource.triggerTemplate.tagName
- resource.triggerTemplate.commitSha
- resource.triggerTemplate.dir
- resource.triggerTemplate.invertRegex
- resource.triggerTemplate.substitutions
- resource.github.owner
- resource.github.name
- resource.github.enterpriseConfigResourceName
- resource.pubsubConfig.topic
- resource.pubsubConfig.serviceAccountEmail
- resource.webhookConfig.secret
- resource.bitbucketServerTriggerConfig.repoSlug
- resource.bitbucketServerTriggerConfig.projectKey
- resource.bitbucketServerTriggerConfig.pullRequest.branch
- resource.bitbucketServerTriggerConfig.pullRequest.commentControl
- resource.bitbucketServerTriggerConfig.pullRequest.invertRegex
- resource.bitbucketServerTriggerConfig.push.branch
- resource.bitbucketServerTriggerConfig.push.tag
- resource.bitbucketServerTriggerConfig.push.invertRegex
- resource.gitlabEnterpriseEventsConfig.projectNamespace
- resource.gitlabEnterpriseEventsConfig.pullRequest.branch
- resource.gitlabEnterpriseEventsConfig.pullRequest.commentControl
- resource.gitlabEnterpriseEventsConfig.pullRequest.invertRegex
- resource.gitlabEnterpriseEventsConfig.push.branch
- resource.gitlabEnterpriseEventsConfig.push.tag
- resource.gitlabEnterpriseEventsConfig.push.invertRegex
- resource.gitlabEnterpriseEventsConfig.gitlabConfigResource
- resource.disabled
- resource.substitutions
- resource.ignoredFiles
- resource.includedFiles
- resource.sourceToBuild.uri
- resource.sourceToBuild.repository
- resource.sourceToBuild.ref
- resource.sourceToBuild.repoType
- resource.sourceToBuild.githubEnterpriseConfig
- resource.approvalConfig.approvalRequired
- resource.filter
- resource.serviceAccount
- resource.eventType
- resource.includeBuildLogs
- resource.repositoryEventConfig.repository
- resource.repositoryEventConfig.pullRequest.branch
- resource.repositoryEventConfig.pullRequest.commentControl
- resource.repositoryEventConfig.pullRequest.invertRegex
- resource.repositoryEventConfig.push.branch
- resource.repositoryEventConfig.push.tag
- resource.repositoryEventConfig.push.invertRegex
Cloud Build GitHubEnterpriseConfig 구성
- resource.name
- resource.hostUrl
- resource.appId
- resource.name
- resource.webhookKey
- resource.peeredNetwork
- resource.secrets.privateKeyVersionName
- resource.secrets.webhookSecretVersionName
- resource.secrets.oauthSecretVersionName
- resource.secrets.oauthClientIdVersionName
- resource.displayName
- resource.sslCa

일반적인 사용 사례의 커스텀 조직 정책 예시

다음 표에서는 유용한 몇 가지 커스텀 조직 정책 구문을 제공합니다.

설명	제약조건 구문
'cloud-builds'가 포함된 주제를 리슨하는 Pub/Sub 트리거만 만들 수 있도록 허용	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.enableCloudBuildPubsubTrigger resourceTypes: - cloudbuild.googleapis.com/BuildTrigger methodTypes: - CREATE condition: "resource.pubsubConfig != null && resource.pubsubConfig.topic.contains('cloud-builds')" actionType: ALLOW displayName: Enable creating Pub/Sub trigger that listens on topics that contain "cloud-builds". description: Only allow creating Pub/Sub trigger that listens on topics that contain "cloud-builds".

설명

제약조건 구문

'cloud-builds'가 포함된 주제를 리슨하는 Pub/Sub 트리거만 만들 수 있도록 허용

    name: organizations/ORGANIZATION_ID/customConstraints/custom.enableCloudBuildPubsubTrigger
    resourceTypes:
    - cloudbuild.googleapis.com/BuildTrigger
    methodTypes:
    - CREATE
    condition: "resource.pubsubConfig != null && resource.pubsubConfig.topic.contains('cloud-builds')"
    actionType: ALLOW
    displayName: Enable creating Pub/Sub trigger that listens on topics that contain "cloud-builds".
    description: Only allow creating Pub/Sub trigger that listens on topics that contain "cloud-builds".

ORGANIZATION_ID: 조직 ID(예: 123456789)

다음 단계

조직 정책에 대한 자세한 내용은 조직 정책 서비스 소개 참조하기
조직 정책 만들기 및 관리 방법 자세히 알아보기
사전 정의된 조직 정책 제약조건의 전체 목록 참조하기