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 fornitore 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 il processo 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 ottenere una panoramica generale della procedura per aggiungere 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 per qualsiasi API che tenti di integrarsi con esso. In particolare:

  • Deployment Manager prevede un'API RESTful. ovvero espone un'interfaccia simile a REST con metodi di creazione, lettura, aggiornamento ed eliminazione (CRUD).
  • Tutti i parametri di percorso e query vengono risolti correttamente. Tutti i parametri di percorso e query dell'API devono esistere come parte del corpo della risorsa o in tutti i metodi dell'API, in modo che Deployment Manager possa trovare la corrispondenza del parametro quando un utente lo fornisce.
  • L'endpoint del documento descrittore dell'API deve essere accessibile. Deployment Manager invia una richiesta HTTP per ottenere il documento descrittore di un'API, quindi il documento deve essere ospitato in una posizione accessibile a Deployment Manager. Il documento deve essere disponibile pubblicamente o protetto da autenticazione di base.
  • In relazione al punto precedente, l'API ha l'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 dal 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 ovvio dell'API.

Per saperne di più, leggi la documentazione Requisiti API.

Aggiunta dell'API a Deployment Manager

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

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

Chiamata di un provider di tipi nei file di configurazione

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

Ad esempio, se hai chiamato il tuo provider di tipi example-directory-api e vuoi creare una risorsa API nota come person, puoi specificare il tipo nelle configurazioni nel seguente 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 per chiamare un'API Google e creare una risorsa API:

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

Passaggi successivi