Usar políticas personalizadas da organização

Nesta página, mostramos como usar restrições personalizadas do serviço de políticas da organização para restringir operações específicas nos seguintes recursos do Google Cloud :

  • clouddeploy.googleapis.com/Automation
  • clouddeploy.googleapis.com/CustomTargetType
  • clouddeploy.googleapis.com/DeliveryPipeline
  • clouddeploy.googleapis.com/DeployPolicy
  • clouddeploy.googleapis.com/Release
  • clouddeploy.googleapis.com/Rollout
  • clouddeploy.googleapis.com/Target

Para saber mais sobre políticas da organização, consulte Políticas personalizadas da organização.

Sobre políticas da organização e restrições

O serviço de políticas da organização do Google Cloud oferece controle centralizado e programático sobre os recursos da sua organização. Um administrador de políticas da organização pode definir políticas da organização, ou seja, conjuntos de restrições que se aplicam aos recursos doGoogle Cloud e aos elementos que descendem dele na hierarquia de recursos doGoogle Cloud . É possível aplicar políticas da organização no nível da organização, de pastas ou de projetos.

Uma política da organização oferece restrições gerenciadas e integradas para vários serviços do Google Cloud . No entanto, para ter controle mais granular e personalizável sobre os campos específicos restritos nas políticas da organização, também é possível criar restrições personalizadas e usá-las nessas políticas.

Herança de políticas

As políticas da organização são herdadas por padrão pelos elementos que descendem dos recursos em que elas são aplicadas. Por exemplo, se você aplicar uma política a uma pasta, o Google Cloud vai aplicá-la todos os projetos dessa pasta. Para saber mais sobre esse comportamento e como alterá-lo, consulte Regras de avaliação de hierarquia.

Antes de começar

  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. Install the Google Cloud CLI.

  5. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

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

    gcloud init

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

    Go to project selector

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

  9. Install the Google Cloud CLI.

  10. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

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

    gcloud init
  12. Verifique qual é o ID da organização.

    13. Papéis necessários

    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 usando papéis personalizados ou outros papéis predefinidos.

    Criar uma restrição personalizada

    Uma restrição personalizada é definida em um arquivo YAML pelos recursos, métodos, condições e ações compatíveis com o serviço em que você está aplicando a política da organização. As condições das restrições personalizadas são definidas usando a Common Expression Language (CEL). Para saber como criar condições em restrições personalizadas usando a CEL, consulte a seção CEL em Como criar e gerenciar restrições personalizadas.

    Para criar uma restrição personalizada, crie um arquivo YAML com o seguinte formato:

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

    Substitua:

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

    • CONSTRAINT_NAME: o nome da nova restrição personalizada. Uma restrição personalizada precisa começar com custom. e só pode incluir letras maiúsculas, minúsculas ou números. Por exemplo, custom.enableGkeTargets. Esse campo pode ter no máximo 70 caracteres.

    • RESOURCE_NAME: o nome totalmente qualificado do recurso doGoogle Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, clouddeploy.googleapis.com/clouddeploy.googleapis.com/Target.

    • CONDITION: uma condição de CEL gravada em uma representação de um recurso de serviço compatível. Esse campo pode ter no máximo 1000 caracteres. Consulte Recursos compatíveis para mais informações sobre os recursos disponíveis para gravação de condições. Por exemplo, "has(resource.gke)".

    • ACTION: a ação a ser realizada ao atender a condition. Os valores possíveis são ALLOW e DENY.

    • DISPLAY_NAME: um nome legível para a restrição. Esse campo pode ter no máximo 200 caracteres.

    • DESCRIPTION: uma descrição legível da restrição a ser exibida como mensagem de erro quando a política é violada. Esse campo pode ter no máximo 2000 caracteres.

    Para saber como criar uma restrição personalizada, consulte Como definir restrições personalizadas.

    Configurar uma restrição personalizada

    Depois de criar o arquivo YAML para uma nova restrição personalizada, faça a configuração necessária para disponibilizá-la para as políticas da 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 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 lista de políticas da organização do Google Cloud . Para verificar a existência da restrição personalizada, 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 organização. Para mais informações, consulte Como visualizar políticas da organização.

    Aplicar uma política personalizada da organização

    Para aplicar uma restrição, crie uma política da organização que faça referência a ela e aplique essa política a um recurso do Google Cloud .

    Console

    1. No console do Google Cloud , acesse a página Políticas da organização.

      Acessar a página Políticas da organização

    2. No seletor de projetos, selecione o projeto em que você quer definir a política da organização.
    3. Na lista da página Políticas da organização, selecione uma restrição para acessar a página Detalhes da política associada.
    4. Para configurar a política da organização nesse recurso, clique em Gerenciar política.
    5. Na página Editar política, selecione Substituir a política do recurso pai.
    6. Clique em Adicionar regra.
    7. Na seção Aplicação, escolha entre ativar ou desativar a aplicação dessa política da organização.
    8. 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 para que a política seja salva. Para mais informações, consulte Como configurar uma política da organização com tags.
    9. Clique em Testar mudanças para simular o efeito da política da organização. A simulação da política não está disponível para restrições gerenciadas legadas. Para mais informações, consulte Testar mudanças na política da organização com o Simulador de política.
    10. 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 com regras booleanas, crie um arquivo YAML para a política que faça 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.enableGkeTargets.

    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 arquivo YAML da política da organização. A política leva até 15 minutos para entrar em vigor.

    Testar a política personalizada da organização

    O exemplo a seguir cria uma restrição e política personalizada que permite a criação e atualização de destinos do GKE.

    Antes de começar, você precisa saber o seguinte:

    • O ID da sua organização.
    • Um ID de projeto

    Criar a restrição

    1. Salve o seguinte arquivo como constraint-enable-gke-targets.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.enableGkeTargets
