Criar restrições personalizadas para o Filestore

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:

  • file.googleapis.com/Instance
  • file.googleapis.com/Backup
  • file.googleapis.com/Snapshot

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 de 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 Google Cloud serviços. 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.

    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, primeiro, tem 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.

    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, primeiro, tem 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 para lhe conceder 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 por custom. e só pode incluir letras maiúsculas, letras minúsculas ou números. Por exemplo, custom.deletionProtectionEnabledEnforcedOnCreate. 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, file.googleapis.com/Instance.

    • 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.deletionProtectionEnabled == true".

    • 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 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 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 da 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 da 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.deletionProtectionEnabledEnforcedOnCreate.

    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 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 permitem aos utilizadores criar uma instância do Filestore se o campo deletionProtection estiver definido como true.

    Antes de começar, prepare o seguinte:

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

    Crie a restrição

    1. Guarde o seguinte ficheiro como constraint-instance.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.deletionProtectionEnabledEnforcedOnCreate
resourceTypes:
- file.googleapis.com/Instance
methodTypes:
- CREATE
condition: "resource.deletionProtectionEnabled == true"
actionType: ALLOW
displayName: Enforce deletion protection
description: Enforce instance creation with deletion protection.

      Isto define uma restrição em que o campo deletionProtection tem de ser definido como true no método CREATE.

    2. Aplique a restrição:

      gcloud org-policies set-custom-constraint constraint-instance.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.deletionProtectionEnabledEnforcedOnCreate  ALLOW        CREATE         file.googleapis.com/Instance  Enforce deletion protection

...

    Crie a política

    1. Guarde o seguinte ficheiro como policy-instance.yaml:

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

      Substitua PROJECT_ID pelo ID do seu projeto.

    2. Aplique a política:

      gcloud org-policies set-policy policy-instance.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.deletionProtectionEnabledEnforcedOnCreate  -            SET             CJqb674GEMiAzGE=-

    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

    Experimente criar uma instância sem definir deletionProtection como true:

      gcloud filestore instances create test-ins --zone=us-central1 --tier=enterprise --network=name="default" --file-share="capacity=1024,name=test-fs"

    O resultado é semelhante ao seguinte:

    ERROR: (gcloud.filestore.instances.create) FAILED_PRECONDITION: Operation denied by custom org policy on resource 'projects/test-project/locations/us-central1/instances/test-ins': ["customConstraints/custom.deletionProtectionEnabledEnforcedOnCreate": "Enforce instance creation with deletion protection."].
- '@type': type.googleapis.com/google.rpc.DebugInfo
  detail: "generic::failed_precondition: Operation denied by custom org policy on\
    \ resource 'projects/test-project/locations/us-central1/instances/test-ins':\
    \ [\"customConstraints/custom.deletionProtectionEnabledEnforcedOnCreate\": \"\
    Enforce instance creation with deletion protection.\"]."
  .
  .
  .

- '@type': type.googleapis.com/google.rpc.DebugInfo
- '@type': type.googleapis.com/google.rpc.ErrorInfo
  domain: file.googleapis.com
  metadata:
    customConstraints: customConstraints/custom.deletionProtectionEnabledEnforcedOnCreate
    resource: projects/test-project/locations/us-central1/instances/test-ins
  reason: CUSTOM_ORG_POLICY_VIOLATION

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

    A tabela seguinte apresenta políticas de organização personalizadas que podem ser úteis:

    Descrição Sintaxe de restrição
    Quando define o controlo de acesso para uma lista restrita de IPs e funções, permite definir o IP do administrador para um IP único 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.filestoreAdminIP
    resourceTypes:
    - file.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.fileShares.size() > 0 && resource.fileShares[0].nfsExportOptions.size() > 0 && resource.fileShares[0].nfsExportOptions.exists(o, o.squashMode == 'NO_ROOT_SQUASH' && o.accessMode == 'READ_WRITE' && o.ipRanges.exists(i, i != '10.0.0.1'))"
    actionType: ALLOW
    displayName: Access control admin IP
    description: Access control restriction allows setting admin IP exclusively to 10.0.0.1.
    Desative a criação de instâncias com capacidade superior a 1024 GB 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.disableLargeCapacity
    resourceTypes:
    - file.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.fileShares.size() > 0 && resource.fileShares[0].capacityGb > 1024"
    actionType: DENY
    displayName: Disable large instance creation
    description: Instance capacity must be up to 1024 GB.
    Não permitir a criação de uma cópia de segurança se a instância de origem contiver a palavra test no respetivo nome 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.denyBackupFromTestInstance
    resourceTypes:
    - file.googleapis.com/Backup
    methodTypes:
    - CREATE
    condition: "resource.sourceInstance.contains('test')"
    actionType: DENY
    displayName: Deny backup of test instance
    description: Don't allow creating a backup if the source instance contains 'test' in its name.

    Recursos suportados do Filestore

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

    Recurso Campo
    file.googleapis.com/Backup resource.description
    resource.kmsKey
    resource.sourceFileShare
    resource.sourceInstance
    file.googleapis.com/Instance resource.deletionProtectionEnabled
    resource.deletionProtectionReason
    resource.description
    resource.fileShares.capacityGb
    resource.fileShares.name
    resource.fileShares.nfsExportOptions.accessMode
    resource.fileShares.nfsExportOptions.anonGid
    resource.fileShares.nfsExportOptions.anonUid
    resource.fileShares.nfsExportOptions.ipRanges
    resource.fileShares.nfsExportOptions.squashMode
    resource.fileShares.sourceBackup
    resource.kmsKeyName
    resource.networks.connectMode
    resource.networks.modes
    resource.networks.network
    resource.networks.reservedIpRange
    resource.performanceConfig.fixedIops.maxIops
    resource.performanceConfig.iopsPerTb.maxIopsPerTb
    resource.protocol
    resource.replication.replicas.peerInstance
    resource.replication.role
    resource.tier
    file.googleapis.com/Snapshot resource.description

    O que se segue?