Faça a gestão de recursos do Cloud Build com restrições personalizadas

O serviço de políticas da organização dá-lhe um controlo centralizado e programático sobre os recursos da sua organização. Enquanto administrador de políticas da organização, pode definir uma política da organização, que é um conjunto de restrições denominadas limitações que se aplicam aos recursos do Cloud Build e aos descendentes desses recursos na Google Cloud hierarquia de recursos. Pode aplicar políticas da organização ao nível da organização, da pasta ou do projeto.

O serviço de políticas da organização fornece restrições predefinidas para vários serviços do Cloud Build. No entanto, se quiser um controlo mais detalhado e personalizável sobre os campos específicos que estão restritos nas políticas da sua organização, também pode criar políticas da organização personalizadas.

Vantagens

Pode usar uma política de organização personalizada para permitir ou negar recursos específicos do Cloud Build. Por exemplo, se um pedido para criar ou atualizar um acionador de compilação não cumprir a validação de restrições personalizadas definida pela política da sua organização, o pedido falha e é devolvido um erro ao autor da chamada.

Herança de políticas

Por predefinição, as políticas da organização são herdadas pelos descendentes dos recursos nos quais aplica a política. Por exemplo, se aplicar uma política a uma pasta, o Cloud Build aplica a política a todos os projetos na pasta. Para saber mais acerca deste comportamento e como o alterar, consulte as regras de avaliação da hierarquia.

Preços

O serviço de políticas de organização, incluindo políticas de organização predefinidas e personalizadas, é oferecido sem custo financeiro.

