Gerenciar recursos do Service Management com restrições personalizadas

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 :

  • servicemanagement.googleapis.com/Service

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.authorizationCheck. 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, servicemanagement.googleapis.com/Service.

    • 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, resource.name == \"test-service-name\".

    • 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.authorizationCheck.

    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 personalizada com base nos atributos do recurso Service. Essas regras podem ser usadas para permitir ou negar determinadas solicitações de CreateServiceConfig.

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

    • O código da sua organização.
    • Um ID do projeto

    Crie a restrição.

    1. Salve o seguinte arquivo como constraint-file-name.yaml:

          name: organizations/ORGANIZATION_ID/customConstraints/custom.authorizationCheck
          resourceTypes:
          -  servicemanagement.googleapis.com/Service
          methodTypes:
          -   CREATE
          -   UPDATE
          condition: resource.name == \"test-service-name\"
          actionType: ALLOW
          displayName: Check Configuration time policy enforcement
          description: Organization policies, defined with CEL and enforced via service manager APIs, allow admins to control service configurations through inheritable and granular rules.
      

      Isso define uma restrição em que o nome do serviço para cada Service Management precisa ser igual a test-service-name.

    2. Aplique a restrição:

      gcloud org-policies set-custom-constraint ~/constraint-file-name.yaml
      
    3. Verifique se a restrição existe:

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

      O resultado será assim:

      CUSTOM_CONSTRAINT ACTION_TYPE METHOD_TYPES RESOURCE_TYPES DISPLAY_NAME
      custom.configTimeEnforcement ALLOW CREATE,UPDATE servicemanagement.googleapis.com/Service Configuration time policy enforcement
      

    Crie a política

    1. Salve o seguinte arquivo como policy-file-name.yaml:

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

      Substitua PROJECT_ID pela ID do seu projeto.

    2. Aplique a política:

      gcloud org-policies set-policy ~/policy-file-name.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.configTimeEnforcement - 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

    Execute o comando a seguir para criar a configuração de serviço e verificar as restrições.

      gcloud endpoints services deploy policy-file-name.yaml
    

    O resultado será assim:

      Operation denied by custom org policies: ["customConstraints/custom.authorizationCheck": "error Message"]
    

    Recursos compatíveis com o Service Management

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

    Recurso Campo
    servicemanagement.googleapis.com/Service resource.authentication.providers.audiences
    resource.authentication.providers.authorizationUrl
    resource.authentication.providers.issuer
    resource.authentication.providers.jwksUri
    resource.authentication.providers.jwtLocations.cookie
    resource.authentication.providers.jwtLocations.header
    resource.authentication.providers.jwtLocations.query
    resource.authentication.providers.jwtLocations.valuePrefix
    resource.authentication.rules.allowWithoutCredential
    resource.authentication.rules.oauth.canonicalScopes
    resource.authentication.rules.requirements.audiences
    resource.authentication.rules.requirements.providerId
    resource.authentication.rules.selector
    resource.backend.rules.address
    resource.backend.rules.deadline
    resource.backend.rules.disableAuth
    resource.backend.rules.jwtAudience
    resource.backend.rules.operationDeadline
    resource.backend.rules.pathTranslation
    resource.backend.rules.protocol
    resource.backend.rules.selector
    resource.billing.consumerDestinations.metrics
    resource.billing.consumerDestinations.monitoredResource
    resource.context.rules.allowedRequestExtensions
    resource.context.rules.allowedResponseExtensions
    resource.context.rules.provided
    resource.context.rules.requested
    resource.context.rules.selector
    resource.control.environment
    resource.control.methodPolicies.requestPolicies.resourcePermission
    resource.control.methodPolicies.requestPolicies.resourceType
    resource.control.methodPolicies.requestPolicies.selector
    resource.control.methodPolicies.selector
    resource.customError.rules.isErrorType
    resource.customError.rules.selector
    resource.customError.types
    resource.endpoints.aliases
    resource.endpoints.allowCors
    resource.endpoints.name
    resource.endpoints.target
    resource.logging.consumerDestinations.logs
    resource.logging.consumerDestinations.monitoredResource
    resource.logging.producerDestinations.logs
    resource.logging.producerDestinations.monitoredResource
    resource.logs.description
    resource.logs.displayName
    resource.logs.name
    resource.metrics.description
    resource.metrics.displayName
    resource.metrics.launchStage
    resource.metrics.metadata.ingestDelay
    resource.metrics.metadata.samplePeriod
    resource.metrics.metadata.timeSeriesResourceHierarchyLevel
    resource.metrics.metricKind
    resource.metrics.monitoredResourceTypes
    resource.metrics.name
    resource.metrics.type
    resource.metrics.unit
    resource.metrics.valueType
    resource.monitoredResources.description
    resource.monitoredResources.displayName
    resource.monitoredResources.launchStage
    resource.monitoredResources.name
    resource.monitoredResources.type
    resource.monitoring.consumerDestinations.metrics
    resource.monitoring.consumerDestinations.monitoredResource
    resource.monitoring.producerDestinations.metrics
    resource.monitoring.producerDestinations.monitoredResource
    resource.name
    resource.producerProjectId
    resource.publishing.apiShortName
    resource.publishing.codeownerGithubTeams
    resource.publishing.docTagPrefix
    resource.publishing.documentationUri
    resource.publishing.githubLabel
    resource.publishing.librarySettings.cppSettings.common.destinations
    resource.publishing.librarySettings.cppSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.dotnetSettings.common.destinations
    resource.publishing.librarySettings.dotnetSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.dotnetSettings.forcedNamespaceAliases
    resource.publishing.librarySettings.dotnetSettings.handwrittenSignatures
    resource.publishing.librarySettings.dotnetSettings.ignoredResources
    resource.publishing.librarySettings.dotnetSettings.renamedResources
    resource.publishing.librarySettings.dotnetSettings.renamedServices
    resource.publishing.librarySettings.goSettings.common.destinations
    resource.publishing.librarySettings.goSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.javaSettings.common.destinations
    resource.publishing.librarySettings.javaSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.javaSettings.libraryPackage
    resource.publishing.librarySettings.javaSettings.serviceClassNames
    resource.publishing.librarySettings.launchStage
    resource.publishing.librarySettings.nodeSettings.common.destinations
    resource.publishing.librarySettings.nodeSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.phpSettings.common.destinations
    resource.publishing.librarySettings.phpSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.pythonSettings.common.destinations
    resource.publishing.librarySettings.pythonSettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.pythonSettings.experimentalFeatures.restAsyncIoEnabled
    resource.publishing.librarySettings.restNumericEnums
    resource.publishing.librarySettings.rubySettings.common.destinations
    resource.publishing.librarySettings.rubySettings.common.selectiveGapicGeneration.methods
    resource.publishing.librarySettings.version
    resource.publishing.methodSettings.autoPopulatedFields
    resource.publishing.methodSettings.longRunning.initialPollDelay
    resource.publishing.methodSettings.longRunning.maxPollDelay
    resource.publishing.methodSettings.longRunning.pollDelayMultiplier
    resource.publishing.methodSettings.longRunning.totalPollTimeout
    resource.publishing.methodSettings.selector
    resource.publishing.newIssueUri
    resource.publishing.organization
    resource.publishing.protoReferenceDocumentationUri
    resource.publishing.restReferenceDocumentationUri
    resource.quota.limits.defaultLimit
    resource.quota.limits.description
    resource.quota.limits.displayName
    resource.quota.limits.duration
    resource.quota.limits.freeTier
    resource.quota.limits.maxLimit
    resource.quota.limits.metric
    resource.quota.limits.name
    resource.quota.limits.unit
    resource.quota.limits.values
    resource.quota.metricRules.metricCosts
    resource.quota.metricRules.selector
    resource.systemParameters.rules.parameters.httpHeader
    resource.systemParameters.rules.parameters.name
    resource.systemParameters.rules.parameters.urlQueryParameter
    resource.systemParameters.rules.selector
    resource.title
    resource.usage.producerNotificationChannel
    resource.usage.requirements
    resource.usage.rules.allowUnregisteredCalls
    resource.usage.rules.selector
    resource.usage.rules.skipServiceControl

    A seguir