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 tua configurazione.

Questo documento è una guida di una pagina che descrive il processo di integrazione di un'API di terze parti con Deployment Manager. Questa pagina non contiene istruzioni complete per ogni passaggio della procedura, ma fornisce una panoramica e link aggiuntivi per ulteriori informazioni. Utilizza questa pagina per ottenere una visione generale del processo di aggiunta di un'API, ma fai riferimento alla documentazione dettagliata per istruzioni dettagliate.

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

Deployment Manager ha determinate aspettative nei confronti di qualsiasi API che tenti di integrarsi con l'API. In particolare:

  • Deployment Manager richiede un'API RESTful. In altre parole, l'API espone un'interfaccia di tipo REST con i metodi CRUD (Create, Read, Update ed Delete).
  • Tutti i parametri di ricerca e percorso vengono risolti correttamente. Tutti i percorsi e i parametri di query dell'API devono esistere come parte del corpo della risorsa o esistere in tutti i metodi dell'API, in modo che Deployment Manager possa trovare la corrispondenza del parametro quando viene fornito da un utente.
  • L'endpoint del documento del descrittore dell'API deve essere accessibile. Deployment Manager effettua una richiesta HTTP per ottenere il documento descrittore di un'API, quindi 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 l'API è 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 delle API meno ovvio.

Per ulteriori informazioni, leggi la documentazione relativa ai requisiti API.

Aggiungere l'API a Deployment Manager

Dopo aver determinato che la tua API soddisfa i requisiti sopra riportati, aggiungi l'API come risorsa provider dei tipi. Devi fornire un documento descrittore 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 tali risorse con Deployment Manager.

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

Chiamata a un provider di tipi nei file di configurazione

Dopo aver registrato un'API in Deployment Manager, puoi creare risorse API chiamando la risorsa API come tipo nella configurazione.

Ad esempio, se hai denominato il tuo provider di tipi example-directory-api e vuoi creare una risorsa API nota come person, puoi specificare il tipo nelle tue configurazioni in questo modo:

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

Per fare un confronto, questa è la stessa procedura utilizzata per chiamare un'API di Google e creare una risorsa API:

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

Passaggi successivi