O Organization Policy Service oferece controle centralizado e programático sobre os recursos da sua organização. Como administrador de políticas da organização, é possível definir uma política da organização, que é um conjunto de limites chamado restrições que se aplicam aos recursos do Cloud Build e aos descendentes desses recursos na hierarquia de recursosGoogle Cloud . É possível aplicar políticas da organização no nível da organização, da pasta ou para envolvidos no projeto.
O serviço de política da organização fornece restrições predefinidas para vários serviços do Cloud Build. No entanto, se você quiser um controle mais granular e personalizável sobre os campos específicos restritos nas suas políticas da organização, crie também políticas da organização personalizadas.
Vantagens
É possível usar uma política da organização personalizada para permitir ou negar recursos específicos do Cloud Build. Por exemplo, se uma solicitação para criar ou atualizar um acionador de build não atender à validação de restrição personalizada definida pela política da sua organização, a solicitação falhará e um erro será retornado ao autor da chamada.
Herança de políticas
Por padrão, as políticas da organização são herdadas pelos descendentes dos recursos em que a política é aplicada. Por exemplo, se você aplicar uma política em uma pasta, o Cloud Build vai aplicar a política a todos os projetos da pasta. Para saber mais sobre esse comportamento e como alterá-lo, consulte Regras de avaliação da hierarquia.
Preços
O Organization Policy Service, incluindo políticas predefinidas e personalizadas, é oferecido sem custos financeiros.
Antes de começar
- Configurar o projeto
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Build API.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Build API.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
- Certifique-se de conhecer o ID da organização.
Funções exigidas
Para receber as permissões necessárias a fim de gerenciar as políticas da organização,
peça ao administrador para conceder a você o
papel do IAM de Administrador de políticas da organização (roles/orgpolicy.policyAdmin
) no recurso da organização.
Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.
Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.
Você também precisa adicionar os papéis necessários para criar o Cloud Build à sua conta de usuário. Consulte Como configurar o acesso aos recursos do Cloud Build. Para saber mais sobre os papéis do IAM associados ao Cloud Build, consulte Papéis e permissões do IAM.
Criar uma restrição personalizada
É possível criar uma restrição personalizada usando um arquivo YAML para definir os recursos, métodos, condições e ações sujeitos à restrição. Eles são específicos do serviço em que você está aplicando a política da organização. As condições das restrições personalizadas precisam ser definidas usando a Common Expression Language. Consulte a página do GitHub sobre a Linguagem de expressão comum (CEL). Para mais informações sobre como criar condições em restrições personalizadas usando a CEL, consulte a seção CEL de Como criar e gerenciar restrições personalizadas.
Use o modelo a seguir para criar um arquivo YAML para uma restrição personalizada:
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
Substitua:
ORGANIZATION_ID
: o ID da organização, como123456789
.CONSTRAINT_NAME
: o nome da sua nova restrição personalizada. Uma restrição personalizada precisa começar comcustom.
e só pode incluir letras maiúsculas, minúsculas ou números, por exemplo,custom.enableBuildTrigger
. O tamanho máximo desse campo é de 70 caracteres, sem contar o prefixo (por exemplo,organizations/123456789/customConstraints/custom.allowConstraint
).RESOURCE_NAME
: o nome (não o URI) do recurso do Cloud Build que contém o objeto e o campo que você quer restringir. Por exemplo,BuildTrigger
.CONDITION
: uma condição de CEL gravada em uma representação de um recurso de serviço compatível. Esse campo tem um comprimento máximo de 1000 caracteres. Consulte Recursos compatíveis para mais informações sobre os recursos disponíveis para gravar condições. Por exemplo,"resource.github.name.contains('cloudbuild')"
.ACTION
: a ação a ser realizada se ocondition
for atendido. Pode serALLOW
ouDENY
.DISPLAY_NAME
: um nome legível para a restrição. Esse campo tem um comprimento máximo de 200 caracteres.DESCRIPTION
: uma descrição legível da restrição a ser exibida como uma mensagem de erro quando a política for violada. Esse campo tem um comprimento máximo de 2000 caracteres.
Para mais informações sobre como criar uma restrição personalizada, consulte Como criar e gerenciar políticas personalizadas da organização.
Configurar uma restrição personalizada
Depois de criar o arquivo YAML para uma nova restrição personalizada, configure-a para disponibilizá-la para as políticas da organização. Para configurar uma restrição personalizada, use o comandogcloud org-policies set-custom-constraint
:
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
CONSTRAINT_PATH
pelo caminho completo
do arquivo da restrição personalizada. Por exemplo, /home/user/customconstraint.yaml
.
Após a conclusão, as restrições personalizadas vão estar disponíveis como políticas da organização
na sua lista de Google Cloud políticas da organização.
Para verificar se a restrição personalizada existe, use o
comando gcloud org-policies list-custom-constraints
:
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
ORGANIZATION_ID
pelo ID do recurso da organização.
Para mais informações, consulte
Como visualizar as políticas da organização.
Aplicar uma política da organização personalizada
Para aplicar uma restrição booleana, crie uma política da organização com referência a ela e aplique essa política da organização a um recurso Google Cloud .Console
- No console do Google Cloud, acesse a página Políticas da organização.
- No seletor de projetos, selecione o projeto em que você quer definir a política da organização.
- Na lista da página Políticas da organização, selecione a restrição para acessar a página Detalhes da política dela.
- Para personalizar a política da organização nesse recurso, clique em Gerenciar política.
- Na página Editar política, selecione Substituir a política do editor principal.
- Clique em Adicionar uma regra.
- Na seção Aplicação, selecione se a aplicação dessa política da organização está ativada ou desativada.
- Opcional: para tornar a política da organização condicional em uma tag, clique em Adicionar condição. Se você adicionar uma regra condicional a uma política da organização, inclua pelo menos uma regra não condicional. Caso contrário, não será possível salvar a política. Para mais informações, consulte Como configurar uma política da organização com tags.
- Se essa for uma restrição personalizada, clique em Testar alterações para simular o efeito da política da organização. Para mais informações, consulte Testar alterações na política da organização com o Simulador de política.
- Para concluir e aplicar a política da organização, clique em Definir política. A política levará até 15 minutos para entrar em vigor.
gcloud
Para criar uma política da organização que aplica uma restrição booleana, crie um arquivo YAML da política com referência à restrição:
name: projects/PROJECT_ID/policies/CONSTRAINT_NAME spec: rules: - enforce: true
Substitua:
-
PROJECT_ID
: o projeto em que você quer aplicar a restrição. -
CONSTRAINT_NAME
: o nome definido para a restrição personalizada. Por exemplo,custom.enableBuildTrigger
.
Para aplicar a política da organização que contém a restrição, execute o seguinte comando:
gcloud org-policies set-policy POLICY_PATH
Substitua POLICY_PATH
pelo caminho completo do arquivo YAML da política da organização. A política leva até 15 minutos para entrar em vigor.
Testar uma restrição personalizada
Para testar uma restrição personalizada, execute um comando gcloud que tente concluir uma tarefa bloqueada por ela.
Por exemplo, suponha que uma restrição exija que os nomes dos acionadores do GitHub contenham "cloudbuild". É possível testar essa restrição executando o comando gcloud builds triggers create github
com outro nome de acionador, conforme demonstrado no snippet a seguir:
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 \
O resultado será assim:
Operation denied by custom org policies: ["customConstraints/custom.enableBuildTrigger": "GitHub trigger name must include "cloudbuild"."]
Recursos e operações com suporte do Cloud Build
Os campos de restrição personalizados do Cloud Build a seguir estão disponíveis para uso ao criar ou atualizar recursos do Cloud Build.
A restrição em builds não é aplicada em builds acionados por gatilho.
- Configuração do Cloud Build
resource.source.storageSource.bucket
resource.source.storageSource.object
resource.source.storageSource.generation
resource.source.storageSource.sourceFetcher
resource.source.repoSource.projectId
resource.source.repoSource.repoName
resource.source.repoSource.branchName
resource.source.repoSource.tagName
resource.source.repoSource.commitSha
resource.source.repoSource.dir
resource.source.repoSource.invertRegex
resource.source.repoSource.substitutions
resource.source.gitSource.url
resource.source.gitSource.dir
resource.source.gitSource.revision
resource.source.storageSourceManifest.bucket
resource.source.storageSourceManifest.object
resource.source.storageSourceManifest.generation
resource.source.connectedRepository.repository
resource.source.connectedRepository.dir
resource.source.connectedRepository.revision
resource.source.developerConnectConfig.gitRepositoryLink
resource.source.developerConnectConfig.dir
resource.source.developerConnectConfig.revision
resource.steps.name
resource.steps.env
resource.steps.args
resource.steps.dir
resource.steps.id
resource.steps.waitFor
resource.steps.entryPoints
resource.steps.secretEnv
resource.steps.volumes.name
resource.steps.volumes.path
resource.steps.timeout
resource.steps.allowFailure
resource.steps.allowExitCodes
resource.steps.script
resource.steps.automapSubstitutions
resource.timeout
resource.images
resource.queueTtl
resource.artifacts.images
resource.artifacts.objects.location
resource.artifacts.objects.paths
resource.logsBucket
resource.options.sourceProvenanceHash
resource.options.requestedVerifyOption
resource.options.machineType
resource.options.diskSizeGb
resource.options.substitutionOption
resource.options.dynamicSubstitutions
resource.options.autoMapSubstitutions
resource.options.logStreamingOption
resource.options.pool.name
resource.options.logging
resource.options.env
resource.options.secretEnv
resource.options.volumes.name
resource.options.volumes.path
resource.options.defaultLogsBucketBehavior
resource.substitutions
resource.tags
resource.secrets.kmsKeyName
resource.secrets.secretEnv
resource.serviceAccount
resource.availableSecrets.secretManager.versionName
resource.availableSecrets.secretManager.env
resource.availableSecrets.inline.kmsKeyName
resource.availableSecrets.inline.envMap
resource.gitConfig.proxySecretVersionName
resource.gitConfig.proxySslCaInfo
resource.gitConfig.http
- 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
- Configuração do WorkerPool do Cloud Build
resource.displayName
resource.annotations
resource.privatePoolV1Config.workerConfig.machineType
resource.privatePoolV1Config.workerConfig.diskSizeGb
resource.privatePoolV1Config.networkConfig.peeredNetwork
resource.privatePoolV1Config.networkConfig.egressOption
resource.privatePoolV1Config.networkConfig.peeredNetworkIpRange
- Configuração do BuildTrigger do Cloud Build
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
- Configuração do 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
- Configuração da conexão do Cloud Build
resource.name
resource.githubConfig.authorizerCredential.oauthTokenSecretVersionName
resource.githubConfig.appInstallationId
resource.githubEnterpriseConfig.hostUrl
resource.githubEnterpriseConfig.apiKey
resource.githubEnterpriseConfig.appId
resource.githubEnterpriseConfig.appSlug
resource.githubEnterpriseConfig.privateKeySecretVersion
resource.githubEnterpriseConfig.webhookSecretSecretVersion
resource.githubEnterpriseConfig.oauthSecretSecretVersion
resource.githubEnterpriseConfig.oauthClientIdSecretVersion
resource.githubEnterpriseConfig.authorizerCredential.oauthTokenSecretVersionName
resource.githubEnterpriseConfig.appInstallationId
resource.githubEnterpriseConfig.serviceDirectoryConfig.service
resource.githubEnterpriseConfig.sslCa
resource.gitlabConfig.hostUri
resource.gitlabConfig.webhookSecretSecretVersion
resource.gitlabConfig.readAuthorizerCredential.oauthTokenSecretVersionName
resource.gitlabConfig.authorizerCredential.oauthTokenSecretVersionName
resource.gitlabConfig.serviceDirectoryConfig.service
resource.gitlabConfig.sslCa
resource.gitlabConfig.serviceDirectoryConfig.service
resource.bitbucketDataCenterConfig.hostUri
resource.bitbucketDataCenterConfig.webhookSecretSecretVersion
resource.bitbucketDataCenterConfig.readAuthorizerCredential.oauthTokenSecretVersionName
resource.bitbucketDataCenterConfig.authorizerCredential.oauthTokenSecretVersionName
resource.bitbucketDataCenterConfig.sslCa
resource.bitbucketDataCenterConfig.serviceDirectoryConfig.service
resource.bitbucketCloudConfig.workspace
resource.bitbucketCloudConfig.webhookSecretSecretVersion
resource.bitbucketCloudConfig.readAuthorizerCredential.oauthTokenSecretVersionName
resource.bitbucketCloudConfig.authorizerCredential.oauthTokenSecretVersionName
- Configuração do repositório do Cloud Build
resource.name
resource.remoteUri
resource.annotations
Exemplos de políticas personalizadas da organização para casos de uso comuns
A tabela a seguir mostra a sintaxe de algumas políticas da organização personalizadas que podem ser úteis:
Descrição | Sintaxe de restrição |
---|---|
Permitir apenas a criação de acionadores do Pub/Sub que detectam tópicos que contêm "cloud-builds" |
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
: o ID da organização, como123456789
.
A seguir
- Consulte Introdução ao serviço Política da organização para saber mais sobre as políticas da organização.
- Saiba mais sobre como criar e gerenciar políticas da organização.
- Veja a lista completa de restrições da política da organização predefinidas.