Criar restrições personalizadas de política da organização

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

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 :

  • composer.googleapis.com/Environment

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 de projetos, de pastas ou da organização.

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

Por padrão, as políticas da organização são herdadas 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 a todos os projetos dessa pasta. Para saber mais sobre esse comportamento e como alterá-lo, consulte Regras de avaliação de hierarquia.

Vantagens

É possível usar políticas personalizadas da organização para permitir ou negar valores específicos em recursos do Cloud Composer. Por exemplo, quando uma solicitação de criação ou atualização de um ambiente do Cloud Composer não atende à validação de restrição personalizada definida pela política da organização, ela falha e um erro é retornado ao autor da chamada. Além disso, o uso de políticas personalizadas da organização:

  1. Melhora a segurança. Por exemplo, é possível definir políticas que proíbem a criação de ambientes de IPs públicos, ativam endereços IP públicos usados de maneira particular ou especificam o uso de uma rede e sub-rede específicas.

  2. Oferece controle granular sobre os recursos que estão sendo criados ou usados ao criar ou atualizar um ambiente.

Limitações

Como ocorre com todas as restrições de política da organização, as alterações de política não se aplicam retroativamente às instâncias atuais.

  • Uma nova política não afeta as configurações de instância atuais.
  • Uma configuração de instância atual permanece válida, a menos que você a mude de um valor aceito para um inválido usando o console doGoogle Cloud , a CLI do Google Cloud ou uma RPC.

Antes de aplicar políticas personalizadas da organização ao tipo de método UPDATE do recurso, verifique se os ambientes atuais estão em conformidade com cada política.

Como uma operação de atualização só pode atualizar um campo, um deadlock pode ocorrer se vários campos de um ambiente atual violarem as políticas ao mesmo tempo.

Para evitar o impasse, faça o seguinte:

  • (Recomendado) Deixe todos os ambientes atuais em conformidade com uma política antes de aplicá-la aos recursos. Para verificar quais dos ambientes atuais não estarão em conformidade após a aplicação da política, use o simulador de política.

  • Desative a aplicação da política, atualize os ambientes atuais para o estado em conformidade e aplique a política novamente.

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

    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. 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.restrictEnvironmentSize. 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, composer.googleapis.com/Environment.

  • 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.config.environmentSize == "ENVIRONMENT_SIZE_SMALL".

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

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 e política personalizada que permite apenas ambientes pequenos do Cloud Composer.

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

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

Criar a restrição

  1. Salve o seguinte arquivo como constraint-require-only-small-environments.yaml:

    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictEnvironmentSize resourceTypes: - composer.googleapis.com/Environment methodTypes: - CREATE condition: resource.config.environmentSize == "ENVIRONMENT_SIZE_SMALL" actionType: ALLOW displayName: Only allow small Composer environments. description: All environments must be small.

  2. Aplique a restrição:

    gcloud org-policies set-custom-constraint constraint-require-only-small-environments.yaml

Criar a política

  1. Salve o seguinte arquivo como policy-require-only-small-environments.yaml:

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

  2. Aplique a política:

     gcloud org-policies set-policy policy-require-only-small-environments.yaml

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

Testar a política

gcloud composer environments create ENVIRONMENT_NAME \   --location=LOCATION \   --image-version="composer-2.14.4-airflow-2.10.5" \   --environment-size=medium

Essa criação de ambiente falha devido à restrição que exige apenas um ambiente pequeno do Composer.

O resultado será assim:

You can't perform this action on a Composer environment due to Custom Organization Policy constraints set on your project. The following constraint(s) were violated: ["customConstraints/custom.restrictEnvironmentSize": All environments must be small.]

Para resolver o erro anterior, crie um ambiente pequeno. Exemplo:

gcloud composer environments create ENVIRONMENT_NAME \   --location=LOCATION \   --image-version="composer-2.14.4-airflow-2.10.5" \   --environment-size=small

A criação do ambiente foi iniciada.

Exemplos de políticas personalizadas da organização para casos de uso comuns

Confira na tabela a sintaxe de algumas restrições personalizadas comuns.

Descrição Sintaxe da restrição
Permitir apenas ambientes de IP privado do Cloud Composer 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.allowOnlyPrivateIp       resourceTypes:       - composer.googleapis.com/Environment       methodTypes:       - CREATE       condition: resource.config.privateEnvironmentConfig.enablePrivateEnvironment == true       actionType: ALLOW       displayName: Only Private IP environments       description: All environments must use Private IP networking
O número máximo de workers precisa ser 10 ou menos 
      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictMaxWorketCount       resourceTypes:       - composer.googleapis.com/Environment       methodTypes:       - CREATE       - UPDATE       condition: resource.config.workloadsConfig.worker.maxCount <= 10       actionType: ALLOW       displayName: Limit the maximum number of workers       description: All environments must have 10 or less workers

Recursos compatíveis com o Cloud Composer

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

Recurso Campo
composer.googleapis.com/Environment resource.config.environmentSize
resource.config.maintenanceWindow.recurrence
resource.config.masterAuthorizedNetworksConfig.enabled
resource.config.nodeConfig.enableIpMasqAgent
resource.config.nodeConfig.network
resource.config.nodeConfig.serviceAccount
resource.config.nodeConfig.subnetwork
resource.config.privateEnvironmentConfig.cloudComposerConnectionSubnetwork
resource.config.privateEnvironmentConfig.enablePrivateBuildsOnly
resource.config.privateEnvironmentConfig.enablePrivateEnvironment
resource.config.privateEnvironmentConfig.enablePrivatelyUsedPublicIps
resource.config.privateEnvironmentConfig.networkingConfig.connectionType
resource.config.privateEnvironmentConfig.privateClusterConfig.enablePrivateEndpoint
resource.config.recoveryConfig.scheduledSnapshotsConfig.enabled
resource.config.recoveryConfig.scheduledSnapshotsConfig.snapshotCreationSchedule
resource.config.recoveryConfig.scheduledSnapshotsConfig.snapshotLocation
resource.config.recoveryConfig.scheduledSnapshotsConfig.timeZone
resource.config.resilienceMode
resource.config.softwareConfig.cloudDataLineageIntegration.enabled
resource.config.softwareConfig.imageVersion
resource.config.softwareConfig.webServerPluginsMode
resource.config.workloadsConfig.dagProcessor.count
resource.config.workloadsConfig.dagProcessor.cpu
resource.config.workloadsConfig.dagProcessor.memoryGb
resource.config.workloadsConfig.dagProcessor.storageGb
resource.config.workloadsConfig.scheduler.count
resource.config.workloadsConfig.scheduler.cpu
resource.config.workloadsConfig.scheduler.memoryGb
resource.config.workloadsConfig.scheduler.storageGb
resource.config.workloadsConfig.triggerer.count
resource.config.workloadsConfig.triggerer.cpu
resource.config.workloadsConfig.triggerer.memoryGb
resource.config.workloadsConfig.webServer.cpu
resource.config.workloadsConfig.webServer.memoryGb
resource.config.workloadsConfig.webServer.storageGb
resource.config.workloadsConfig.worker.cpu
resource.config.workloadsConfig.worker.maxCount
resource.config.workloadsConfig.worker.memoryGb
resource.config.workloadsConfig.worker.minCount
resource.config.workloadsConfig.worker.storageGb
resource.name

A seguir