Crea restricciones de políticas de la organización personalizadas

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

En esta página, se muestra cómo usar las restricciones personalizadas del servicio de políticas de la organización para restringir operaciones específicas en los siguientes Google Cloud recursos:

  • composer.googleapis.com/Environment

Para obtener más información sobre la política de la organización, consulta Políticas de la organización personalizadas.

Acerca de las políticas y restricciones de la organización

El Google Cloud Servicio de políticas de la organización te brinda un control centralizado y programático sobre los recursos de tu organización. Como administrador de políticas de la organización, puedes definir una política de la organización, que es un conjunto de limitaciones llamadas restricciones que se aplican a los recursos deGoogle Cloud y a sus descendientes en la jerarquía de recursos deGoogle Cloud . Puedes aplicar políticas de la organización a nivel de la organización, carpeta o proyecto.

La política de la organización proporciona restricciones predefinidas para varios servicios de Google Cloud . Sin embargo, si deseas un control más detallado y personalizable sobre los campos específicos que están restringidos en las políticas de tu organización, también puedes crear restricciones personalizadas y usarlas en una política de la organización.

Herencia de políticas

De forma predeterminada, las políticas de la organización se heredan según los subordinados de los recursos en los que se aplica la política. Por ejemplo, si aplicas una política en una carpeta, Google Cloud aplica la política en todos los proyectos de la carpeta. Para obtener más información sobre este comportamiento y cómo cambiarlo, consulta Reglas de evaluación de la jerarquía.

Beneficios

Puedes usar políticas de organización personalizadas para permitir o denegar valores específicos para los recursos de Cloud Composer. Por ejemplo, si una solicitud para crear o actualizar un entorno de Cloud Composer no satisface la validación de restricciones personalizadas según lo establecido por la política de tu organización, la solicitud fallará y se mostrará un error al llamador. Además, el uso de políticas de la organización personalizadas ofrece los siguientes beneficios:

  1. Mejora la seguridad. Por ejemplo, puedes definir políticas que prohíban la creación de entornos de IP públicas, habiliten direcciones IP públicas usadas de forma privada o especifiquen el uso de una red y subred específicas.

  2. Proporciona un control detallado sobre los recursos que se crean o usan cuando se crea o actualiza un entorno.

Limitaciones

Al igual que todas las restricciones de políticas de la organización, los cambios de política no se aplican de forma retroactiva a las instancias existentes.

  • Una política nueva no afecta a la configuración de las instancias existentes.
  • La configuración de una instancia existente sigue siendo válida, a menos que la cambies de un valor de cumplimiento a un valor de no cumplimiento con la consola de Google Cloud, Google Cloud CLI o RPC.

Antes de aplicar políticas de organización personalizadas en el tipo de método UPDATE del recurso, asegúrate de que los entornos existentes cumplan con cada política.

Debido a que una operación de actualización puede actualizar solo un campo, se puede producir un interbloqueo si varios campos de un entorno existente incumplen las políticas al mismo tiempo.

Para evitar el interbloqueo, realiza una de las siguientes acciones:

  • (Recomendado) Haz que todos los entornos existentes satisfagan una política antes de aplicarla a los recursos. Para verificar cuáles de los entornos existentes no serán compatibles después de la aplicación forzosa de la política, puedes usar el simulador de políticas.

  • Inhabilita la aplicación forzosa de la política, actualiza los entornos existentes al estado de cumplimiento y vuelve a aplicar la política.

Antes de comenzar

  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. Make sure that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.
  5. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  6. To initialize the gcloud CLI, run the following command:

    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. Make sure that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.
  10. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  11. To initialize the gcloud CLI, run the following command:

    gcloud init
  12. Asegúrate de conocer el ID de la organización.

Roles obligatorios

Para obtener los permisos que necesitas para administrar las políticas de la organización personalizadas, pídele a tu administrador que te otorgue el rol de IAM de administrador de políticas de la organización (roles/orgpolicy.policyAdmin) en el recurso de organización. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

Crea una restricción personalizada

Una restricción personalizada se define en un archivo YAML mediante los recursos, los métodos, las condiciones y las acciones que son compatibles con el servicio en el que aplicas la política de la organización. Las condiciones para tus restricciones personalizadas se definen con Common Expression Language (CEL). Si deseas obtener más información para compilar condiciones en restricciones personalizadas mediante CEL, consulta la sección CEL de Crea y administra restricciones personalizadas.

Para crear una restricción personalizada, crea un archivo YAML con el siguiente formato:

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- RESOURCE_NAME
methodTypes:
- CREATE
- UPDATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

Reemplaza lo siguiente:

  • ORGANIZATION_ID: el ID de la organización, como 123456789.

  • CONSTRAINT_NAME: el nombre que deseas para tu nueva restricción personalizada. Una restricción personalizada debe comenzar con custom. y solo puede incluir letras mayúsculas, minúsculas o números. Por ejemplo, custom.restrictEnvironmentSize. La longitud máxima de este campo es de 70 caracteres.

  • RESOURCE_NAME: El nombre completamente calificado del recursoGoogle Cloud que contiene el objeto y el campo que deseas restringir. Por ejemplo, composer.googleapis.com/Environment.

  • CONDITION: una condición de CEL que se escribe en una representación de un recurso de servicio compatible. La longitud máxima de este campo es 1000 caracteres. Consulta Recursos compatibles con el fin de obtener más información sobre los recursos disponibles para escribir condiciones. Por ejemplo, resource.config.environmentSize == "ENVIRONMENT_SIZE_SMALL".

  • ACTION: la acción que se realiza si se cumple condition. Los valores posibles son ALLOW y DENY.

  • DISPLAY_NAME: un nombre descriptivo para la restricción. La longitud máxima de este campo es 200 caracteres.

  • DESCRIPTION: una descripción fácil de usar de la restricción que se mostrará como un mensaje de error cuando se infringe la política. La longitud máxima de este campo es 2000 caracteres.

