Crie restrições de políticas da organização 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:

  • dataform.googleapis.com/Repository

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.

Vantagens

Pode usar políticas da organização personalizadas para permitir ou recusar valores específicos para recursos do Dataform. Por exemplo, se um pedido para criar ou atualizar um recursodataform.googleapis.com/Repository não passar na validação da restrição personalizada, conforme definido pela sua política organizacional, o pedido falha e é devolvido um erro ao autor da chamada.

A utilização de políticas organizacionais personalizadas adiciona uma camada adicional de segurança, conformidade e governação. Por exemplo, pode definir políticas que permitam a criação de recursos apenas numa região específica ou que proíbam a utilização de repositórios Git remotos fora da sua organização.

Limitações

Tal como todas as restrições de políticas da organização, as alterações às políticas não se aplicam retroativamente aos recursos existentes:

  • Uma nova política não afeta os recursos existentes.
  • Se alterar a política, um recurso existente permanece válido, a menos que altere o recurso de um valor em conformidade para um valor não em conformidade através da Google Cloud consola ou de um RPC.

Recomendamos que torne todos os recursos existentes compatíveis com uma política antes de aplicar uma nova política. Para verificar que recursos existentes não vão estar em conformidade depois de aplicar uma política, use o simulador de políticas para a política de organização.

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.restrictRepositoryLocation. 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, dataform.googleapis.com/Repository.

    • 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.contains('/locations/us-central1/')".

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

    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 e uma política personalizadas que exigem que todos os recursos dataform.googleapis.com/Repository sejam criados numa região específica.

    Antes de começar, tem de ter o seguinte:

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

    Crie a restrição

    Para criar uma restrição personalizada, siga estes passos:

    1. Guarde o seguinte ficheiro como constraint-restrict-repository-location.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictRepositoryLocation
resourceTypes:
- dataform.googleapis.com/Repository
methodTypes:
- CREATE
- UPDATE
condition: "resource.name.contains('/locations/us-central1/')"
actionType: ALLOW
displayName: Only us-central1 region is allowed.
description: All resources must be created in the us-central1 region.

      Substitua ORGANIZATION_ID pelo ID da sua organização.

      Este ficheiro define uma restrição em que, para cada operação de criação ou atualização no recurso dataform.googleapis.com/Repository, a operação só é permitida se a região selecionada para o recurso for us-central1.

    2. Aplique a restrição:

      gcloud org-policies set-custom-constraint ~/constraint-restrict-repository-location.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.restrictRepositoryLocation       ALLOW        CREATE,UPDATE  dataform.googleapis.com/Repository Only us-central1 region is allowed.
...

    Crie a política

    Agora, crie uma política e aplique-a à restrição personalizada que criou.

    1. Guarde o seguinte ficheiro como policy-restrict-repository-location.yaml:

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

      Substitua PROJECT_ID pelo ID do seu projeto.

    2. Aplique a política:

      gcloud org-policies set-policy ~/policy-restrict-repository-location.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.restrictRepositoryLocation    -              SET               ETAG

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

    Teste a política

    Siga os passos em Crie um repositório para criar um recurso dataform.googleapis.com/Repository no seu projeto. Escolha uma região que seja diferente da região especificada na restrição personalizada.

    O resultado é o seguinte:

    Operation denied by custom org policies: ["customConstraints/custom.restrictRepositoryLocation": "All resources must be created in the us-central1 region."]

    Exemplos de políticas da organização personalizadas para exemplos de utilização comuns

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

    Descrição Sintaxe de restrição
    Todos os recursos têm de ser criados na região us-central1. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictRepositoryLocation
    resourceTypes:
    - dataform.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.name.contains('/locations/us-central1/')"
    actionType: ALLOW
    displayName: Only us-central1 region is allowed.
    description: All resources must be created in the us-central1 region.
    Permitir apenas a configuração de um Git remoto para estabelecer ligação através de HTTPS a repositórios na organização Google no GitHub. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictGitRemote
    resourceTypes:
    - dataform.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: |-
      resource.gitRemoteSettings.url == ""
      || resource.gitRemoteSettings.url.startsWith('https://github.com/google/')
    actionType: ALLOW
    displayName:  Only allow the https://github.com/google/ Git remote.
    description: Only allow configuration of a Git remote to connect using HTTPS to repositories in the Google organization on GitHub.

    Recursos suportados do Dataform

    A tabela seguinte apresenta os recursos do Dataform aos quais pode fazer referência em restrições personalizadas.

    Recurso Campo
    dataform.googleapis.com/Repository resource.displayName
    resource.gitRemoteSettings.authenticationTokenSecretVersion
    resource.gitRemoteSettings.defaultBranch
    resource.gitRemoteSettings.sshAuthenticationConfig.hostPublicKey
    resource.gitRemoteSettings.sshAuthenticationConfig.userPrivateKeySecretVersion
    resource.gitRemoteSettings.url
    resource.kmsKeyName
    resource.name
    resource.npmrcEnvironmentVariablesSecretVersion
    resource.serviceAccount
    resource.setAuthenticatedUserAdmin
    resource.workspaceCompilationOverrides.defaultDatabase
    resource.workspaceCompilationOverrides.schemaSuffix
    resource.workspaceCompilationOverrides.tablePrefix

    O que se segue?