Como implantar a configuração do Endpoints

Depois de configurar o arquivo .proto e o arquivo de configuração da API gRPC, é preciso implantá-los para dar ao Cloud Endpoints as informações necessárias para gestão da API. Use o comando gcloud endpoints services deploy para implantar a configuração do Endpoints. Esse comando usa a Service Infrastructure, a plataforma de serviços fundamentais do Google. Ela é usada pelo Endpoints e por outros serviços para criar e gerenciar APIs e serviços. Nesta página, você encontrará instruções sobre como implantar seus arquivos de configuração no Endpoints.

Pré-requisitos

Como ponto de partida nesta página, presume-se o seguinte:

Como preparar o SDK do Cloud para implantação

A ferramenta de linha de comando gcloud é utilizada para implantar a configuração. Consulte a Referência do gcloud para mais informações sobre os comandos.

Para se preparar para a implantação:

  1. Instale e inicialize o Cloud SDK.
  2. Atualize o Cloud SDK:
    gcloud components update
    
  3. Verifique se o Cloud SDK tem autorização para acessar seus dados e serviços:
    gcloud auth login
    

    Uma nova guia do navegador será aberta, e você precisará escolher uma conta.

  4. Defina o projeto padrão. Substitua [YOUR-PROJECT-ID] pelo código do projeto do GCP.
    gcloud config set project [YOUR-PROJECT-ID]
    
  5. Se você estiver implantando o back-end da API para o Kubernetes ou Kubernetes Engine, execute o comando a seguir para receber novas credenciais de usuário para o Application Default Credentials. As credenciais do usuário são necessárias para autorizar o kubectl.
    gcloud auth application-default login
    Uma nova guia do navegador será aberta, e você precisará escolher uma conta.

Como implantar arquivos de configuração

  1. Certifique-se de que você está no diretório onde os arquivos api_descriptor.pb e api_config.yaml estão localizados.
  2. Confirme se o projeto padrão usado atualmente pela ferramenta de linha de comando gcloud é o projeto do GCP em que você quer implantar a configuração do Endpoints. Valide o código do projeto retornado do comando a seguir para garantir que o serviço não seja criado no projeto incorreto.
    gcloud config list project
    

    Se você precisar alterar o projeto padrão, execute o comando:

    gcloud config set project YOUR_PROJECT_ID
    
  3. Implante os arquivos de proto descriptor e de configuração usando a ferramenta de linha de comando gcloud:
    gcloud endpoints services deploy api_descriptor.pb api_config.yaml
    

    Durante a criação e a configuração do serviço, o Service Management envia informações ao terminal. Quando a configuração do serviço é concluída, o Service Management envia o código de configuração e o nome do serviço, semelhante ao seguinte:

    Service Configuration [2017-02-13r0] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
    

    No exemplo acima, 2017-02-13r0 é o código de configuração do serviço, e bookstore.endpoints.example-project.cloud.goog é o nome do serviço. O código de configuração do serviço consiste em um carimbo de data e um número de revisão. Se você implantar novamente a configuração do Endpoints no mesmo dia, o número de revisão será alterado no código da configuração do serviço.

Se a configuração do serviço estiver em vários arquivos YAML, você poderá passar todos eles para o comando deploy. Por exemplo, a configuração básica do Bookstore está em api_config.yaml, mas você pode ativar a transcodificação HTTP para o serviço implantando também api_config_http.yaml, que tem configuração adicional para este recurso:

gcloud endpoints services deploy api_descriptor.pb api_config.yaml api_config_http.yaml

Observe que, se houver valores conflitantes nos seus arquivos YAML, os valores no arquivo especificado por último substituirão os demais. Para saber mais sobre como o Endpoints processa a mesclagem de vários arquivos YAML, consulte Como configurar um serviço da API gRPC.

Se você receber uma mensagem de erro, consulte Como solucionar problemas de implantação na configuração do Endpoints.

Reimplantação

Sempre que fizer mudanças no arquivo .proto ou no arquivo YAML de configuração do serviço, implante-os novamente para que a versão mais recente da configuração do serviço da API esteja disponível para o Extensible Service Proxy (ESP). Se você já tiver implantado o ESP com a opção rollout definida como managed, não precisará reiniciá-lo ou reimplementá-lo. A opção rollout=managed configura o ESP para usar a configuração do serviço implantada mais recente. Ao especificar essa opção, a alteração é detectada pelo ESP em até um minuto após a implantação de uma nova configuração do serviço e começa a ser usada automaticamente. Recomendamos especificar essa opção em vez de um código de configuração específico para uso do ESP.

Após a implantação inicial da configuração do Endpoints, é possível conceder a um usuário, conta de serviço ou grupo um papel que permita a reimplantação da configuração do Endpoints. Consulte Como conceder e revogar o acesso à API para mais informações.

A seguir

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Cloud Endpoints com gRPC
Precisa de ajuda? Acesse nossa página de suporte.