Crie restrições de políticas da organização personalizadas

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

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:

• composer.googleapis.com/Environment

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 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 de organização personalizadas para permitir ou negar valores específicos para recursos do Cloud Composer. Por exemplo, se um pedido para criar ou atualizar um ambiente do Cloud Composer não cumprir a validação de restrições personalizadas definida pela política da sua organização, o pedido falha e é devolvido um erro ao autor da chamada. Além disso, a utilização de políticas da organização personalizadas:

1. Melhora a segurança. Por exemplo, pode definir políticas que proíbem a criação de ambientes de IPs públicos, ativar endereços IP públicos usados de forma privada ou especificar a utilização de uma rede e uma sub-rede específicas.

2. Oferece controlo detalhado sobre os recursos que estão a ser criados ou usados quando cria ou atualiza um ambiente.

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 às instâncias existentes.

• Uma nova política não afeta as configurações de instâncias existentes.
• Uma configuração de instância existente permanece válida, a menos que a altere de um valor em conformidade para um valor não em conformidade através daGoogle Cloud consola, da Google Cloud CLI ou do RPC.

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

Uma vez que uma operação de atualização só pode atualizar um campo, pode ocorrer um impasse se vários campos de um ambiente existente violarem as políticas ao mesmo tempo.

Para evitar o impasse, efetue uma das seguintes ações:

• (Recomendado) Certifique-se de que todos os ambientes existentes estão em conformidade com uma política antes de aplicar a política aos recursos. Para verificar que ambientes existentes não vão estar em conformidade após a aplicação da política, pode usar o simulador de políticas.

• Desative a aplicação da política, atualize os ambientes existentes para o estado em conformidade e volte a aplicar a política.

Antes de começar

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.

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 role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

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

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

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 role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

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

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

1. Certifique-se de que sabe o seu ID da organização.

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 da política 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.

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

Consola

Para criar uma restrição personalizada, faça o seguinte:

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. Clique em Restrição personalizada.
4. Na caixa Nome a apresentar, introduza um nome legível para a restrição. Este nome é usado em mensagens de erro e pode ser usado para identificação e depuração. Não use IIP nem dados confidenciais em nomes a apresentar, uma vez que este nome pode ser exposto em mensagens de erro. Este campo pode conter até 200 carateres.
5. Na caixa ID da restrição, introduza o nome pretendido para a nova restrição personalizada. Uma restrição personalizada só pode conter letras (incluindo maiúsculas e minúsculas) ou números, por exemplo, custom.disableGkeAutoUpgrade. Este campo pode conter até 70 carateres, sem contar com o prefixo (custom.), por exemplo, organizations/123456789/customConstraints/custom. Não inclua PII nem dados confidenciais no ID da restrição, uma vez que podem ser expostos em mensagens de erro.
6. Na caixa Descrição, introduza uma descrição legível da restrição. Esta descrição é usada como uma mensagem de erro quando a política é violada. Inclua detalhes sobre o motivo pelo qual a violação de política ocorreu e como resolvê-la. Não inclua PII nem dados confidenciais na descrição, uma vez que podem ser expostos em mensagens de erro. Este campo pode conter até 2000 carateres.
7. Na caixa Tipo de recurso, selecione o nome do Google Cloud recurso REST que contém o objeto e o campo que quer restringir, por exemplo, container.googleapis.com/NodePool. A maioria dos tipos de recursos suporta até 20 restrições personalizadas. Se tentar criar mais restrições personalizadas, a operação falha.
8. Em Método de aplicação, selecione se quer aplicar a restrição a um método CREATE do REST ou aos métodos CREATE e UPDATE. Se aplicar a restrição com o método UPDATE num recurso que viole a restrição, as alterações a esse recurso são bloqueadas pela política da organização, a menos que a alteração resolva a violação.

Nem todos os serviços Google Cloud suportam ambos os métodos. Para ver os métodos suportados para cada serviço, encontre o serviço em Serviços suportados.

9. Para definir uma condição, clique em Editar condição.
1. No painel Adicionar condição, crie uma condição CEL que faça referência a um recurso de serviço suportado, por exemplo, resource.management.autoUpgrade == false. Este campo pode conter até 1000 carateres. Para ver detalhes sobre a utilização do IEC, consulte o artigo Idioma de expressão comum. Para mais informações sobre os recursos de serviço que pode usar nas suas restrições personalizadas, consulte Serviços suportados de restrições personalizadas.
2. Clique em Guardar.
10. Em Ação, selecione se quer permitir ou recusar o método avaliado se a condição for cumprida.

