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.

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 del processo, ma fornisce anche panoramica e link aggiuntivi per saperne di più. Usa questa pagina per avere una visione generale del processo di aggiunta di un'API, ma fare riferimento alle documentazione dettagliata per istruzioni passo passo.

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

Deployment Manager ha determinate aspettative nei confronti di qualsiasi API che tenti di vi si integrano. In particolare:

  • Deployment Manager si aspetta un'API RESTful. In altre parole, l'API espone un'interfaccia simile a REST con metodi Create, Read, Update ed Delete (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 effettua una richiesta HTTP per ottenere il documento descrittore di un'API, in modo che il documento deve essere ospitato in un luogo accessibile a Deployment Manager. Il documento devono essere disponibili pubblicamente o protetti dall'autenticazione di base.
  • Come già detto, l'API prevede l'autenticazione di base se l'API è in esecuzione su Google Kubernetes Engine o Google Cloud Endpoints, l'API supporta l'autenticazione OAuth 2.0 mediante un token di accesso l'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 Requisiti delle API documentazione.

Aggiunta della tua 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. Se aggiungi un'API come provider dei tipi, tutte le risorse di quell'API vengono esposte al deployment Manager e consente agli utenti di creare, aggiornare o eliminare tali risorse con 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 assegnato al tuo provider dei tipi il nome example-directory-api e 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 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