resourceTypes:
- clouddeploy.googleapis.com/Target
methodTypes:
- CREATE
- UPDATE
condition: "has(resource.gke)"
actionType: ALLOW
displayName: Enable the creation and update of GKE targets
description: All new targets must be GKE clusters.

      Isso define uma restrição em que, para cada novo destino criado, se o tipo de destino não for um cluster do GKE, a operação será negada.

    2. Aplique a restrição:

      gcloud org-policies set-custom-constraint ~/constraint-enable-gke-targets.yaml

    3. Verifique se a restrição existe:

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

      O resultado será o seguinte:

      CUSTOM_CONSTRAINT                       ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                     DISPLAY_NAME
custom.enableGkeTargets                 ALLOW        CREATE,UPDATE  clouddeploy.googleapis.com/Target  Enable the creation of GKE targets
...

    Criar a política

    1. Salve o seguinte arquivo como policy-enable-gke-targets.yaml:

      name: projects/PROJECT_ID/policies/custom.enableGkeTargets
spec:
  rules:
  - enforce: true

      Substitua PROJECT_ID pelo ID do seu projeto.

    2. Aplique a política:

      gcloud org-policies set-policy ~/policy-enable-gke-targets.yaml

    3. Verifique se a política existe:

      gcloud org-policies list --project=PROJECT_ID

      O resultado será assim:

      CONSTRAINT                  LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.enableGkeTargets     -              SET               COCsm5QGENiXi2E=

    Depois de aplicar a política, aguarde cerca de dois minutos para que Google Cloud comece a aplicá-la.

    Testar a política

    Tente criar um destino do Cloud Run no projeto:

    • Crie um arquivo YAML do Cloud Deploy chamado clouddeploy.yaml, definindo um destino do Cloud Run:
    apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: run-target
