Integration in Deployment Manager

Deployment Manager bietet die Möglichkeit, mit dem Deployment Manager-Dienst eine Drittanbieter-API zu registrieren. Nach der Registrierung einer API als Typanbieter in Deployment Manager können Sie Deployment Manager dazu verwenden, Ressourcen aus der API als Typen in Ihrer Konfiguration bereitzustellen.

Dieses Dokument ist eine kurze Anleitung, die den Prozess der Integration einer Drittanbieter-API mit Deployment Manager beschreibt. Diese Seite enthält keine ausführlichen Schritt-für-Schritt-Anleitungen zu diesem Prozess, sondern bietet einen Überblick und zusätzliche Links für weitere Informationen. Auf dieser Seite erhalten Sie eine detaillierte Übersicht zum Hinzufügen einer API. Schritt-für-Schritt-Anleitungen finden Sie in der umfangreichen Dokumentation.

Anforderungen zur Integration einer API mit Deployment Manager

Deployment Manager hat bestimmte Erwartungen an eine API, die integriert werden soll. Beispiele:

  • Deployment Manager erwartet eine RESTful API. Das heißt, die API stellt eine REST-ähnliche Schnittstelle mit CRUD-Methoden (Erstellen, Lesen, Aktualisieren, Löschen) bereit.
  • Alle Pfad- und Abfrageparameter lassen sich erfolgreich auflösen. Alle Pfad- und Abfrageparameter der API müssen als Teil des Ressourcentextes oder in allen API-Methoden vorhanden sein, sodass Deployment Manager den Parameter bei der Bereitstellung durch einen Nutzer zuordnen kann.
  • Der Endpunkt des API-Deskriptordokuments muss zugänglich sein. Deployment Manager führt eine HTTP-Anfrage aus, um das Deskriptordokument einer API abzurufen. Dies bedeutet, dass das Dokument an einem Ort gehostet sein muss, auf den Deployment Manager zugreifen kann. Das Dokument muss öffentlich zugänglich oder durch eine Basisauthentifizierung geschützt sein.
  • Die API kann entweder eine Basisauthentifizierung verwenden oder die Authentifizierung mit OAuth 2.0 unterstützen. Letzteres ist der Fall, wenn die API auf Google Kubernetes Engine oder Google Cloud Endpoints ausgeführt wird. Für die Authentifizierung wird dann ein Zugriffstoken vom Dienstkonto des Projekts verwendet. Weitere Informationen finden Sie unter Authentifizierung.
  • Wenn Ihre API komplex ist, müssen Sie unter Umständen zusätzliche Optionen konfigurieren und Deployment Manager mitteilen, wie mit weniger offensichtlichem API-Verhalten zu verfahren ist.

Weitere Informationen finden Sie unter API-Anforderungen.

API zu Deployment Manager hinzufügen

Nachdem sichergestellt ist, dass Ihre API den obigen Anforderungen entspricht, fügen Sie die API als Typanbieter hinzu. Sie müssen ein API-Deskriptordokument und können optional zusätzliche API-Optionen mit erweiterten Optionen angeben. Wenn Sie eine API als Typanbieter hinzufügen, werden alle Ressourcen dieser API im Deployment Manager bereitgestellt. Nutzer können diese Ressourcen nun mit Deployment Manager erstellen, aktualisieren oder löschen.

Wenn Ihre API komplizierte API-Muster verwendet, die nicht einfach erkennbar sind, müssen Sie eventuell Eingabezuordnungen für Deployment Manager bereitstellen, damit API-Anfragen korrekt verarbeitet werden können. Weitere Informationen finden Sie unter Erweiterte API-Optionen.

Typanbieter in Konfigurationsdateien aufrufen

Sobald eine API in Deployment Manager registriert ist, können Sie API-Ressourcen erstellen, indem Sie die API-Ressource in Ihrer Konfiguration als Typ aufrufen.

Wenn Sie Ihren Typanbieter beispielsweise example-directory-api genannt haben und eine API-Ressource mit dem Namen person erstellen möchten, können Sie den Typ in Ihren Konfigurationen so angeben:

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

Zum Vergleich: Dies ist derselbe Vorgang wie beim Aufrufen einer Google API und beim Erstellen einer API-Ressource:

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

Weitere Informationen

Hat Ihnen diese Seite weitergeholfen? Teilen Sie uns Ihr Feedback mit:

Feedback geben zu...

Cloud Deployment Manager-Dokumentation