Provisionar o hub da API

Esta página se aplica à Apigee e à Apigee híbrida.

Neste tópico, descrevemos como provisionar o hub de APIs usando a interface da Apigee no console do Google Cloud. Esse é o método recomendado para provisionar o hub de API. A Figura 1 destaca as etapas básicas descritas neste documento de provisionamento.

Figura 1. Etapas para provisionar uma instância do hub de APIs da Apigee.

Antes de começar

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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

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

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

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

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

6. Make sure that you have the following role or roles on the project:

   • roles/serviceusage.serviceUsageAdmin
   • roles/cloudkms.admin
   • roles/apihub.provisioningAdmin
   • roles/resourcemanager.projectIamAdmin

   Check for the roles

   1. In the Google Cloud console, go to the IAM page.

      Go to IAM
   2. Select the project.

   3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

   4. For all rows that specify or include you, check the Role colunn to see whether the list of roles includes the required roles.

   Grant the roles

   1. In the Google Cloud console, go to the IAM page.

      Acessar o IAM
   2. Selecionar um projeto.
   3. Clique em CONCEDER ACESSO.

   4. No campo Novos principais, insira seu identificador de usuário. Normalmente, é o endereço de e-mail de uma Conta do Google.

   5. Na lista Selecionar um papel, escolha um.
   6. Para conceder outros papéis, clique em Adicionar outro papel e adicione cada papel adicional.
   7. Clique em Salvar.

   Resumo das etapas

   As etapas de provisionamento são as seguintes:

   1. Etapa 1: ativar APIs A Apigee exige que você ative algumas APIs do Google Cloud.
   2. Etapa 2: escolher um local de hospedagem Especifique o local físico do hub da API.
   3. Etapa 3: registrar um projeto host O projeto atual do Google Cloud é selecionado por padrão.
   4. Etapa 4: Configurar criptografia. Selecione ou crie uma chave de criptografia gerenciada pelo cliente (CMEK) ou use uma chave de criptografia gerenciada pelo Google (GMEK) para criptografar e descriptografar os dados da API em repouso.
   5. Etapa 5: criar uma identidade de serviço Atribua permissões de acesso a uma identidade de serviço.
   6. Crie sua instância do hub de API. O provisionamento leva alguns minutos para ser concluído.

   Etapas de provisionamento

   Para iniciar o provisionamento do hub de API:

   1. Verifique se você atendeu aos pré-requisitos descritos em Antes de começar.

   2. No console do Google Cloud, acesse a página inicial do hub de APIs da Apigee.

      Acessar o hub de APIs da Apigee

   3. Clique em Criar instância.
      • Se o hub de API não estiver provisionado na sua organização, a interface vai mostrar a Etapa 1 do fluxo de trabalho de provisionamento.
      • Se o hub de APIs já tiver sido provisionado, você vai acessar a página de recursos da API.

   Etapa 1: APIs

   Para provisionar o hub de API, ative as seguintes APIs no seu projeto do Google Cloud:

   Nome da API	Local	Descrição
   Hub de API da API	apihub.googleapis.com	Hub de API da API.
   Cloud Key Management Service (KMS)	cloudkms.googleapis.com	Gerencia chaves e executa operações criptográficas para uso direto por outros recursos de nuvem.

   Para ativar as APIs, clique em Ativar APIs. Essa etapa leva segundos para ser concluída.

   Etapa 2: local

   Você precisa selecionar dois locais: primeiro, o local físico (região) em que quer hospedar a instância do hub de APIs da Apigee e, em seguida, o local multirregional em que os dados da Vertex AI para Pesquisa serão armazenados:

   1. Na lista suspensa, selecione a região em que você quer hospedar a instância do hub de APIs. Os locais aceitos incluem:

      Descrição da região	Nome da região
      Iowa	us-central1
      Norte da Virgínia	us-east4
      Oregon	us-west1
      Bélgica	europe-west1
      Londres	europe-west2
      Singapura	asia-southeast1
      Mumbai	asia-south1
      São Paulo	southamerica-east1
      Sydney	australia-southeast1

   2. Se a opção Ativar o recurso de pesquisa da Vertex estiver ativada (padrão), selecione o local multirregional para armazenar os dados de pesquisa baseados na Vertex AI, que são os dados associados ao recurso Pesquisa semântica do hub de APIs. Por padrão, o local multirregional que inclui a região do hub de APIs definida na etapa 1 é selecionado. Por exemplo, se você selecionar us-central1 como a região do hub de APIs, o local multirregional us será selecionado por padrão. No entanto, você tem a opção de mudar para outro local multirregional.

      A opção de pesquisa da Vertex ativa o recurso de pesquisa semântica da Vertex AI no hub de APIs. Se você desmarcar a opção Ativar recurso de pesquisa da Vertex, a pesquisa semântica será desativada e o seletor de local multirregional será ocultado.

   Observação: quando selecionada, a opção de pesquisa da Vertex provisiona automaticamente a Vertex AI em uma região do Google Cloud que existe no mesmo local multirregional que a região em que o hub de APIs está hospedado. Por exemplo, se você selecionar us-central1 como a região de hospedagem para o hub de APIs, a Vertex poderá ser provisionada em qualquer região no local multirregional us. Por exemplo, a Vertex pode ser provisionada em us-west1, us-west2, us-central2 ou outra região no local multirregional US.
   3. Clique em Definir local.

   Etapa 3: registrar o projeto host

   O projeto host é um projeto do Google Cloud na sua organização da Apigee que você designa como o projeto do consumidor para todos os recursos do hub da API. Só uma instância do hub de APIs pode ser provisionada por projeto host.

   Para usar o projeto do Google Cloud da sua organização da Apigee como o projeto host do hub da API, clique em Registro.

   Etapa 4: criptografia

   Nesta etapa, você pode usar uma chave de criptografia gerenciada pelo Google (GMEK) ou pelo cliente (CMEK) e definida no Cloud Key Management Service para criptografar os dados armazenados na instância do hub de APIs.

   Para usar uma chave de criptografia gerenciada pelo Google, selecione a opção Chave de criptografia gerenciada pelo Google. Quando você seleciona essa opção, nenhuma outra configuração de chave é necessária.

   Para usar uma CMEK atual:

   1. Na caixa Escolher uma chave de criptografia gerenciada pelo cliente (CMEK), digite para filtrar ou role para pesquisar a chave atual. Também é possível inserir o ID de recurso da chave para localizar uma chave.
   2. Selecione a chave e clique em OK.
   3. Clique em Confirmar.

   Para criar uma CMEK:

   1. Clique em Criar chave. A caixa de diálogo Criar uma nova chave é exibida.
   2. Na seção Keyring, especifique um keyring atual ou crie um novo.
      • Para usar um keyring atual:
        1. Selecione um keyring atual na lista Keyring.
        2. Clique em Continuar.
      • Para criar um keyring:
        1. Clique no botão Criar keyring ou em Criar keyring na caixa de seleção.
        2. No campo Nome do keyring, digite o nome do seu keyring.

           Os nomes de keyrings podem conter letras, números, sublinhados (_) e hífens (-). Os keyrings não podem ser renomeados ou excluídos.

        3. Selecione um local na lista Local do keyring.

           Esse local é restrito ao local de hospedagem escolhido na etapa anterior para garantir que a chave os dados permaneçam na mesma região.

        4. Clique em Continuar.
   3. Na seção "Chave":
      1. Insira um nome para a chave no campo Nome da chave.

         Os nomes das chaves podem conter letras, números, sublinhados (_) e hífens (-). Não é possível renomear ou excluir chaves.

      2. Selecione um Nível de proteção, por exemplo, Software.
      3. Clique em Continuar.
   4. Na seção Revisar, confirme os detalhes especificados para a criação da chave.

      Se as informações estiverem corretas, clique em Criar.

      Aviso: não é possível excluir chaves e keyrings após a criação. Para saber mais, consulte Por que não consigo excluir chaves ou keyrings?.
   5. Selecione a chave recém-criada na caixa Escolha uma chave de criptografia gerenciada pelo cliente.
   6. Clique em Confirmar chave de criptografia.

   Etapa 5: identidade do serviço

   Nesta etapa, você vai criar uma nova identidade de serviço e conceder a ela acesso à chave de criptografia gerenciada pelo cliente selecionada. Essa chave é usada para criptografar e descriptografar os dados do hub da API.

   Para criar uma nova identidade de serviço, clique em Criar identidade de serviço e conceder permissões.

   A Apigee cria uma conta de serviço e atribui os papéis cloudkms.cryptoKeyEncrypterDecrypter, apihub.admin e apihub.runtimeProjectServiceAgent a ela.

   Criar a instância do hub da API

   Clique em Enviar para criar a instância do hub da API.

   Quando o provisionamento começar, a página Finalização da instância do hub da API será exibida. Essa etapa leva alguns minutos para ser concluída.

   Quando o provisionamento terminar, a página APIs do hub da API vai aparecer.

   Observação : se você tiver provisionado um hub de API em um projeto com proxies da Apigee, eles serão registrados automaticamente no hub de APIs algumas horas após o provisionamento do hub da API. Por exemplo, se você estiver provisionar o hub de API em test-project-1 e o projeto tiver proxies da Apigee, o test-project-1 será anexado automaticamente como um projeto de ambiente de execução e os proxies no test-project-1 são registrados no hub de API.

   A seguir

   Parabéns! O hub de API foi provisionado.

   Agora você já pode começar a usar o hub de API:

   • Revise os papéis e permissões necessários para usar o Hub da API
   • Configure os atributos do hub de API:
     • Gerenciar atributos
     • Guia de início rápido: criar e editar atributos
   • Registrar um recurso de API:
     • Gerenciar recursos de API
     • Guia de início rápido: registrar uma API
   • Adicione uma versão da API:
     • Visão geral das versões
     • Guia de início rápido: criar uma versão da API