Integrazione con Deployment Manager

Deployment Manager offre la possibilità di registrare un'API di terze parti con il servizio Deployment Manager. Dopo aver registrato un'API come provider di tipi con Deployment Manager, puoi utilizzare Deployment Manager per eseguire il deployment delle risorse dall'API come tipi nella configurazione.

Questo documento è una guida di una pagina che descrive la procedura di integrazione di un'API di terze parti con Deployment Manager. Questa pagina non contiene istruzioni complete per ogni fase della procedura, ma fornisce una panoramica e link aggiuntivi per ulteriori informazioni. Utilizza questa pagina per avere una panoramica generale della procedura di aggiunta di un'API, ma consulta la documentazione dettagliata per istruzioni passo passo.

Determinare se un'API è idonea per l'integrazione con Deployment Manager

Deployment Manager ha determinate aspettative in merito a qualsiasi API che tenta di integrarsi con esso. In particolare:

  • Deployment Manager si aspetta un'API RESTful. In altre parole, l'API espone un'interfaccia simile a REST con i metodi Create, Read, Update ed Delete (CRUD).
  • Tutti i parametri di percorso e query vengono risolti correttamente. Tutti i parametri di percorso e query dell'API devono esistere nel corpo della risorsa o in tutti i metodi dell'API, in modo che Deployment Manager possa abbinare il parametro quando viene fornito da un utente.
  • L'endpoint del documento descrittore dell'API deve essere accessibile. Deployment Manager invia una richiesta HTTP per recuperare il documento descrittore di un'API, pertanto il documento deve essere ospitato in un luogo accessibile a Deployment Manager. Il documento deve essere disponibile pubblicamente o protetto dall'autenticazione di base.
  • In relazione al punto precedente, l'API dispone dell'autenticazione di base oppure, se è in esecuzione su Google Kubernetes Engine o Google Cloud Endpoints, supporta l'autenticazione OAuth 2.0 utilizzando un token di accesso dell'account di servizio del progetto. Scopri di più sull'autenticazione.
  • Se la tua API è complessa, potresti dover configurare opzioni aggiuntive per spiegare a Deployment Manager come gestire il comportamento meno evidente dell'API.

Per ulteriori informazioni, consulta la documentazione relativa ai requisiti dell'API.

Aggiunta dell'API a Deployment Manager

Dopo aver stabilito che l'API soddisfa i requisiti precedenti, aggiungi l'API come risorsa Type Provider. Devi fornire un documento descrittore dell'API e, facoltativamente, eventuali opzioni API aggiuntive utilizzando le opzioni avanzate. L'aggiunta di un'API come provider di tipi espone tutte le risorse dell'API a Deployment Manager e consente agli utenti di creare, aggiornare o eliminare queste risorse con Deployment Manager.

Se la tua API presenta pattern sottili che potrebbero non essere facilmente riconoscibili, devi anche fornire le mappature di input a Deployment Manager in modo che possa gestire correttamente le richieste dell'API. Per informazioni, consulta Opzioni API avanzate.

Chiamata di un provider di tipi nei file di configurazione

Una volta registrata un'API in Deployment Manager, puoi creare risorse API chiamando la risorsa API come tipo nella configurazione.

Ad esempio, se hai chiamato il provider di tipi example-directory-api e vuoi creare una risorsa API nota come person, puoi specificare il tipo nelle configurazioni come segue:

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

Per fare un paragone, si tratta della stessa procedura di chiamata di un'API Google e creazione di una risorsa API:

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

Passaggi successivi