Integração com o Deployment Manager

O Deployment Manager oferece a capacidade de registar uma API de terceiros no serviço do Deployment Manager. Depois de registar uma API como um fornecedor de tipos com o Deployment Manager, pode usar o Deployment Manager para implementar recursos da API como tipos na sua configuração.

Este documento é um guia de uma página que descreve o processo de integração de uma API de terceiros com o Deployment Manager. Esta página não contém instruções abrangentes para cada passo do processo, mas fornece uma vista geral e links adicionais para mais informações. Use esta página para ter uma vista geral do processo de adição de uma API, mas consulte a documentação detalhada para obter instruções passo a passo.

Determinar se uma API é elegível para integração com o Gestor de implementações

O Gestor de implementação tem determinadas expetativas em relação a qualquer API que tente integrar-se com ele. Em concreto:

  • O Deployment Manager espera uma API RESTful. Ou seja, a API expõe uma interface semelhante a REST com métodos de criação, leitura, atualização e eliminação (CRUD).
  • Todos os parâmetros de caminho e de consulta são resolvidos com êxito. Todos os parâmetros de caminho e de consulta da API têm de existir como parte do corpo do recurso ou existir em todos os métodos da API, para que o Deployment Manager possa fazer corresponder o parâmetro quando um utilizador o fornece.
  • O ponto final do documento descritor da API tem de estar acessível. O Deployment Manager faz um pedido HTTP para obter o documento descritor de uma API, pelo que o documento tem de estar alojado num local acessível ao Deployment Manager. O documento tem de estar disponível publicamente ou protegido por autenticação básica.
  • Relativamente ao ponto anterior, a API tem autenticação básica ou, se a API estiver a ser executada no Google Kubernetes Engine ou nos Google Cloud Endpoints, a API suporta a autenticação OAuth 2.0 através de um token de acesso da conta de serviço do projeto. Leia mais acerca da autenticação.
  • Se a sua API for complexa, pode ter de configurar opções adicionais para explicar ao Deployment Manager como processar o comportamento menos óbvio da API.

Para mais informações, leia a documentação Requisitos da API.

Adicionar a sua API ao Deployment Manager

Depois de determinar que a sua API corresponde aos requisitos acima, adicione a API como um recurso de fornecedor de tipos. Tem de fornecer um documento descritor da API e, opcionalmente, quaisquer opções adicionais da API através de opções avançadas. Adicionar uma API como um fornecedor de tipos expõe todos os recursos dessa API ao Deployment Manager e permite que os utilizadores criem, atualizem ou eliminem esses recursos com o Deployment Manager.

Se a sua API tiver padrões de API subtis que podem não ser facilmente reconhecíveis, também tem de fornecer mapeamentos de entrada ao Deployment Manager para que possa processar corretamente os pedidos de API. Para mais informações, leia o artigo Opções avançadas da API.

Chamar um fornecedor de tipos em ficheiros de configuração

Assim que uma API estiver registada no Deployment Manager, pode criar recursos de API chamando esse recurso de API como um tipo na sua configuração.

Por exemplo, se tiver dado o nome example-directory-api ao seu fornecedor de tipos e quiser criar um recurso da API conhecido como person, pode especificar o tipo nas suas configurações da seguinte forma:

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

Para comparar, este é o mesmo processo que chamar uma API Google e criar um recurso da API:

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

O que se segue?