Usa políticas de la organización personalizadas

    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 recursos de Google Cloud :

    • pubsub.googleapis.com/Schema
    • pubsub.googleapis.com/Snapshot
    • pubsub.googleapis.com/Subscription
    • pubsub.googleapis.com/Topic

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

    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.

      13. 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.messageRetentionSet. La longitud máxima de este campo es de 70 caracteres.

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

      • 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, "has(resource.messageRetentionDuration)".

      • 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 si creas una política de la organización que haga referencia a ella y, luego, 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. Haz clic en Probar cambios para simular el efecto de la política de la organización. La simulación de políticas no está disponible para las restricciones administradas heredadas. 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 con reglas booleanas, crea un archivo YAML de política 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.messageRetentionSet

      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 requieren que todos los temas nuevos en un proyecto específico apliquen garantías en tránsito para los mensajes.

      Antes de comenzar, debes saber lo siguiente:

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

      Crea la restricción

      1. Guarda el siguiente archivo como constraint-require-message-retention.yaml:

        name: organizations/ORGANIZATION_ID/customConstraints/custom.messageRetentionSet
resourceTypes:
- Topic
methodTypes:
- CREATE
- UPDATE
condition: "has(resource.messageRetentionDuration)"
actionType: ALLOW
displayName: Require message retention
description: All topics must set a message retention duration.

        Esto define una restricción en la que cada tema debe establecer una duración de retención de mensajes.

        1. Aplica la restricción:

          gcloud org-policies set-custom-constraint constraint-require-message-retention.yaml

        2. Verifica que la restricción exista:

          gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

          El resultado es similar a este:

          CUSTOM_CONSTRAINT                       ACTION_TYPE   METHOD_TYPES     RESOURCE_TYPES                     DISPLAY_NAME
custom.messageRetentionSet              ALLOW         CREATE,UPDATE    pubsub.googleapis.com/Topic        Require message retention
...

        Crea la política

        1. Guarda el siguiente archivo como policy-require-message-retention.yaml:

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

          Reemplaza PROJECT_ID con el ID del proyecto.

        2. Aplica la política:

          gcloud org-policies set-policy policy-`policy-require-message-retention.yaml`:

        3. Verifica que la política exista:

          gcloud org-policies list --project=PROJECT_ID

          El resultado es similar a este:

          CONSTRAINT                         LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.messageRetentionSet         -              SET               COCsm5QGENiXi2E=

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

        Prueba la política

        Intenta crear un tema sin la retención de mensajes habilitada:

        gcloud pubsub topics create org-policy-test \
  --project=PROJECT_ID \

        Esta es la salida:

        Operation denied by custom org policies: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].

