Gestionar unidades de cliente

En esta página se explica cómo gestionar unidades de arrendamiento de tu servicio. Una unidad de cliente es un recurso ligero que representa la relación entre un usuario de servicio y un servicio gestionado. Cada consumidor de servicios solo puede tener una unidad de arrendamiento activa para un servicio gestionado. Esta es una función proporcionada por la infraestructura de servicios.

El nombre de recurso de una unidad de arrendamiento tiene el siguiente formato:

services/{your service name}/projects/{consumer project number}/tenancyUnits/{id}

El ID de una unidad de arrendamiento se genera automáticamente cuando la creas. También puedes proporcionar un ID cuando llames al método services.tenancyUnits.create. Si proporciona un ID, debe ser único a nivel global en el ámbito de su servicio gestionado en todos los consumidores de servicios.

En los ejemplos de esta página se usan llamadas directas a la API REST de Service Consumer Management. Para el uso en producción, te recomendamos que utilices bibliotecas de cliente proporcionadas por Google para mejorar la usabilidad y la fiabilidad.

Antes de empezar

  • La API Service Consumer Management se ha diseñado para usarla con servicios gestionados y proyectos de productores de servicios. Ya debes tener un proyecto y un servicio gestionado (como un servicio creado con Cloud Endpoints) en ese proyecto. Google Cloud
  • Para usar unidades de cliente, la API Service Consumer Management debe crear proyectos de cliente en tu organización de productor de servicios. Asegúrate de que tienes suficiente cuota para el número necesario de proyectos de inquilino para los consumidores de tu servicio.
  • Para crear y eliminar unidades de cliente, sigue las instrucciones de configuración inicial que se indican en el artículo Primeros pasos con la API Service Consumer Management.
  • Cada proyecto de arrendatario creado en una unidad de arrendamiento también debe estar en una carpeta que especifiques como parte de la configuración del proyecto de arrendatario. Por este motivo, necesitas una organización para usar unidades de arrendamiento.

Autenticación

Select the tabs for how you plan to access the API:

gcloud

Instala Google Cloud CLI. Después de la instalación, inicializa la CLI de Google Cloud ejecutando el siguiente comando: 

gcloud init

Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

Bibliotecas de cliente

Para usar bibliotecas de cliente en un entorno de desarrollo local, instala e inicializa la CLI de gcloud y, a continuación, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.

    Instala Google Cloud CLI.

    Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

    If you're using a local shell, then create local authentication credentials for your user account: 

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

    If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Para obtener más información, consulta Configurar ADC en un entorno de desarrollo local en la documentación de autenticación Google Cloud .

REST

Para usar la API REST en un entorno de desarrollo local, debes usar las credenciales que proporciones a la CLI de gcloud.

    Instala Google Cloud CLI.

    Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

Para obtener más información, consulta el artículo Autenticarse para usar REST de la documentación sobre autenticación de Google Cloud .

Para obtener información sobre cómo configurar la autenticación en un entorno de producción, consulta Set up Application Default Credentials for code running on Google Cloud en la documentación sobre autenticación. Google Cloud

Crear una unidad de cliente

Las unidades de arrendamiento y los proyectos de arrendatario que contienen se suelen crear cuando se crean recursos en tu servicio que dependen de recursos adicionales de Google Cloud que se deben aprovisionar para los consumidores.

Para crear una unidad de arrendamiento, usa el método services.tenancyUnits.create:

POST https://serviceconsumermanagement.googleapis.com/v1/services/service.example.com/projects/12345678901/tenancyUnits

En este caso, "projects/12345678901" representa al consumidor del servicio y service.example.com es el nombre de tu servicio.

La estructura de datos devuelta tiene el nombre de la unidad de arrendamiento, con un ID único generado que se puede usar para acceder a ella. En este ejemplo, el nombre generado es services/your-service.example.com/projects/12345678901/tenancyUnits/absdef.

Añadir un proyecto de cliente

Ahora puedes añadir un proyecto al usuario. Para añadir un nuevo proyecto de arrendatario a la unidad de arrendamiento que has creado en el paso anterior, usa el método services.tenancyUnits.addProject:

POST https://serviceconsumermanagement.googleapis.com/v1/services/your-service.example.com/projects/12345678901/tenancyUnits/absdef:addProject

con los siguientes datos:

{"tag":"tag1", "project_config":{"folder":"folders/9876543210", "tenant_project_policy":{"policy_bindings":{"role":"roles/owner", "members":"user:bob@example.com"}}, "billing_config":{"billing_account":"billingAccounts/123456-472F22-28F9AA"}}}

El valor de tag es un identificador que asignas al proyecto en la unidad de arrendamiento. Puede ser cualquier valor (en este caso, tag1), como una región, una red de consumidores o un ID de cadena.

Esta llamada devuelve una operación de larga duración que puedes consultar para saber si el proyecto se ha creado correctamente.

Si necesitas aplicar otra configuración, por ejemplo, para añadir nuevos servicios gestionados, puedes llamar al método services.tenancyUnits.applyProjectConfig.

Buscar unidades de cliente

Buscar una unidad de cliente de un consumidor de un servicio

Para encontrar una unidad de arrendamiento de un consumidor de servicios concreto, usa el método services.tenancyUnits.list y especifica el número de proyecto del consumidor de servicios:

GET https://serviceconsumermanagement.googleapis.com/v1/services/your-service.example.com/projects/12345678901/tenancyUnits

Permiso para buscar unidades de cliente.

Puedes usar el método services.search para buscar unidades de cliente definidas para tu servicio. Por ejemplo, la siguiente consulta devolverá todas las unidades que contengan un proyecto con la etiqueta "tag1":

GET https://serviceconsumermanagement.googleapis.com/v1/services/your-service.example.com:search?query=tenant_resources.tag=tag1

Limpiar unidades de cliente

Cuando un consumidor de servicios deja de usar tu servicio, debes eliminar su unidad de arrendamiento para liberar recursos y asegurarte de que se eliminen los datos del usuario.

Quitar proyectos de un cliente

Para eliminar una unidad de arrendamiento, primero debes eliminar todos los proyectos de arrendatario. Debes usar el método services.tenancyUnits.removeProject para eliminar un proyecto de arrendatario y todos los recursos que contenga:

POST https://serviceconsumermanagement.googleapis.com/v1/services/your-service.example.com/projects/12345678901/tenancyUnits/absdef:removeProject

Eliminar una unidad de cliente

Una vez que hayas eliminado todos los proyectos de inquilino de una unidad de arrendamiento o todos estén en el estado DELETED, puedes eliminar la unidad de arrendamiento con el método services.tenancyUnits.delete:

DELETE https://serviceconsumermanagement.googleapis.com/v1/services/your-service.example.com/projects/12345678901/tenancyUnits/absdef