API-Hub bereitstellen

Diese Seite gilt für Apigee und Apigee Hybrid.

In diesem Thema wird beschrieben, wie Sie den API-Hub mithilfe der Apigee-Benutzeroberfläche in der Google Cloud Console bereitstellen. Dies ist die empfohlene Methode zur Bereitstellung des API-Hubs. Abbildung 1 zeigt die grundlegenden Schritte, die in diesem Bereitstellungsdokument beschrieben werden.

Abbildung 1: Schritte zum Bereitstellen einer Apigee API-Hub-Instanz.

Hinweise

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

5. Make sure that billing is enabled for your Google Cloud project.

6. Make sure that you have the following role or roles on the project:

   • roles/serviceusage.serviceUsageAdmin
   • roles/cloudkms.admin
   • roles/apihub.provisioningAdmin
   • roles/resourcemanager.projectIamAdmin

   Check for the roles

   1. In the Google Cloud console, go to the IAM page.

      Go to IAM
   2. Select the project.

   3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

   4. For all rows that specify or include you, check the Role colunn to see whether the list of roles includes the required roles.

   Grant the roles

   1. In the Google Cloud console, go to the IAM page.

      IAM aufrufen
   2. Wählen Sie das Projekt aus.
   3. Klicken Sie auf Zugriff erlauben.

   4. Geben Sie im Feld Neue Hauptkonten Ihre Nutzer-ID ein. Dies ist in der Regel die E-Mail-Adresse eines Google-Kontos.

   5. Wählen Sie in der Liste Rolle auswählen eine Rolle aus.
   6. Wenn Sie weitere Rollen hinzufügen möchten, klicken Sie auf Weitere Rolle hinzufügen und fügen Sie weitere Rollen hinzu.
   7. Klicken Sie auf Speichern.

   Zusammenfassung der Schritte

   Dazu sind folgende Schritte erforderlich:

   1. Schritt 1: APIs aktivieren. Für Apigee müssen Sie einige Google Cloud APIs aktivieren.
   2. Schritt 2: Hostingstandort auswählen. Geben Sie den physischen Speicherort des API-Hubs an.
   3. Schritt 3: Hostprojekt registrieren Das aktuelle Google Cloud-Projekt ist standardmäßig ausgewählt.
   4. Schritt 4: Verschlüsselung konfigurieren Wählen Sie einen vom Kunden verwalteten Verschlüsselungsschlüssel (Customer-Managed Encryption Key, CMEK) aus oder erstellen Sie einen oder verwenden Sie einen von Google verwalteten Verschlüsselungsschlüssel (Google-Managed Encryption Key, GMEK), um Ihre inaktiven API-Daten zu verschlüsseln und zu entschlüsseln.
   5. Schritt 5: Dienstidentität erstellen. Weisen Sie einer Dienstidentität Zugriffsberechtigungen zu.
   6. Erstellen Sie die API-Hub-Instanz. Die Bereitstellung kann mehrere Minuten dauern.

   Bereitstellungsschritte

   So starten Sie die Bereitstellung für den API-Hub:

   1. Prüfen Sie, ob die unter Vorbereitung beschriebenen Voraussetzungen erfüllt sind.

   2. Rufen Sie in der Google Cloud Console die Begrüßungsseite des Apigee API-Hubs auf.

      Zum Apigee API-Hub

   3. Klicken Sie auf Instanz erstellen.
      • Wird der API-Hub in Ihrer Organisation nicht bereitgestellt, wird in der Benutzeroberfläche Schritt 1 des Bereitstellungsworkflows angezeigt.
      • Wenn der API-Hub bereits bereitgestellt wurde, werden Sie zur Seite „API-Ressourcen“ weitergeleitet.

   Schritt 1: APIs

   Um den API-Hub bereitzustellen, müssen Sie die folgenden APIs für Ihr Google Cloud-Projekt aktivieren:

   API-Name	Ort	Beschreibung
   API-Hub API	apihub.googleapis.com	API-Hub-API.
   Cloud Key Management Service (KMS)	cloudkms.googleapis.com	Verwaltet Schlüssel und führt kryptografische Vorgänge für die direkte Verwendung durch andere Cloud-Ressourcen aus.

   Klicken Sie zum Aktivieren der erforderlichen APIs auf APIs aktivieren. Dieser Schritt dauert nur wenige Sekunden.

   Schritt 2: Standort

   Sie müssen zwei Standorte auswählen: Erstens den physischen Standort (Region), an dem Sie die Apigee API-Hub-Instanz hosten möchten, und zweitens die Multi-Region, in der Ihre Vertex AI Search-Daten gespeichert werden:

   1. Wählen Sie in der Drop-down-Liste die Region aus, in der die API-Hub-Instanz gehostet werden soll. Zu den unterstützten Standorten gehören:

      Beschreibung der Region	Name der Region
      Iowa	us-central1
      Northern Virginia	us-east4
      Oregon	us-west1
      Belgien	europe-west1
      London	europe-west2
      Singapur	asia-southeast1
      Mumbai	asia-south1
      São Paulo	southamerica-east1
      Sydney	australia-southeast1

   2. Wenn die Option Vertex-Suchfunktionen aktivieren aktiviert ist (Standardeinstellung), müssen Sie den multiregionalen Speicherort auswählen, an dem Ihre Vertex AI-basierten Suchdaten gespeichert werden sollen. Das sind die Daten, die mit der semantischen Suche des API-Hubs verknüpft sind. Standardmäßig ist die Multi-Region ausgewählt, die die in Schritt 1 festgelegte API-Hub-Region enthält. Wenn Sie beispielsweise us-central1 als API-Hub-Region auswählen, wird standardmäßig die Multi-Region us ausgewählt. Sie können jedoch jederzeit zu einem anderen multiregionalen Speicherort wechseln.

      Mit der Vertex-Suchoption wird die semantische Suche auf Basis von Vertex AI im API-Hub aktiviert. Wenn Sie die Option Vertex-Suchfunktion aktivieren deaktivieren, wird die semantische Suche deaktiviert und die Auswahl für mehrere Regionen ausgeblendet.

   Hinweis:Wenn Sie diese Option auswählen, wird Vertex AI automatisch in einer Google Cloud-Region bereitgestellt, die sich in derselben Multiregion wie die Region befindet, in der der API-Hub gehostet wird. Wenn Sie beispielsweise us-central1 als Hostingregion für den API-Hub auswählen, kann Vertex in einer beliebigen Region innerhalb der Multi-Region us bereitgestellt werden. Vertex kann beispielsweise in us-west1, us-west2, us-central2 oder einer anderen Region innerhalb der Multiregion US bereitgestellt werden.
   3. Klicken Sie auf Standort festlegen.

   Schritt 3: Hostprojekt registrieren

   Ein Hostprojekt ist ein Google Cloud-Projekt in Ihrer Apigee-Organisation, das Sie als Nutzerprojekt für alle API-Hubressourcen festlegen. Pro Hostprojekt kann genau eine API-Hubinstanz bereitgestellt werden.

   Klicken Sie auf Registrieren, um das Google Cloud-Projekt Ihrer Apigee-Organisation als Hostprojekt für den API-Hub zu verwenden.

   Schritt 4: Verschlüsselung

   In diesem Schritt können Sie einen von Google verwalteten Verschlüsselungsschlüssel (Google-Managed Encryption Key, GMEK) oder einen im Cloud Key Management Service definierten vom Kunden verwalteten Verschlüsselungsschlüssel (Customer-Managed Encryption Key, CMEK) verwenden, um die in Ihrer API-Hub-Instanz gespeicherten Daten zu verschlüsseln.

   Wenn Sie einen von Google verwalteten Verschlüsselungsschlüssel verwenden möchten, wählen Sie einfach die Option Von Google verwalteter Verschlüsselungsschlüssel aus. Wenn Sie diese Option auswählen, ist keine weitere Schlüsselkonfiguration erforderlich.

   So verwenden Sie eine vorhandene CMEK:

   1. Geben Sie im Feld Vom Kunden verwalteten Verschlüsselungsschlüssel (CMEK) auswählen einen Filter ein oder scrollen Sie zur Suche nach dem vorhandenen Schlüssel. Alternativ können Sie die Ressourcen-ID des Schlüssels eingeben, um einen vorhandenen Schlüssel zu finden.
   2. Wählen Sie Ihren Schlüssel aus und klicken Sie auf OK.
   3. Klicken Sie auf Bestätigen.

   So erstellen Sie einen neuen CMEK:

   1. Klicken Sie auf Schlüssel erstellen. Das Dialogfeld Neuen Schlüssel erstellen wird angezeigt.
   2. Im Bereich Schlüsselbund können Sie einen vorhandenen Schlüsselbund angeben oder einen neuen erstellen.
      • So verwenden Sie einen vorhandenen Schlüsselbund:
        1. Wählen Sie einen vorhandenen Schlüsselbund aus der Liste Schlüsselbund aus.
        2. Klicken Sie auf Weiter.
      • So erstellen Sie einen neuen Schlüsselbund:
        1. Klicken Sie auf die Schaltfläche Schlüsselbund erstellen oder im Auswahlfeld auf Schlüsselbund erstellen.
        2. Geben Sie im Feld Schlüsselbundname einen Namen für den Schlüsselbund ein.

           Schlüsselbundnamen können Buchstaben, Ziffern, Unterstriche (_) und Bindestriche (-) enthalten. Schlüsselbunde können weder umbenannt noch gelöscht werden.

        3. Wählen Sie einen Standort aus der Liste Schlüsselbundort aus.

           Dieser Ort ist auf den Hosting-Standort beschränkt, den Sie im vorherigen Schritt ausgewählt haben, damit der Schlüssel und die Daten in derselben Region bleiben.

        4. Klicken Sie auf Weiter.
   3. Im Abschnitt Schlüssel:
      1. Geben Sie im Feld Schlüsselname einen Namen für den Schlüssel ein.

         Schlüsselnamen können Buchstaben, Ziffern, Unterstriche (_) und Bindestriche (-) enthalten. Schlüssel können weder umbenannt noch gelöscht werden.

      2. Wählen Sie ein Schutzniveau aus, z. B. Software.
      3. Klicken Sie auf Weiter.
   4. Bestätigen Sie im Abschnitt Prüfen die Details, die Sie für die Schlüsselerstellung angegeben haben.

      Wenn die Informationen korrekt sind, klicken Sie auf Erstellen.

      Warnung: Schlüssel und Schlüsselbunde können nach dem Erstellen nicht gelöscht werden. Weitere Informationen finden Sie unter Warum kann ich Schlüssel oder Schlüsselbunde nicht löschen?.
   5. Wählen Sie im Feld Vom Kunden verwalteten Verschlüsselungsschlüssel auswählen den neu erstellten Schlüssel aus.
   6. Klicken Sie auf Verschlüsselungsschlüssel bestätigen.

   Schritt 5: Dienstidentität

   In diesem Schritt erstellen Sie eine neue Dienstidentität und gewähren ihr Zugriff auf den ausgewählten vom Kunden verwalteten Verschlüsselungsschlüssel. Mit diesem Schlüssel werden Ihre API-Hub-Daten ver- und entschlüsselt.

   Klicken Sie zum Erstellen der neuen Dienstidentität auf Dienstidentität erstellen und Berechtigungen erteilen.

   Apigee erstellt ein Dienstkonto und weist dem Dienstkonto die Rollen cloudkms.cryptoKeyEncrypterDecrypter, apihub.admin und apihub.runtimeProjectServiceAgent zu.

   API-Hub-Instanz erstellen

   Klicken Sie auf Senden, um die API-Hub-Instanz zu erstellen.

   Wenn die Bereitstellung beginnt, wird die Seite API-Hub-Instanz abschließen angezeigt. Die Ausführung dieses Befehls kann einige Minuten dauern.

   Nach Abschluss der Bereitstellung wird die Seite APIs des API-Hubs angezeigt.

   Hinweis: Wenn Sie den API-Hub in einem Projekt mit Apigee-Proxys bereitgestellt haben, werden solche Proxys automatisch innerhalb weniger Stunden nach der Bereitstellung im API-Hub registriert. Wenn Sie beispielsweise den API-Hub in test-project-1 bereitstellen und dieses Projekt Apigee-Proxys hat, wird test-project-1 automatisch als Laufzeitprojekt angehängt und die Proxys in test-project-1 werden im API-Hub registriert.

   Nächste Schritte

   Glückwunsch! Sie haben den API-Hub erfolgreich bereitgestellt.

   Jetzt können Sie den API-Hub verwenden:

   • Rollen und Berechtigungen für die Verwendung des API-Hubs
   • API-Hub-Attribute konfigurieren:
     • Attribute verwalten
     • Kurzanleitung: Attribute erstellen und bearbeiten
   • API-Ressource registrieren:
     • API-Ressourcen verwalten
     • Kurzanleitung: API registrieren
   • API-Version hinzufügen:
     • Versionsübersicht
     • Kurzanleitung: API-Version erstellen