Gestionar recursos de Firestore con compatibilidad con MongoDB mediante restricciones personalizadas

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

  • firestore.googleapis.com/Database

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

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

El Google Cloud servicio de políticas de organización te ofrece 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 restricciones llamadas restricciones que se aplican a losGoogle Cloud recursos y a los elementos descendientes de esos recursos en la Google Cloud jerarquía de recursos. Puedes aplicar políticas de organización a nivel de organización, carpeta o proyecto.

La política de la organización proporciona restricciones gestionadas integradas para varios Google Cloud servicios. Sin embargo, si quieres tener un control más granular 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 organización se heredan de los descendientes de los recursos en los que apliques la política. Por ejemplo, si aplicas una política a una carpeta, Google Cloud se aplicará a todos los proyectos de la carpeta. Para obtener más información sobre este comportamiento y cómo cambiarlo, consulta las reglas de evaluación de la jerarquía.

Ventajas

  • Seguridad, cumplimiento y gobierno: puedes usar políticas de organización personalizadas de las siguientes formas:

    • Para cumplir los requisitos de recuperación ante desastres, puedes exigir ajustes específicos de recuperación ante desastres en las bases de datos, como la protección contra eliminación y la recuperación a un momento dado.

    • Puede restringir la creación de bases de datos a determinadas ubicaciones.

    • Puedes requerir CMEK (clave de cifrado gestionada por el cliente) para las bases de datos.

  • Auditoría: las restricciones de políticas de la organización personalizadas se registran en la auditoría. Cualquier operación, incluidas las modificaciones y las comprobaciones de restricciones, generará los registros de auditoría de Cloud correspondientes.