run:
  location: projects/PROJECT_ID/locations/REGION

    gcloud deploy apply --file=clouddeploy.yaml \
    --project=PROJECT_ID \
    --region=REGION

    A saída é esta:

    Operation denied by custom org policies: ["customConstraints/custom.enableGkeTargets": "All new targets must be GKE clusters."]

    Exemplos de políticas personalizadas da organização para casos de uso comuns

    Esta tabela fornece exemplos de sintaxe para algumas restrições personalizadas comuns.

    Os exemplos a seguir usam as macros all e exists do CEL. Para mais informações sobre essas macros, consulte Macros.

    Descrição Sintaxe da restrição
    Não permitir pipelines de entrega de estágio único 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.denySingleStagePipelines
    resourceTypes:
    - clouddeploy.googleapis.com/DeliveryPipeline
    methodTypes:
    - CREATE
    condition: "len(resource.serialPipeline.stages) == 1"
    actionType: DENY
    displayName: Deny single-stage delivery pipelines.
    description: All pipelines must have more than one stage.
    Permitir que metas que exigem aprovação sejam criadas ou atualizadas 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.enableTargetRequireApproval
    resourceTypes:
    - clouddeploy.googleapis.com/Target
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.requireApproval"
    actionType: ALLOW
    displayName: Enable require approval on all targets
    description: All targets must require approval.
    Negar a criação de automações com qualquer regra de promoção 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.denyPromoteReleaseAutomationRules
    resourceTypes:
    - clouddeploy.googleapis.com/Automation
    methodTypes:
    - CREATE
    condition: "resource.rules.exists(r, has(r.promoteReleaseRule) || has(r.timedPromoteReleaseRule))"
    actionType: DENY
    displayName: Deny promote release or timed promote release automation rules.
    description: All automation rules must be of type advance rollout or repair rollout.

    Recursos compatíveis com o Cloud Deploy

    A tabela a seguir lista os recursos do Cloud Deploy que podem ser referenciados em restrições personalizadas.

    Recurso Campo
    clouddeploy.googleapis.com/Automation resource.annotations
    resource.description
    resource.rules.advanceRolloutRule.id
    resource.rules.advanceRolloutRule.sourcePhases
    resource.rules.advanceRolloutRule.wait
    resource.rules.promoteReleaseRule.destinationPhase
    resource.rules.promoteReleaseRule.destinationTargetId
    resource.rules.promoteReleaseRule.id
    resource.rules.promoteReleaseRule.wait
    resource.rules.repairRolloutRule.id
    resource.rules.repairRolloutRule.jobs
    resource.rules.repairRolloutRule.phases
    resource.rules.repairRolloutRule.repairPhases.retry.attempts
    resource.rules.repairRolloutRule.repairPhases.retry.backoffMode
    resource.rules.repairRolloutRule.repairPhases.retry.wait
    resource.rules.repairRolloutRule.repairPhases.rollback.destinationPhase
    resource.rules.repairRolloutRule.repairPhases.rollback.disableRollbackIfRolloutPending
    resource.rules.timedPromoteReleaseRule.destinationPhase
    resource.rules.timedPromoteReleaseRule.destinationTargetId
    resource.rules.timedPromoteReleaseRule.id
    resource.rules.timedPromoteReleaseRule.schedule
    resource.rules.timedPromoteReleaseRule.timeZone
    resource.selector.targets.id
    resource.serviceAccount
    resource.suspended
    clouddeploy.googleapis.com/CustomTargetType resource.annotations
    resource.customActions.deployAction
    resource.customActions.includeSkaffoldModules.configs
    resource.customActions.includeSkaffoldModules.git.path
    resource.customActions.includeSkaffoldModules.git.ref
    resource.customActions.includeSkaffoldModules.git.repo
    resource.customActions.includeSkaffoldModules.googleCloudBuildRepo.path
    resource.customActions.includeSkaffoldModules.googleCloudBuildRepo.ref
    resource.customActions.includeSkaffoldModules.googleCloudBuildRepo.repository
    resource.customActions.includeSkaffoldModules.googleCloudStorage.path
    resource.customActions.includeSkaffoldModules.googleCloudStorage.source
    resource.customActions.renderAction
    resource.description
    resource.name
    clouddeploy.googleapis.com/DeliveryPipeline resource.annotations
    resource.description
    resource.name
    resource.serialPipeline.stages.deployParameters.matchTargetLabels
    resource.serialPipeline.stages.deployParameters.values
    resource.serialPipeline.stages.profiles
    resource.serialPipeline.stages.strategy.canary.canaryDeployment.percentages
    resource.serialPipeline.stages.strategy.canary.canaryDeployment.postdeploy.actions
    resource.serialPipeline.stages.strategy.canary.canaryDeployment.predeploy.actions
    resource.serialPipeline.stages.strategy.canary.canaryDeployment.verify
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.percentage
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.phaseId
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.postdeploy.actions
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.predeploy.actions
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.profiles
    resource.serialPipeline.stages.strategy.canary.customCanaryDeployment.phaseConfigs.verify
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.cloudRun.automaticTrafficControl
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.cloudRun.canaryRevisionTags
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.cloudRun.priorRevisionTags
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.cloudRun.stableRevisionTags
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.deployment
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.httpRoute
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.podSelectorLabel
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.routeDestinations.destinationIds
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.routeDestinations.propagateService
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.routeUpdateWaitTime
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.service
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.gatewayServiceMesh.stableCutbackDuration
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.serviceNetworking.deployment
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.serviceNetworking.disablePodOverprovisioning
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.serviceNetworking.podSelectorLabel
    resource.serialPipeline.stages.strategy.canary.runtimeConfig.kubernetes.serviceNetworking.service
    resource.serialPipeline.stages.strategy.standard.postdeploy.actions
    resource.serialPipeline.stages.strategy.standard.predeploy.actions
    resource.serialPipeline.stages.strategy.standard.verify
    resource.serialPipeline.stages.targetId
    resource.suspended
    clouddeploy.googleapis.com/DeployPolicy resource.annotations
    resource.description
    resource.rules.rolloutRestriction.actions
    resource.rules.rolloutRestriction.id
    resource.rules.rolloutRestriction.invokers
    resource.rules.rolloutRestriction.timeWindows.oneTimeWindows.endDate
    resource.rules.rolloutRestriction.timeWindows.oneTimeWindows.endTime
    resource.rules.rolloutRestriction.timeWindows.oneTimeWindows.startDate
    resource.rules.rolloutRestriction.timeWindows.oneTimeWindows.startTime
    resource.rules.rolloutRestriction.timeWindows.timeZone
    resource.rules.rolloutRestriction.timeWindows.weeklyWindows.daysOfWeek
    resource.rules.rolloutRestriction.timeWindows.weeklyWindows.endTime
    resource.rules.rolloutRestriction.timeWindows.weeklyWindows.startTime
    resource.selectors.deliveryPipeline.id
    resource.selectors.target.id
    resource.suspended
    clouddeploy.googleapis.com/Release resource.annotations
    resource.buildArtifacts.image
    resource.buildArtifacts.tag
    resource.deployParameters
    resource.description
    resource.name
    resource.skaffoldConfigPath
    resource.skaffoldConfigUri
    resource.skaffoldVersion
    clouddeploy.googleapis.com/Rollout resource.annotations
    resource.description
    resource.name
    resource.targetId
    clouddeploy.googleapis.com/Target resource.annotations
    resource.anthosCluster.membership
    resource.associatedEntities[*].anthosClusters.membership
    resource.associatedEntities[*].gkeClusters.cluster
    resource.associatedEntities[*].gkeClusters.dnsEndpoint
    resource.associatedEntities[*].gkeClusters.internalIp
    resource.associatedEntities[*].gkeClusters.proxyUrl
    resource.customTarget.customTargetType
    resource.deployParameters
    resource.description
    resource.executionConfigs.artifactStorage
    resource.executionConfigs.defaultPool.artifactStorage
    resource.executionConfigs.defaultPool.serviceAccount
    resource.executionConfigs.executionTimeout
    resource.executionConfigs.privatePool.artifactStorage
    resource.executionConfigs.privatePool.serviceAccount
    resource.executionConfigs.privatePool.workerPool
    resource.executionConfigs.serviceAccount
    resource.executionConfigs.usages
    resource.executionConfigs.verbose
    resource.executionConfigs.workerPool
    resource.gke.cluster
    resource.gke.dnsEndpoint
    resource.gke.internalIp
    resource.gke.proxyUrl
    resource.multiTarget.targetIds
    resource.name
    resource.requireApproval
    resource.run.location

    A seguir