Se usó la API de Cloud Translation para traducir esta página.

Administra recursos de Firestore con restricciones 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 :

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

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 la 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

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.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

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

To initialize the gcloud CLI, run the following command:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

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

To initialize the gcloud CLI, run the following command:

gcloud init

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.deleteProtectionRequired. 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, firestore.googleapis.com/Database.
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.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\"".
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

gcloud org-policies set-custom-constraint

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

CONSTRAINT_PATH

/home/user/customconstraint.yaml

gcloud org-policies list-custom-constraints

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

ORGANIZATION_ID

Visualiza las políticas de la organización

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

Console

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
En el selector de proyectos, selecciona el proyecto para el que deseas configurar la política de la organización.
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.
Si deseas configurar las políticas de la organización para este recurso, haz clic en Administrar política.
En la página Editar política, selecciona Anular la política del elemento superior.
Haz clic en Agregar una regla.
En la sección Aplicación, selecciona si la aplicación de esta política de la organización está activada o desactivada.
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.
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.
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.deleteProtectionRequired

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

Antes de comenzar, debes saber lo siguiente:

El ID de tu organización

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

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 y ejecutes todos los cambios en tus políticas de la organización para comprender mejor el estado de tu entorno y cómo lo afectan los cambios.

Policy Simulator para políticas 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 la siguiente tabla, se proporciona la sintaxis de algunas restricciones personalizadas para casos de uso 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 ser del tipo especificado.	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.typeFirestore resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.type=="FIRESTORE_NATIVE"" actionType: ALLOW displayName: Firestore database type Firestore_Native description: Only allow creation and updating of databases if the type is Firestore in native mode.
Las bases de datos deben usar el modo de simultaneidad especificado.	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.concurrencyNotPessimistic resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.concurrencyMode == 'PESSIMISTIC'" actionType: DENY displayName: Firestore database concurrencyMode not pessimistic description: Disallow the creation and updating of databases with pessimistic concurrency mode.
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.
Las bases de datos deben usar el modo de integración de App Engine especificado.	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.enableAppEngineIntegrationMode resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.appEngineIntegrationMode == 'ENABLED'" actionType: ALLOW displayName: Firestore Database App Engine integration mode enabled description: Only allow the creation and updating of databases with App Engine Integration Mode 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 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".

Recursos compatibles con Firestore

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?

Obtén más información sobre el Servicio de políticas de la organización.
Obtén más información para crear y administrar políticas de la organización.
Consulta la lista completa de restricciones de políticas de la organización administradas.