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 Google Cloud :

  • servicemanagement.googleapis.com/Service

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

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

O Google Cloud Serviço de políticas da organização 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 restrições chamado restrições que se aplicam aos recursosGoogle Cloud 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.

A política da organização fornece restrições predefinidas para vários serviços Google Cloud . 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 restrições personalizadas e use-as em uma política da organização.

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, Google Cloud vai aplicar a política a 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. Make sure that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

  5. To initialize the gcloud CLI, run the following command: 

    gcloud init

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

    Go to project selector

  7. Make sure that billing is enabled for your Google Cloud project.

  8. Install the Google Cloud CLI.

  9. To initialize the gcloud CLI, run the following command: 

    gcloud init
  10. Certifique-se de conhecer o ID da organização.

Funções exigidas

Para receber as permissões necessárias a fim de gerenciar políticas personalizadas 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.

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

Para criar uma restrição personalizada, crie um arquivo YAML usando 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 sua 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. O comprimento máximo desse campo é de 70 caracteres.

  • RESOURCE_NAME: o nome totalmente qualificado do recursoGoogle 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 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.name == \"test-service-name\".

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

  • 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 definir restrições personalizadas.

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 comando gcloud org-policies set-custom-constraint: 
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
 Substitua 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
 Substitua 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

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

    Acessar as 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 a restrição para acessar a página Detalhes da política dela.
  4. Para personalizar 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 editor principal.
  6. Clique em Adicionar uma regra.
  7. Na seção Aplicação, selecione se a aplicação dessa política da organização está ativada ou desativada.
  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. 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.
  9. 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.
  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 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.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 do 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 de serviço. Essas regras podem ser usadas para permitir ou negar determinadas solicitações 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 o Google Cloud começe a aplicar a política.

Testar a política

Execute o comando a seguir para criar a configuração do 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 com suporte à gestão de serviços

A tabela a seguir lista os recursos de gerenciamento de serviços 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