Como integrar ao Deployment Manager

Com o Deployment Manager, é possível registrar a API de terceiros usando o próprio serviço. Após registrá-la como provedor de tipos, você pode implantar os recursos desta API como tipos na configuração.

Este guia de uma página descreve o processo de integração de APIs de terceiros com o Deployment Manager. Esta página não contém instruções detalhadas sobre todas as etapas do processo. Ela fornece uma visão geral e links adicionais para você acessar mais informações. Leia este guia para ter um entendimento geral do processo de adição de APIs, mas consulte a documentação detalhada para instruções passo a passo.

Como determinar se uma API é qualificada para integração com o Deployment Manager

O Deployment Manager exige alguns requisitos das APIs que tentam se integrar a ele. Em especial:

  • A API precisa ser RESTful. Ou seja, a API precisa expor uma interface de tipo REST com os métodos criar, ler, atualizar e excluir (CRUD, na sigla em inglês).
  • Todos os parâmetros de caminho e consulta devem ser resolvidos com sucesso. É necessário que todos os parâmetros de caminho e consulta da API existam como parte do corpo do recurso ou em todos os métodos da API, para que o Deployment Manager faça a correspondência correta com o parâmetro quando o usuário o fornece.
  • O ponto de extremidade do documento descritor da API precisa estar acessível. O Deployment Manager faz uma solicitação HTTP para conseguir o documento descritor da API. Portanto, é necessário que o documento esteja hospedado em algum lugar que o Deployment Manager consegue acessar. É essencial que o documento esteja disponível publicamente ou protegido por autenticação básica.
  • Com relação ao ponto anterior, a API precisa ter autenticação básica. APIs executadas no Google Kubernetes Engine ou no Google Cloud Endpoints oferecem suporte para autenticação por OAuth 2.0 com token de acesso da conta de serviço do projeto. Leia mais sobre autenticação.
  • Se a API for complexa, talvez seja necessário configurar outras opções para explicar ao Deployment Manager como lidar com os comportamentos menos óbvios da API.

Para mais informações, leia a documentação sobre os requisitos de API.

Como adicionar uma API ao Deployment Manager

Após determinar que a API atende aos requisitos acima, adicione-a como um recurso de provedor de tipos. É necessário fornecer um documento de descritor da API e, opcionalmente, qualquer outra opção de API usando as opções avançadas. A adição de uma API como um provedor de tipos expõe todos os recursos dessa API ao Deployment Manager, além de permitir que os usuários criem, atualizem ou excluam esses recursos usando o Deployment Manager.

Se a API tiver padrões sutis que talvez não sejam reconhecidos facilmente, será necessário fornecer também mapeamentos de entrada ao Deployment Manager, para que ele trate as solicitações de API de modo adequado. Para mais informações, leia Opções avançadas da API.

Como chamar um provedor de tipos nos arquivos de configuração

Depois de registrar a API no Deployment Manager, é possível criar recursos de API chamando-os como um tipo na configuração.

Por exemplo, se você tiver nomeado um provedor de tipos example-directory-api e quiser criar um recurso de API conhecido como person, é possível especificar o tipo nas suas configurações da seguinte maneira:

resources:
- name: Jane
  type: my-project/example-directory-api:person
  properties:
  - name: Jane
    website: www.example.com
    ...

Para comparar, é o mesmo processo usado para chamar uma API do Google e criar um recurso de API:

resource:
- name: example-instance
  type: compute.v1.instance
  properties:
  - machineType: n1-standard-1
    ...

A seguir