A ação de recusa significa que a operação para criar ou atualizar o recurso é bloqueada se a condição for avaliada como verdadeira.

A ação allow significa que a operação para criar ou atualizar o recurso só é permitida se a condição for avaliada como verdadeira. Todos os outros casos, exceto os explicitamente listados na condição, são bloqueados.

11. Clique em Criar restrição.

Quando tiver introduzido um valor em cada campo, a configuração YAML equivalente para esta restrição personalizada é apresentada à direita.

gcloud

1. 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 só pode conter letras (incluindo maiúsculas e minúsculas) ou números, por exemplo, custom.restrictEnvironmentSize. Este campo pode conter até 70 carateres.
• RESOURCE_NAME: o nome totalmente qualificado do recurso que contém o objeto e o campo que quer restringir. Google CloudPor exemplo, composer.googleapis.com/Environment.
• CONDITION: uma condição CEL escrita em função de uma representação de um recurso de serviço suportado. Este campo pode conter até 1000 carateres. Por exemplo, resource.config.environmentSize == "ENVIRONMENT_SIZE_SMALL".

Para mais informações sobre os recursos disponíveis para escrever condições, consulte o artigo Recursos suportados.

• ACTION: a ação a realizar se a condição condition for cumprida. Os valores possíveis são ALLOW e DENY.

A ação allow significa que, se a condição for avaliada como verdadeira, a operação para criar ou atualizar o recurso é permitida. Isto também significa que todos os outros casos, exceto o que está explicitamente listado na condição, são bloqueados.

A ação de recusa significa que, se a condição for avaliada como verdadeira, a operação para criar ou atualizar o recurso é bloqueada.

• DISPLAY_NAME: um nome intuitivo para a restrição. Este campo pode conter até 200 carateres.
• DESCRIPTION: uma descrição simples da restrição a apresentar como uma mensagem de erro quando a política é violada. Este campo pode conter até 2000 carateres.
2. 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 ficheiro de restrição personalizado. Por exemplo, /home/user/customconstraint.yaml.

Após a conclusão desta operaçã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.

3. 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 esta política de organização é aplicada ou não.
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 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. 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 aplicar a política da organização no modo de execução de ensaio, clique em Definir política de execução de ensaio. Para mais informações, consulte Crie uma política de organização no modo de teste.
11. Depois de verificar que a política da organização no modo de teste funciona como pretendido, defina a política ativa clicando em Definir política.

gcloud

1. 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
        
        dryRunSpec:
          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.restrictEnvironmentSize.
2. Para aplicar a política da organização no modo de teste, execute o seguinte comando com a flag dryRunSpec:

        gcloud org-policies set-policy POLICY_PATH \
          --update-mask=dryRunSpec
      

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.

3. Depois de verificar que a política da organização no modo de teste funciona como pretendido, defina a política ativa com o comando org-policies set-policy e a flag spec:

        gcloud org-policies set-policy POLICY_PATH \
          --update-mask=spec
      

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 apenas ambientes pequenos do Cloud Composer.

Antes de começar, deve saber o seguinte:

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

Crie a restrição

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

Crie a política

1. Guarde o seguinte ficheiro 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 Google Cloud comece a aplicar a política.

Teste a política

gcloud composer environments create ENVIRONMENT_NAME \
  --location=LOCATION \
  --image-version="composer-3-airflow-2.10.5-build.19" \
  --environment-size=medium

Esta criação do ambiente falha devido à restrição em vigor que requer apenas um tamanho pequeno do ambiente do Composer.

O resultado é semelhante ao seguinte:

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 de tamanho pequeno. Por exemplo:

gcloud composer environments create ENVIRONMENT_NAME \
  --location=LOCATION \
  --image-version="composer-3-airflow-2.10.5-build.19" \
  --environment-size=small

A criação do ambiente foi iniciada com êxito.

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
Permita apenas ambientes do Cloud Composer com IP privado	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 trabalhadores tem de ser igual ou inferior a 10	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 suportados do Cloud Composer

A tabela seguinte apresenta os recursos do Cloud Composer que pode referenciar 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

O que se segue?

• Saiba mais sobre o serviço de políticas organizacionais.
• Saiba como criar e gerir políticas de organização.
• Veja a lista completa de restrições de políticas organizacionais geridas.