Antes de começar

  1. Configure o seu projeto
    1. 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.

    2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    3. Verify that billing is enabled for your Google Cloud project.

    4. Enable the Cloud Build API.

      Enable the API

    5. Install the Google Cloud CLI.

    6. Se estiver a usar um fornecedor de identidade (IdP) externo, primeiro, tem de iniciar sessão na CLI gcloud com a sua identidade federada.

    7. Para inicializar a CLI gcloud, execute o seguinte comando: 

      gcloud init

    8. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    9. Verify that billing is enabled for your Google Cloud project.

    10. Enable the Cloud Build API.

      Enable the API

    11. Install the Google Cloud CLI.

    12. Se estiver a usar um fornecedor de identidade (IdP) externo, primeiro, tem de iniciar sessão na CLI gcloud com a sua identidade federada.

    13. Para inicializar a CLI gcloud, execute o seguinte comando: 

      gcloud init
    14. Certifique-se de que sabe o seu ID da organização.

      15. Funções necessárias

      Para receber as autorizações de que precisa para gerir políticas da organização, peça ao seu administrador para lhe conceder a função de IAM de administrador de políticas da organização (roles/orgpolicy.policyAdmin) no recurso da organização. Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

      Também pode conseguir as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.

      Também tem de adicionar as funções necessárias para criar o Cloud Build à sua conta de utilizador. Consulte o artigo Configurar o acesso aos recursos do Cloud Build. Para saber mais sobre as funções de IAM associadas ao Cloud Build, consulte o artigo Funções e autorizações de IAM.

      Crie uma restrição personalizada

      Pode criar uma restrição personalizada através de um ficheiro YAML para definir os recursos, os métodos, as condições e as ações sujeitos à restrição. Estas são específicas do serviço no qual está a aplicar a política de organização. As condições para as restrições personalizadas têm de ser definidas através do Idioma de expressão comum. Consulte a página do GitHub sobre o Idioma de expressão comum (IEC). Para mais informações sobre como criar condições em restrições personalizadas através da CEL, consulte a secção CEL do artigo Criar e gerir restrições personalizadas.

      Use o seguinte modelo para criar um ficheiro 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 o seguinte:

      • ORGANIZATION_ID: o ID da sua organização, como 123456789.

      • CONSTRAINT_NAME: o nome que quer para a nova restrição personalizada. Uma restrição personalizada tem de começar com custom. e só pode incluir letras maiúsculas, letras minúsculas ou números. Por exemplo, custom.enableBuildTrigger. O comprimento máximo deste campo é de 70 carateres, sem contar com 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 quer restringir. Por exemplo, BuildTrigger.

      • CONDITION: uma condição CEL escrita em função de uma representação de um recurso de serviço suportado. Este campo tem um comprimento máximo de 1000 carateres. Consulte o artigo Recursos suportados para mais informações sobre os recursos disponíveis para escrever condições. Por exemplo, "resource.github.name.contains('cloudbuild')".

      • ACTION: a ação a tomar se a condição condition for cumprida. Pode ser ALLOW ou DENY.

      • DISPLAY_NAME: um nome simples para a restrição. Este campo tem um comprimento máximo de 200 carateres.

      • DESCRIPTION: uma descrição acessível da restrição a apresentar como uma mensagem de erro quando a política é violada. Este campo tem um comprimento máximo de 2000 carateres.

      Para mais informações sobre como criar uma restrição personalizada, consulte o artigo Criar e gerir políticas de organização personalizadas.

      Configure uma restrição personalizada

      Depois de criar o ficheiro YAML para uma nova restrição personalizada, tem de o configurar para o disponibilizar para as políticas da organização na sua organização. Para configurar uma restrição personalizada, use o comando gcloud org-policies set-custom-constraint: 
      gcloud org-policies set-custom-constraint CONSTRAINT_PATH
       Substitua CONSTRAINT_PATH pelo caminho completo para o seu ficheiro de restrições personalizado. Por exemplo, /home/user/customconstraint.yaml. Após a conclusão, as restrições personalizadas ficam 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
       Substitua ORGANIZATION_ID pelo ID do recurso da sua organização. Para mais informações, consulte o artigo Ver políticas da organização.

      Aplique uma política da organização personalizada

      Pode aplicar uma restrição criando uma política da organização que a referencie e, em seguida, aplicando essa política da organização a um Google Cloud recurso.

      Consola

      1. Na Google Cloud consola, aceda à página Políticas da organização.

        Aceda às políticas da organização

      2. No seletor de projetos, selecione o projeto para o qual quer definir a política de organização.
      3. Na lista da página Políticas da organização, selecione a restrição para ver a página Detalhes da política dessa restrição.
      4. Para configurar a política da organização para este recurso, clique em Gerir política.
      5. Na página Editar política, selecione Substituir política do elemento principal.
      6. Clique em Adicionar regra.
      7. Na secção Aplicação, selecione se a aplicação desta política organizacional está ativada ou desativada.
      8. Opcional: para tornar a política de organização condicional a uma etiqueta, clique em Adicionar condição. Tenha em atenção que, se adicionar uma regra condicional a uma política da organização, tem de adicionar, pelo menos, uma regra incondicional. Caso contrário, não é possível guardar a política. Para mais informações, consulte o artigo Definir uma política de organização com etiquetas.
      9. Clique em Testar alterações para simular o efeito da política da organização. A simulação de políticas não está disponível para restrições geridas antigas. Para mais informações, consulte o artigo Teste as alterações da política da organização com o simulador de políticas.
      10. Para concluir e aplicar a política da organização, clique em Definir política. A política demora até 15 minutos a entrar em vigor.

      gcloud

      Para criar uma política da organização com regras booleanas, crie um ficheiro YAML de política que faça referência à restrição: 

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

      Substitua o seguinte:

      • PROJECT_ID: o projeto no qual quer aplicar a restrição.
      • CONSTRAINT_NAME: o nome que definiu 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 para o ficheiro YAML da política da organização. A política demora até 15 minutos a entrar em vigor.

      Teste uma restrição personalizada

      Para testar uma restrição personalizada, execute um comando gcloud que tente concluir uma tarefa bloqueada pela sua restrição.

      Por exemplo, suponha que uma restrição requer que os nomes dos acionadores do GitHub contenham "cloudbuild". Pode testar esta restrição executando o comando gcloud builds triggers create github com outro nome de acionador, conforme demonstrado no seguinte fragmento:

      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 é semelhante ao seguinte:

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

      Recursos e operações suportados do Cloud Build

      Os seguintes campos de restrições personalizadas do Cloud Build estão disponíveis para utilização quando cria ou atualiza recursos do Cloud Build.

      Tenha em atenção que a restrição nas compilações não é aplicada às compilações acionadas por um acionador.

      • Configuração de compilaçã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 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 ligação do Cloud Build
        • resource.name
        • resource.githubConfig.authorizerCredential.oauthTokenSecretVersionName
        • resource.githubConfig.appInstallationId
        • resource.githubEnterpriseConfig.hostUri
        • 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 da organização personalizadas para exemplos de utilização comuns

      A tabela seguinte apresenta a sintaxe de algumas políticas de organização personalizadas que pode considerar úteis:

      Descrição Sintaxe de restrição
      Permitir apenas a criação de acionadores do Pub/Sub que ouvem 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 sua organização, como 123456789.

      O que se segue?