Integrazione con Deployment Manager

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

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 fase del processo, ma fornisce una panoramica e link aggiuntivi per ulteriori informazioni. Utilizza questa pagina per ottenere una visione generale della procedura di aggiunta di un'API, ma consulta la documentazione dettagliata per istruzioni dettagliate.

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

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

  • Deployment Manager prevede un'API RESTful. Ciò significa che l'API espone un'interfaccia simile a REST con i metodi Create, Read, Update ed Delete (CRUD).
  • Tutti i parametri di percorso e query si sono risolti correttamente. Tutti i parametri di percorso e query dell'API devono esistere come parte del corpo della risorsa o esistere su tutti i metodi dell'API, in modo che Deployment Manager possa far corrispondere il parametro quando un utente lo fornisce.
  • L'endpoint del documento del descrittore API deve essere accessibile. Deployment Manager esegue una richiesta HTTP per ottenere un documento descrittore dell'API, in modo che il documento debba essere ospitato in un luogo accessibile da Deployment Manager. Il documento deve essere disponibile al pubblico o protetto dall'autenticazione di base.
  • Per quanto riguarda il punto precedente, l'API ha l'autenticazione di base oppure, se l'API è in esecuzione su Google Kubernetes Engine o Google Cloud Endpoints, l'API 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, potrebbe essere necessario configurare ulteriori opzioni per spiegare a Deployment Manager come gestire il comportamento meno ovvio delle API.

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

Aggiunta dell'API a Deployment Manager

Dopo aver stabilito che l'API corrisponde ai requisiti indicati in precedenza, aggiungi l'API come provider di 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 ha pattern API delicati che potrebbero non essere facilmente riconoscibili, dovrai anche fornire le mappature di input a Deployment Manager in modo che possa gestire correttamente le richieste API. Per informazioni, consulta la pagina Opzioni avanzate API.

Chiamata a un provider di tipi di file nei file di configurazione

Dopo aver registrato un'API con Deployment Manager, puoi creare risorse API chiamandola come tipo di 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 confrontare questa procedura, si tratta della 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