Para obtener más información sobre cómo crear una restricción personalizada, consulta Define restricciones personalizadas.

Configura una restricción personalizada

Después de crear el archivo YAML para una nueva restricción personalizada, debes configurarla para que esté disponible para las políticas de la organización de tu organización. Para configurar una restricción personalizada, usa el comando gcloud org-policies set-custom-constraint:
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
Reemplaza CONSTRAINT_PATH por la ruta de acceso completa al archivo de restricción personalizado. Por ejemplo, /home/user/customconstraint.yaml. Una vez completadas, tus restricciones personalizadas estarán disponibles como políticas de la organización en tu lista de Google Cloud políticas de la organización. Para verificar que la restricción personalizada exista, usa el comando gcloud org-policies list-custom-constraints:
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
Reemplaza ORGANIZATION_ID por el ID del recurso de tu organización. Para obtener más información, consulta Visualiza las políticas de la organización.

Aplica de manera forzosa una política de la organización personalizada

Puedes aplicar una restricción booleana si creas una política de la organización que haga referencia a ella y si aplicas esa política a un recurso Google Cloud .

Console

  1. En la consola de Google Cloud, ve a la página Políticas de la organización.

    Ir a Políticas de la organización

  2. En el selector de proyectos, selecciona el proyecto para el que deseas configurar la política de la organización.
  3. En la lista de la página Políticas de la organización, selecciona tu restricción para ver la página Detalles de la política de esa restricción.
  4. Si deseas configurar las políticas de la organización para este recurso, haz clic en Administrar política.
  5. En la página Editar política, selecciona Anular la política del elemento superior.
  6. Haz clic en Agregar una regla.
  7. En la sección Aplicación, selecciona si la aplicación de esta política de la organización está activada o desactivada.
  8. Opcional: haz clic en Agregar condición para que la política de la organización sea condicional en una etiqueta. Ten en cuenta que si agregas una regla condicional a una política de la organización, debes agregar al menos una regla sin condición o la política no se puede guardar. Para obtener más información, consulta Configura una política de la organización con etiquetas.
  9. Si se trata de una restricción personalizada, puedes hacer clic en Probar cambios para simular el efecto de esta política de la organización. Para obtener más información, consulta Prueba los cambios en las políticas de la organización con Policy Simulator.
  10. Para finalizar y aplicar la política de la organización, haz clic en Establecer política. La política tarda hasta 15 minutos en aplicarse.

gcloud

Para crear una política de la organización que aplique una restricción booleana, crea un archivo de política en formato YAML que haga referencia a la restricción:

      name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
      spec:
        rules:
        - enforce: true
    

Reemplaza lo siguiente:

  • PROJECT_ID: el proyecto en el que deseas aplicar tu restricción.
  • CONSTRAINT_NAME: el nombre que definiste para tu restricción personalizada. Por ejemplo: custom.restrictEnvironmentSize

Para aplicar la política de la organización que contiene la restricción, ejecuta el siguiente comando:

    gcloud org-policies set-policy POLICY_PATH
    

Reemplaza POLICY_PATH por la ruta de acceso completa al archivo YAML de la política de la organización. La política tarda hasta 15 minutos en aplicarse.

Prueba la política de la organización personalizada

En el siguiente ejemplo, se crea una restricción y una política personalizadas que solo permiten entornos de Cloud Composer pequeños.

Antes de comenzar, debes saber lo siguiente:

  • El ID de tu organización
  • Tu ID del proyecto

Crea la restricción

  1. Guarda el siguiente archivo 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. Aplica la restricción:

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

Crea la política

  1. Guarda el siguiente archivo como policy-require-only-small-environments.yaml:

    name: projects/PROJECT_ID/policies/custom.restrictEnvironmentSize
    spec:
      rules:
      - enforce: true
    
  2. Aplica la política:

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

Después de aplicar la política, espera unos dos minutos para que Google Cloudcomience a aplicarla.

Prueba la política

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

La creación de este entorno falla debido a la restricción existente que requiere solo un tamaño de entorno de Composer pequeño.

El resultado es similar a este:

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 abordar el error anterior, crea un entorno de tamaño pequeño. Por ejemplo:

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

La creación del entorno se inició correctamente.

Ejemplos de políticas de la organización personalizadas para casos de uso comunes

En la siguiente tabla, se proporciona la sintaxis de algunas restricciones personalizadas para casos de uso comunes:

Descripción Sintaxis de la restricción
Permite solo entornos de Cloud Composer con IP privada
      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
    
La cantidad máxima de trabajadores debe ser 10 o 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 compatibles con Cloud Composer

En la siguiente tabla, se enumeran los recursos de Cloud Composer a los que puedes hacer referencia en las restricciones 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

¿Qué sigue?