Faça a gestão de recursos de gestão de serviços com restrições personalizadas

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

  • servicemanagement.googleapis.com/Service

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

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

O Google Cloud 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 restrições que se aplicam aGoogle Cloud recursos e 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.

A política da organização oferece restrições geridas incorporadas para vários serviços Google Cloud . 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 restrições personalizadas e usar essas restrições personalizadas numa política da organização.

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, Google Cloud 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.

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.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

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

  4. Install the Google Cloud CLI.

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

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

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

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

  9. Install the Google Cloud CLI.

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

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

    gcloud init
  12. Certifique-se de que sabe o seu ID da organização.
  13. Funções necessárias

    Para receber as autorizações de que precisa para gerir políticas da organização personalizadas, peça ao seu administrador que lhe conceda 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.

    Crie uma restrição personalizada

    Uma restrição personalizada é definida num ficheiro YAML pelos recursos, métodos, condições e ações suportados pelo serviço no qual está a aplicar a política da organização. As condições para as restrições personalizadas são definidas através do 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.

    Para criar uma restrição personalizada, crie um ficheiro 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 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.authorizationCheck. O comprimento máximo deste campo é de 70 carateres.

    • RESOURCE_NAME: o nome totalmente qualificado do recurso que contém o objeto e o campo que quer restringir.Google Cloud Por exemplo, servicemanagement.googleapis.com/Service.

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

    • ACTION: a ação a tomar se a condição condition for cumprida. Os valores possíveis são ALLOW e 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 Definir restrições 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 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 de 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 à 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.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 ficheiro YAML da política da sua organização. A política demora até 15 minutos a entrar em vigor.

    Teste a política da organização personalizada

    O exemplo seguinte cria uma restrição personalizada com base nos atributos do recurso Service. Estas regras podem ser usadas para permitir ou recusar determinados pedidos de CreateServiceConfig

    Antes de começar, deve saber o seguinte:

    • O ID da sua organização
    • Um ID do projeto

    Crie a restrição

    1. Guarde o seguinte ficheiro 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.
      

      Isto define uma restrição em que o nome do serviço para cada Service Management deve 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 é semelhante ao seguinte:

      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. Guarde o seguinte ficheiro como policy-file-name.yaml:

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

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

      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.

    Teste a política

    Execute o seguinte comando para criar a configuração do serviço para verificar as restrições.

      gcloud endpoints services deploy policy-file-name.yaml
    

    O resultado é semelhante ao seguinte:

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

    Recursos suportados pela gestão de serviços

    A tabela seguinte apresenta os recursos de gestão de serviços que pode referenciar 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

    O que se segue?