Como gerenciar unidades de locação

Esta página mostra como gerenciar unidades de locação para seu serviço. Uma unidade de locação é um recurso leve que representa a relação entre um consumidor de serviço e um serviço gerenciado. Cada consumidor de serviço pode ter apenas uma unidade de locação ativa para um serviço gerenciado. Esse é um recurso fornecido pela infraestrutura de serviços.

O nome do recurso de uma unidade de locação tem este formato:

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

O ID de uma unidade de locação é gerado automaticamente quando você a cria. Também é possível fornecer um ID ao chamar o método services.tenancyUnits.create. Se você fornecer um ID, ele precisará ser globalmente exclusivo no escopo do serviço gerenciado entre todos os consumidores de serviço.

Os exemplos nesta página usam chamadas diretas para a API REST da Gestão de consumidores de serviço. Para uso em produção, recomendamos o uso de bibliotecas de cliente fornecidas pelo Google para melhorar a usabilidade e a confiabilidade.

Antes de começar

  • A API Service Consumer Management destina-se ao uso com serviços gerenciados e projetos de produtor de serviço. Você precisa já ter um projeto do Google Cloud e um serviço gerenciado (como um serviço criado usando o Cloud Endpoints) nesse projeto.
  • Para usar unidades de locação, a API Service Consumer Management precisa criar projetos de locatário na sua organização de produtores de serviço. Verifique se você tem cota suficiente para o número necessário de projetos de locatário para os consumidores do seu serviço.
  • Cada projeto de locatário criado em uma unidade de locação precisa estar também em uma pasta especificada como parte da configuração do projeto de locatário. Por isso, você precisa de uma organização para usar unidades de locação.

Autenticação

As APIs do Cloud, como a API Service Consumer Management, só aceitam chamadas autenticadas. Se você ainda não tem uma, acesse Primeiros passos na autenticação e descubra como criar uma conta de serviço e conseguir uma chave JSON para autenticar as APIs do Cloud. Se você estiver usando uma biblioteca de cliente do Google, poderá configurar seu ambiente para que ele use as credenciais da sua conta de serviço por padrão. Para chamadas diretas à API REST, será preciso fornecer um token de acesso em cada cabeçalho, como no exemplo a seguir:

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" --header 'Content-Type: application/json' --data '{"tag":"tag1", "project_config":{"folder":"folders/9876543210", "tenant_project_policy": {"policy_bindings":{"role":"roles/owner", "members":"user:user1@company.com"}}, "billing_config":{"billing_account":"billingAccounts/123456-472F22-28F9AA"}}}' -X POST "https://serviceconsumermanagement.googleapis.com/v1/services/your-service.example.com/consumers/12345678901/tenancyUnits/tu-hello:addProject"

Para criar e excluir unidades de locação, você precisa seguir as instruções de configuração iniciais em Primeiros passos com a API Service Consumer Management.

Como criar uma unidade de locação

As unidades de locação e os projetos de locatário normalmente são criados quando são criados recursos no seu próprio serviço que dependem de outros recursos do Google Cloud a serem provisionados para os consumidores.

É possível criar uma unidade de locação da seguinte forma:

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

Aqui, "projects/12345678901" representa o consumidor de serviço, e service.example.com é o nome do serviço.

A estrutura de dados retornada tem o nome da unidade de locação, com um código exclusivo gerado que pode ser usado para acessá-la. Neste exemplo, o nome gerado é services/your-service.example.com/projects/12345678901/tenancyUnits/absdef.

Como adicionar um projeto de locatário

Agora você pode adicionar um projeto para o usuário. Para adicionar um novo projeto de locatário à unidade de locação criada na etapa anterior, chame o seguinte método:

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

com os seguintes dados:

{"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"}}}

O valor tag é um identificador que você fornece para o projeto na unidade de locação. Pode ser o que você quiser (aqui é tag1), como uma região, uma rede de consumidores ou apenas um ID de string.

Essa chamada retorna uma operação de longa duração que pode ser consultada para verificar se a criação do projeto foi bem-sucedida.

Se você precisar aplicar uma configuração diferente, por exemplo, para adicionar novos serviços gerenciados, poderá chamar o método services.tenancyUnits.applyProjectConfig.

Como procurar suas unidades de locação

Encontrar uma unidade de locação para um consumidor de serviço

Para localizar uma unidade de locação para um consumidor de serviço específico, use o método services.tenancyUnits.ListTenancyUnits, especificando o número do projeto do consumidor de serviço:

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

Pesquisar unidades de locação

Use o método services.tenancyUnits.SearchTenancyUnits para procurar unidades de locação definidas para o serviço. Por exemplo, a seguinte consulta retornará todas as unidades que têm um projeto com a tag "tag1".

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

Como limpar unidades de locação

Quando um consumidor de serviço para de usar seu serviço, você precisa remover a unidade de locação para liberar recursos e garantir que os dados do usuário sejam excluídos.

Remover projetos de locatário

Você precisa excluir todos os projetos de locatário antes de excluir a unidade de locação correspondente. Use o método services.tenancyUnits.removeProject para excluir um projeto de locatário e todos os recursos nele:

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

Excluir uma unidade de locação

Depois de excluir todos os projetos de locatário em uma unidade de locação ou quando todos eles estiverem no estado DELETED, exclua a unidade de locação:

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