ERROR: Failed to create topic [projects/PROJECT_ID/topics/org-policy-test]: Operation denied by org policy: ["customConstraints/custom.messageRetentionSet": "All topics must set a message retention duration."].
ERROR: (gcloud.pubsub.topics.create) Failed to create the following: [org-policy-test].

        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
        Requiere temas para aplicar garantías en tránsito para los mensajes y proporcionar al menos una región de persistencia permitida 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithRegions
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageStoragePolicy.enforceInTransit == true && resource.messageStoragePolicy.allowedPersistenceRegions.size() >= 1"
  actionType: ALLOW
  displayName: Require in-transit enforcement and regions
  description: All topics must enable in-transit message storage policy enforcement and contain a non-empty list of allowed persistence regions.
        Excluir una región en particular y requerir temas para aplicar garantías en tránsito para los mensajes 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceInTransitWithoutUsEast1
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageStoragePolicy.enforceInTransit && !resource.messageStoragePolicy.allowedPersistenceRegions.exists(r, r == 'us-east1')"
  actionType: ALLOW
  displayName: Require in-transit enforcement and restrict regions
  description: All topics must enable in-transit message storage policy enforcement, and exclude us-east1 from the allowed persistence regions.
        Exige una duración mínima de retención de mensajes para las suscripciones 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.minMessageRetentionDuration
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.messageRetentionDuration < duration('30m')"
  actionType: DENY
  displayName: Minimum message retention duration
  description: All subscriptions must retain unacked messages for at least 30 minutes.
        Requiere suscripciones para habilitar los mensajes no entregados 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.requireDeadLetterPolicy
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.deadLetterPolicy)"
  actionType: ALLOW
  displayName: Require dead letter policy
  description: All subscriptions must set a dead letter policy.
        Exige que los esquemas sean de tipo Avro 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.schemaIsAvro
  resourceTypes:
  - pubsub.googleapis.com/Schema
  methodTypes:
  - CREATE
  - UPDATE
  condition: "resource.type == 'AVRO'"
  actionType: ALLOW
  displayName: Schema is Avro
  description: All schemas must be of type Avro.
        Exige notificaciones push autenticadas para las suscripciones 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.authenticatedPush
  resourceTypes:
  - pubsub.googleapis.com/Subscription
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.pushConfig.pushEndpoint) && has(resource.pushConfig.oidcToken.serviceAccountEmail) && has(resource.pushConfig.oidcToken.audience)"
  actionType: ALLOW
  displayName: Subscription uses authenticated push
  description: All subscriptions must enable push authentication.
        Cómo requerir que los temas habiliten CMEK 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.topicHasCmek
  resourceTypes:
  - pubsub.googleapis.com/Topic
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.kmsKeyName)"
  actionType: ALLOW
  displayName: Topic has CMEK
  description: All topics must use a Cloud KMS CryptoKey.

        Recursos compatibles con Pub/Sub

        En la siguiente tabla, se enumeran los recursos de Pub/Sub a los que puedes hacer referencia en las restricciones personalizadas.

        Recurso Campo
        pubsub.googleapis.com/Schema resource.definition
        resource.name
        resource.type
        pubsub.googleapis.com/Snapshot resource.expireTime
        resource.name
        resource.topic
        pubsub.googleapis.com/Subscription resource.ackDeadlineSeconds
        resource.bigqueryConfig.dropUnknownFields
        resource.bigqueryConfig.serviceAccountEmail
        resource.bigqueryConfig.table
        resource.bigqueryConfig.useTableSchema
        resource.bigqueryConfig.useTopicSchema
        resource.bigqueryConfig.writeMetadata
        resource.cloudStorageConfig.avroConfig.useTopicSchema
        resource.cloudStorageConfig.avroConfig.writeMetadata
        resource.cloudStorageConfig.bucket
        resource.cloudStorageConfig.filenameDatetimeFormat
        resource.cloudStorageConfig.filenamePrefix
        resource.cloudStorageConfig.filenameSuffix
        resource.cloudStorageConfig.maxBytes
        resource.cloudStorageConfig.maxDuration
        resource.cloudStorageConfig.maxMessages
        resource.cloudStorageConfig.serviceAccountEmail
        resource.deadLetterPolicy.deadLetterTopic
        resource.deadLetterPolicy.maxDeliveryAttempts
        resource.enableExactlyOnceDelivery
        resource.enableMessageOrdering
        resource.expirationPolicy.ttl
        resource.filter
        resource.messageRetentionDuration
        resource.messageTransforms.disabled
        resource.messageTransforms.enabled
        resource.messageTransforms.javascriptUdf.code
        resource.messageTransforms.javascriptUdf.functionName
        resource.name
        resource.pushConfig.attributes
        resource.pushConfig.noWrapper.writeMetadata
        resource.pushConfig.oidcToken.audience
        resource.pushConfig.oidcToken.serviceAccountEmail
        resource.pushConfig.pushEndpoint
        resource.retainAckedMessages
        resource.retryPolicy.maximumBackoff
        resource.retryPolicy.minimumBackoff
        resource.topic
        pubsub.googleapis.com/Topic resource.ingestionDataSourceSettings.awsKinesis.awsRoleArn
        resource.ingestionDataSourceSettings.awsKinesis.consumerArn
        resource.ingestionDataSourceSettings.awsKinesis.gcpServiceAccount
        resource.ingestionDataSourceSettings.awsKinesis.streamArn
        resource.ingestionDataSourceSettings.cloudStorage.bucket
        resource.ingestionDataSourceSettings.cloudStorage.matchGlob
        resource.ingestionDataSourceSettings.cloudStorage.minimumObjectCreateTime
        resource.ingestionDataSourceSettings.cloudStorage.textFormat.delimiter
        resource.ingestionDataSourceSettings.platformLogsSettings.severity
        resource.kmsKeyName
        resource.messageRetentionDuration
        resource.messageStoragePolicy.allowedPersistenceRegions
        resource.messageStoragePolicy.enforceInTransit
        resource.messageTransforms.disabled
        resource.messageTransforms.enabled
        resource.messageTransforms.javascriptUdf.code
        resource.messageTransforms.javascriptUdf.functionName
        resource.name
        resource.schemaSettings.encoding
        resource.schemaSettings.firstRevisionId
        resource.schemaSettings.lastRevisionId
        resource.schemaSettings.schema

        ¿Qué sigue?