Administra recursos de Firestore con compatibilidad con MongoDB usando restricciones personalizadas

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

  • firestore.googleapis.com/Database

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 restricciones y políticas de la organización

El servicio de políticas de la organización de Google Cloud 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 y a sus subordinados deGoogle Cloud 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 brinda 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 en ella. Para obtener más información sobre este comportamiento y cómo cambiarlo, consulta Reglas de evaluación de la jerarquía.

Beneficios

  • Seguridad, cumplimiento y administración: Puedes usar políticas personalizadas de la organización de la siguiente manera:

    • Para aplicar los requisitos de recuperación ante desastres, puedes requerir parámetros de configuración específicos de recuperación ante desastres en bases de datos, como la protección contra eliminación y la recuperación de un momento determinado.

    • Puedes restringir la creación de bases de datos solo a ciertas ubicaciones.

    • Puedes solicitar CMEK (clave de encriptación administrada por el cliente) para las bases de datos.

  • Auditoría: Las restricciones de la política de la organización personalizadas se registran en el registro de auditoría. Cualquier operación, incluidas las modificaciones y las verificaciones de restricciones, generará los Registros de auditoría de Cloud correspondientes.

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.

    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 usas un proveedor de identidad externo (IdP), primero debes Acceder a la gcloud CLI 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 usas un proveedor de identidad externo (IdP), primero debes Acceder a la gcloud CLI con tu identidad federada.

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

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

    13. Roles obligatorios

    Si deseas 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 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 a través de roles personalizados o cualquier otro rol predefinido.

    Configura una restricción personalizada

    Una restricción personalizada se define en un archivo YAML con 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 con CEL, consulta la sección CEL de Crea y administra restricciones personalizadas.

    Console

    Para crear una restricción personalizada, haz lo siguiente:

    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. Haz clic en Restricción personalizada.
    4. En el cuadro Nombre visible, ingresa un nombre legible para la restricción. Este nombre se usa en los mensajes de error y se puede usar para la identificación y la depuración. No uses PII ni datos sensibles en los nombres visibles, ya que podrían exponerse en mensajes de error. Este campo puede contener hasta 200 caracteres.
    5. En el cuadro ID de restricción, ingresa el nombre que deseas para 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.disableGkeAutoUpgrade. Este campo puede contener hasta 70 caracteres, sin contar el prefijo (custom.), por ejemplo, organizations/123456789/customConstraints/custom. No incluyas PII ni datos sensibles en el ID de la restricción, ya que podrían exponerse en mensajes de error.
    6. En el cuadro Description, ingresa una descripción legible de la restricción. Esta descripción se usa como mensaje de error cuando se infringe la política. Incluye detalles sobre por qué se produjo el incumplimiento de política y cómo resolverlo. No incluyas PII ni datos sensibles en la descripción, ya que podrían exponerse en mensajes de error. Este campo puede contener hasta 2,000 caracteres.
    7. En el cuadro Tipo de recurso, selecciona el nombre del recurso de Google Cloud REST que contiene el objeto y el campo que deseas 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 deseas aplicar la restricción en un método de REST CREATE o en los métodos CREATE y UPDATE. Si aplicas la restricción con el método UPDATE en un recurso que la incumple, la política de la organización bloqueará los cambios en ese recurso, a menos que el cambio resuelva el incumplimiento.

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

    9. Para definir una condición, haz clic en Editar condición.
      1. En el panel Agregar 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 1,000 caracteres. Para obtener detalles sobre el uso de CEL, consulta Common Expression Language. Para obtener más información sobre los recursos de servicio que puedes usar en tus restricciones personalizadas, consulta Servicios compatibles con restricciones personalizadas.
      2. Haz clic en Guardar.
    10. En Acción, selecciona si deseas permitir o rechazar el método evaluado si se cumple la condición.

      11. La acción de rechazo 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 indican explícitamente en la condición.

    11. Haz clic en Crear restricción.

      12. Cuando ingreses un valor en cada campo, aparecerá a la derecha la configuración de YAML equivalente para 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

      Reemplaza lo siguiente:

      • ORGANIZATION_ID: Es el ID de tu organización, como 123456789.
      • CONSTRAINT_NAME: Es el nombre que deseas para tu 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: Es el nombre completamente calificado del recurso de Google Cloud que contiene el objeto y el campo que deseas 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 compatible. Este campo puede contener hasta 1,000 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: Es la acción que se realiza si se cumple 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 bloquean todos los demás casos, excepto el que se indica explícitamente en la condición.

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

      • DISPLAY_NAME: Es un nombre descriptivo para la restricción. Este campo puede contener hasta 200 caracteres.
      • DESCRIPTION: Una descripción fácil de usar de la restricción que se mostrará como un mensaje de error cuando se infrinja la política. Este campo puede contener hasta 2,000 caracteres.
    2. Después de crear el archivo YAML de 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: 
      3.         gcloud org-policies set-custom-constraint CONSTRAINT_PATH

      Reemplaza CONSTRAINT_PATH por la ruta de acceso completa a tu archivo de restricción personalizado. Por ejemplo, /home/user/customconstraint.yaml

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

    3. Para verificar que la restricción personalizada exista, usa el comando gcloud org-policies list-custom-constraints: 
      4.       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 Cómo visualizar las políticas de la organización.

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

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

    Consola

    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 una 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 superior.
    6. Haz clic en Agregar una regla.
    7. En la sección Aplicación, selecciona si se aplica o no esta política de la organización.
    8. Opcional: para que la política de la organización sea condicional en una etiqueta, haz clic en Agregar condición. 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. Para obtener más información, consulta Prueba los cambios en las políticas de la organización con Policy Simulator.
    10. Para aplicar la política de la organización en modo de ejecución de prueba, haz clic en Establecer política de ejecución de prueba. Para obtener más información, consulta Crea una política de la organización en modo de ejecución de prueba.
    11. Después de verificar que la política de la organización en el modo de ejecución de prueba funciona según lo previsto, haz clic en Establecer política para establecer la política activa.

    gcloud

    1. 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: 
      2.         name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
        spec:
          rules:
          - enforce: true
        
        dryRunSpec:
          rules:
          - enforce: true

      Reemplaza lo siguiente:

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

      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.

    3. Después de verificar que la política de la organización en modo de ejecución de prueba funcione según lo previsto, configura 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

      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

    Antes de comenzar, debes saber lo siguiente:

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

      Esto garantiza que todos los métodos CREATE y UPDATE en una base de datos de Firestore con compatibilidad con MongoDB cumplan con la restricción de que deleteProtectionState sea DELETE_PROTECTION_ENABLED. Como resultado, se rechazan todas las operaciones de creación, actualización, restablecimiento o clonación de bases de datos sin habilitar explícitamente la Protección contra eliminación.

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

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

    Prueba la política

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

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

    Esta es la salida:

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

    Prueba y analiza los cambios en la política de la organización

    Te recomendamos que pruebes todos los cambios en las políticas de la organización y realices una ejecución de prueba para comprender mejor el estado de tu entorno y cómo lo afectan los cambios.

    Policy Simulator de la organización te ayuda a comprender 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 incumplimientos antes de que se apliquen en tu entorno de producción. Para obtener instrucciones detalladas, consulta Prueba los cambios en las políticas de la organización con Policy Simulator.

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

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

    En esta tabla, se brindan ejemplos de sintaxis para algunas restricciones personalizadas comunes.

    Descripción Sintaxis de la restricción
    Los nombres de las bases de datos deben seguir un patrón determinado. Ten en cuenta que el formato de un nombre de base de datos en las políticas de la organización personalizadas es projects/project-id/databases/database-id, mientras que solo se especifica database-id en las operaciones de administración de bases de datos. 
    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 permitas la creación de bases de datos, a menos que esté habilitada 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 encriptación administrada 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 compatibles con Firestore con compatibilidad con MongoDB

    En la siguiente tabla, se enumeran los recursos de Firestore con compatibilidad con MongoDB a los que puedes hacer referencia 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

    ¿Qué sigue?