Antes de empezar

  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 role (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. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

  6. Para inicializar gcloud CLI, ejecuta el siguiente 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 role (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. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

  11. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init
  12. Asegúrate de que conoces el ID de tu organización.

    13. Roles obligatorios

    Para obtener los permisos que necesitas para gestionar las políticas de la organización personalizadas, pide a tu administrador que te conceda el rol de gestión de identidades y accesos Administrador de políticas de la organización (roles/orgpolicy.policyAdmin) en el recurso de la organización. Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar acceso a proyectos, carpetas y organizaciones.

    También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

    Configurar 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 admite el servicio en el que vas a aplicar la política de organización. Las condiciones de tus restricciones personalizadas se definen mediante el lenguaje de expresión común (CEL). Para obtener más información sobre cómo crear condiciones en restricciones personalizadas con CEL, consulta la sección sobre CEL del artículo Crear y gestionar restricciones personalizadas.

    Consola

    Para crear una restricción personalizada, sigue estos pasos:

    1. En la Google Cloud consola, 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 en el que quieras definir la política de la organización.
    3. Haz clic en Restricción personalizada.
    4. En el cuadro Nombre visible, introduce un nombre legible para la restricción. Este nombre se usa en los mensajes de error y se puede usar para identificar y depurar. No utilices información personal identificable ni datos sensibles en los nombres visibles, ya que estos nombres podrían mostrarse en mensajes de error. Este campo puede contener hasta 200 caracteres.
    5. En el cuadro ID de restricción, escribe el nombre que quieras asignar a la nueva restricción personalizada. Una restricción personalizada solo puede contener letras (mayúsculas y minúsculas) o números, como custom.disableGkeAutoUpgrade. Este campo puede contener hasta 70 caracteres, sin contar el prefijo (custom.). Por ejemplo, organizations/123456789/customConstraints/custom. No incluyas IPI ni datos sensibles en el ID de la restricción, ya que podría exponerse en mensajes de error.
    6. En el cuadro Description, introduce una descripción de la restricción que sea legible por humanos. Esta descripción se usa como mensaje de error cuando se infringe la política. Incluye detalles sobre por qué se ha producido la infracción de las políticas y cómo resolverla. No incluyas IPI ni datos sensibles en la descripción, ya que podrían exponerse en mensajes de error. Este campo puede contener hasta 2000 caracteres.
    7. En el cuadro Tipo de recurso, seleccione el nombre del Google Cloud recurso REST que contenga el objeto y el campo que quiera restringir. Por ejemplo, container.googleapis.com/NodePool. La mayoría de los tipos de recursos admiten hasta 20 restricciones personalizadas. Si intentas crear más restricciones personalizadas, la operación fallará.
    8. En Método de aplicación, selecciona si quieres aplicar la restricción al método CREATE de REST o a los métodos CREATE y UPDATE. Si aplicas la restricción con el método UPDATE en un recurso que la infringe, la política de la organización bloqueará los cambios en ese recurso, a menos que el cambio resuelva la infracción.

      9. No todos los Google Cloud servicios admiten ambos métodos. Para ver los métodos admitidos de cada servicio, busca el servicio en Servicios admitidos.

    9. Para definir una condición, haz clic en Editar condición.
      1. En el panel Añadir condición, crea una condición de CEL que haga referencia a un recurso de servicio compatible, por ejemplo, resource.management.autoUpgrade == false. Este campo puede contener hasta 1000 caracteres. Para obtener más información sobre el uso de CEL, consulta el artículo Lenguaje de expresión común. Para obtener más información sobre los recursos de servicio que puede usar en sus restricciones personalizadas, consulte Servicios admitidos en restricciones personalizadas.
      2. Haz clic en Guardar.
    10. En Acción, seleccione si quiere permitir o denegar el método evaluado si se cumple la condición.

      11. La acción de denegación significa que la operación para crear o actualizar el recurso se bloquea si la condición se evalúa como verdadera.

      La acción de permitir significa que la operación para crear o actualizar el recurso solo se permite si la condición se evalúa como verdadera. Se bloquean todos los demás casos, excepto los que se incluyan explícitamente en la condición.

    11. Haz clic en Crear restricción.

      12. Cuando haya introducido un valor en cada campo, aparecerá a la derecha la configuración YAML equivalente de esta restricción personalizada.

    gcloud

    1. Para crear una restricción personalizada, crea un archivo YAML con el siguiente formato: 
      2.       name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
      resourceTypes:
      - RESOURCE_NAME
      methodTypes:
      - CREATE
      - UPDATE       
      condition: "CONDITION"
      actionType: ACTION
      displayName: DISPLAY_NAME
      description: DESCRIPTION

      Haz los cambios siguientes:

      • ORGANIZATION_ID: el ID de tu organización, como 123456789.
      • CONSTRAINT_NAME: el nombre que quieras asignar a la nueva restricción personalizada. Una restricción personalizada solo puede contener letras (incluidas mayúsculas y minúsculas) o números. Por ejemplo, custom.deleteProtectionRequired. Este campo puede contener hasta 70 caracteres.
      • RESOURCE_NAME: nombre completo del recurso Google Cloud que contiene el objeto y el campo que quieres restringir. Por ejemplo, firestore.googleapis.com/Database.
      • CONDITION: una condición de CEL que se escribe en una representación de un recurso de servicio admitido. Este campo puede contener hasta 1000 caracteres. Por ejemplo, "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\"".

        • Para obtener más información sobre los recursos disponibles para escribir condiciones, consulta Recursos admitidos.

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

        • La acción de permitir significa que, si la condición se evalúa como verdadera, se permite la operación para crear o actualizar el recurso. Esto también significa que se bloquearán todos los demás casos, excepto el que se haya incluido explícitamente en la condición.

        La acción de denegación significa que, si la condición se evalúa como verdadera, se bloquea la operación para crear o actualizar el recurso.

      • DISPLAY_NAME: nombre descriptivo de la restricción. Este campo puede contener hasta 200 caracteres.
      • DESCRIPTION: descripción de la restricción que se puede leer fácilmente y que se muestra como mensaje de error cuando se infringe la política. Este campo puede contener hasta 2000 caracteres.
    2. Una vez que hayas creado el archivo YAML de una nueva restricción personalizada, debes configurarla para que esté disponible en las políticas de organización de tu organización. Para configurar una restricción personalizada, usa el comando gcloud org-policies set-custom-constraint: 
      3.         gcloud org-policies set-custom-constraint CONSTRAINT_PATH

      Sustituye CONSTRAINT_PATH por la ruta completa del archivo de restricción personalizada. Por ejemplo, /home/user/customconstraint.yaml.

      Una vez completada esta operación, tus restricciones personalizadas estarán disponibles como políticas de organización en tu lista de Google Cloud políticas de organización.

    3. Para verificar que la restricción personalizada existe, usa el comando gcloud org-policies list-custom-constraints: 
      4.       gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

      Sustituye ORGANIZATION_ID por el ID del recurso de tu organización.

      Para obtener más información, consulta Ver las políticas de la organización.

    Aplicar una política de organización personalizada

    Para aplicar una restricción, crea una política de organización que haga referencia a ella y, a continuación, aplica esa política de organización a un Google Cloud recurso.

    Consola

    1. En la Google Cloud consola, 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 en el que quieras definir la política de organización.
    3. En la lista de la página Políticas de organización, selecciona la restricción para ver la página Detalles de la política correspondiente.
    4. Para configurar la política de organización de este recurso, haz clic en Gestionar política.
    5. En la página Editar política, selecciona Anular política del recurso superior.
    6. Haz clic en Añadir regla.
    7. En la sección Aplicación, selecciona si esta política de la organización se aplica o no.
    8. Opcional: Para que la política de la organización dependa de una etiqueta, haz clic en Añadir condición. Ten en cuenta que, si añades una regla condicional a una política de organización, debes añadir al menos una regla incondicional o la política no se podrá guardar. Para obtener más información, consulta el artículo Configurar una política de organización con etiquetas.
    9. Haz clic en Probar cambios para simular el efecto de la política de la organización. Para obtener más información, consulta Probar los cambios en las políticas de la organización con el simulador de políticas.
    10. Para aplicar la política de la organización en modo de prueba de funcionamiento, haz clic en Definir política de prueba de funcionamiento. Para obtener más información, consulta Crear una política de organización en modo de prueba.
    11. Una vez que hayas verificado que la política de la organización en modo de prueba funciona correctamente, define la política activa haciendo clic en Definir política.

    gcloud

    1. Para crear una política de organización con reglas booleanas, crea un archivo YAML de política que haga referencia a la restricción: 
      2.         name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
        spec:
          rules:
          - enforce: true
        
        dryRunSpec:
          rules:
          - enforce: true

      Haz los cambios siguientes:

      • PROJECT_ID: el proyecto en el que quieras aplicar la restricción.
      • CONSTRAINT_NAME: el nombre que has definido para tu restricción personalizada. Por ejemplo, custom.deleteProtectionRequired.
    2. Para aplicar la política de la organización en el modo de prueba, ejecuta el siguiente comando con la marca dryRunSpec: 
      3.         gcloud org-policies set-policy POLICY_PATH \
          --update-mask=dryRunSpec

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

    3. Una vez que haya verificado que la política de la organización en modo de prueba funciona correctamente, defina la política activa con el comando org-policies set-policy y la marca spec: 
      4.         gcloud org-policies set-policy POLICY_PATH \
          --update-mask=spec

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

    Probar la política de organización personalizada

    Antes de empezar, debes saber lo siguiente:

    • ID de tu organización

    1. Crea el archivo deleteProtectionRequired.yaml de la siguiente manera:

       name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
 resourceTypes:
 - firestore.googleapis.com/Database
 methodTypes:
 - CREATE
 - UPDATE
 condition: "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\""
 actionType: ALLOW
 displayName: Firestore with MongoDB compatibility Delete Protection Required
 description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.

      De esta forma, todos los métodos CREATE y UPDATE de una base de datos de Firestore con compatibilidad con MongoDB cumplen la restricción de que deleteProtectionState sea DELETE_PROTECTION_ENABLED. Por lo tanto, se rechazarán las operaciones de creación, actualización, restauración o clonación de bases de datos que no tengan habilitada explícitamente la protección contra eliminación.

    2. Configura la restricción personalizada a nivel de organización:

      gcloud org-policies set-custom-constraint deleteProtectionRequired.yaml

    Probar la política

    Intenta crear una base de datos sin definir la marca --delete-protection en un proyecto de la organización:

    gcloud firestore database create \
   --project=PROJECT_ID \
   --database=DATABASE_ID \

    El resultado es el siguiente:

    Operation denied by custom org policies: ["customConstraints/custom.deleteProtectionRequired": "To ensure the data security, Delete Protection is required to be enabled for Firestore databases"]

    Probar y analizar los cambios en las políticas de la organización

    Te recomendamos que pruebes y simules todos los cambios en las políticas de tu organización para entender mejor el estado de tu entorno y cómo le afectan los cambios.

    El simulador de políticas de la organización te ayuda a entender el efecto de una restricción y una política de la organización en tu entorno actual. Con esta herramienta, puedes revisar todas las configuraciones de recursos para ver dónde se producen infracciones antes de que se apliquen en tu entorno de producción. Para obtener instrucciones detalladas, consulta el artículo Probar los cambios en las políticas de la organización con el simulador de políticas.

    Cuando conozcas el efecto actual, podrás crear una política de la organización en modo de prueba para entender el impacto y las posibles infracciones de una política durante los próximos 30 días. Una política de la organización en modo de prueba es un tipo de política de la organización en el que las infracciones de la política se registran en un registro de auditoría, pero no se deniegan las acciones infractoras. Puedes crear una política de organización en modo de prueba desde una restricción personalizada mediante la Google Cloud consola o la CLI de Google Cloud. Para obtener instrucciones detalladas, consulta Crear una política de organización en modo de prueba.

    Ejemplos de políticas de organización personalizadas para casos prácticos habituales

    En esta tabla se muestran ejemplos de sintaxis de algunas restricciones personalizadas habituales.

    Descripción Sintaxis de las restricciones
    Los nombres de las bases de datos deben seguir un patrón determinado. Ten en cuenta que el formato del nombre de una base de datos en las políticas de organización personalizadas es projects/project-id/databases/database-id, mientras que en las operaciones de gestión de bases de datos solo se especifica database-id. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.nameSuffixMobile
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
condition: "resource.name.endsWith('-mobile')"
actionType: ALLOW
displayName: Firestore database names end with "-mobile"
description: Only allow the creation of database names ending with suffix "-mobile"
    Las bases de datos solo se pueden crear en ubicaciones específicas. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.locationUsCentral1
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
condition: "resource.locationId == 'us-central1'"
actionType: ALLOW
displayName: Firestore database location id us-central1
description: Only allow the creation of databases in region us-central1
    Las bases de datos deben habilitar la point-in-time-recovery. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.pitrEnforce
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.pointInTimeRecoveryEnablement == "POINT_IN_TIME_RECOVERY_ENABLED""
actionType: ALLOW
displayName: Firestore database enables PiTR
description: Only allow the creation and updating of a databases if PiTR is enabled.
    No permitir la creación de bases de datos a menos que se haya habilitado la protección contra la eliminación. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.deleteProtectionState == "DELETE_PROTECTION_ENABLED""
actionType: ALLOW
displayName: Firestore with MongoDB compatibility Delete Protection Required
description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
    Las bases de datos deben usar la configuración de CMEK (clave de cifrado gestionada por el cliente) especificada. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.cmekKeyNotDev
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.cmekConfig.kmsKeyName.matches('dev$')"
actionType: DENY
displayName: Firestore database CMEK key not dev
description: Disallow the creation and updating of databases with CMEK KMS keys ending with "dev".
    Las bases de datos deben usar la edición de base de datos especificada. 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.enterpriseEditionRequired
resourceTypes:
- firestore.googleapis.com/Database
methodTypes:
- CREATE
- UPDATE
condition: "resource.databaseEdition == "ENTERPRISE""
actionType: ALLOW
displayName: Firestore Enterprise Edition Required
description: Only allow the creation and updating of databases with Enterprise Edition.

    Recursos admitidos de Firestore con compatibilidad con MongoDB

    En la siguiente tabla se enumeran los recursos de compatibilidad de Firestore con MongoDB que puedes consultar en las restricciones personalizadas.

    Recurso Campo
    firestore.googleapis.com/Database resource.appEngineIntegrationMode
    resource.cmekConfig.kmsKeyName
    resource.concurrencyMode
    resource.deleteProtectionState
    resource.locationId
    resource.name
    resource.pointInTimeRecoveryEnablement
    resource.type

    Siguientes pasos