Integrazione con Deployment Manager

Deployment Manager offre la possibilità di registrare un'API di terze parti con servizio Deployment Manager. Dopo aver registrato un'API come tipo di fornitore con Deployment Manager, puoi usare Deployment Manager per eseguire il deployment l'API come tipi nella tua configurazione.

Il presente 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 avere una visione di alto livello 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. Ciò significa che l'API espone Interfaccia di tipo REST con i metodi di creazione, lettura, aggiornamento ed eliminazione (CRUD).
  • Tutti i percorsi e parametri di ricerca sono stati risolti correttamente. Tutti i percorsi e le query dell'API devono esistere come parte del corpo della risorsa o esistere in tutti metodi dell'API, in modo che Deployment Manager possa abbinare il parametro fornito dall'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 spiegare a Deployment Manager come gestire un comportamento delle API meno ovvio.

Per ulteriori informazioni, leggi il Requisiti delle API documentazione.

Aggiunta dell'API a Deployment Manager

Dopo aver stabilito che la tua API soddisfa i requisiti di cui sopra, aggiungi l'API come provider dei tipi risorsa. Devi fornire un documento descrittore API e, facoltativamente, qualsiasi le opzioni API aggiuntive 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 API non facilmente riconoscibili, dovrà anche fornire delle mappature di input a Deployment Manager gestire correttamente le richieste API. Per informazioni, leggi Opzioni API avanzate.

Chiamata a un provider di tipi nei file di configurazione

Dopo aver registrato un'API con Deployment Manager, puoi creare risorse API richiamando 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 della creazione di una risorsa API:

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

Passaggi successivi