Provisionner le hub d'API

Cette page s'applique à Apigee et à Apigee hybrid.

Cet article explique comment provisionner le hub d'API à l'aide de l'interface utilisateur d'Apigee dans la console Google Cloud. Il s'agit de la méthode recommandée pour provisionner le hub d'API. La figure 1 met en évidence les étapes de base décrites dans ce document de provisionnement.

Figure 1. Étapes de provisionnement d'une instance de hub d'API Apigee.

Avant de commencer

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.

      Accéder à IAM
   2. Sélectionnez le projet.
   3. Cliquez sur Accorder l'accès.

   4. Dans le champ Nouveaux comptes principaux, saisissez votre identifiant utilisateur. Il s'agit généralement de l'adresse e-mail d'un compte Google.

   5. Dans la liste Sélectionner un rôle, sélectionnez un rôle.
   6. Pour attribuer des rôles supplémentaires, cliquez sur Ajouter un autre rôle et ajoutez chaque rôle supplémentaire.
   7. Cliquez sur Enregistrer.

   Résumé des étapes

   Les étapes de provisionnement sont les suivantes :

   1. Étape 1 : Activez les API. Apigee nécessite l'activation de quelques API Google Cloud.
   2. Étape 2 : Choisissez un emplacement d'hébergement. Spécifiez l'emplacement physique de votre hub d'API.
   3. Étape 3 : Enregistrez un projet hôte. Le projet Google Cloud actuel est sélectionné par défaut.
   4. Étape 4 : Configurez le chiffrement. Sélectionnez ou créez une clé de chiffrement gérée par le client (CMEK) ou utilisez une clé de chiffrement gérée par Google (GMEK) pour chiffrer et déchiffrer vos données d'API au repos.
   5. Étape 5 : Créez une identité de service. Attribuez des autorisations d'accès à une identité de service.
   6. Créez votre instance d'API Hub. Le provisionnement prend plusieurs minutes.

   Procédure de provisionnement

   Pour lancer le provisionnement pour le hub d'API, procédez comme suit :

   1. Assurez-vous de remplir les conditions préalables décrites dans la section Avant de commencer.

   2. Dans la console Google Cloud, accédez à la page d'accueil du hub d'API Apigee.

      Accéder au hub d'API Apigee

   3. Cliquez sur Créer une instance.
      • Si le hub d'API n'est pas provisionné dans votre organisation, l'interface utilisateur affiche l'Étape 1 du workflow de provisionnement.
      • Si le hub d'API a déjà été provisionné, vous êtes redirigé vers la page des ressources de l'API.

   Étape 1 : API

   Pour provisionner le hub d'API, vous devez activer les API suivantes pour votre projet Google Cloud :

   Nom d'API	Emplacement	Description
   API du Hub d'API	apihub.googleapis.com	API du Hub d'API.
   Cloud Key Management Service (KMS)	cloudkms.googleapis.com	Ce service gère les clés et effectue des opérations de chiffrement aux fins d'une utilisation directe par d'autres ressources cloud.

   Cliquez sur Activer des API pour activer les API nécessaires. Cette étape prend quelques secondes.

   Étape 2 : Emplacement

   Vous devez sélectionner deux emplacements : d'abord l'emplacement physique (région) dans lequel vous souhaitez héberger votre instance de hub d'API Apigee, puis la multirégion dans laquelle vos données de recherche Vertex AI seront stockées :

   1. Dans la liste déroulante, sélectionnez la région dans laquelle vous souhaitez que votre instance du hub d'API soit hébergée. Les zones géographiques compatibles sont les suivantes :

      Description de la région	Nom de la région
      Iowa	us-central1
      Virginie du Nord	us-east4
      Oregon	us-west1
      Belgique	europe-west1
      Londres	europe-west2
      Singapour	asia-southeast1
      Mumbai	asia-south1
      São Paulo	southamerica-east1
      Sydney	australia-southeast1

   2. Si l'option Activer la fonctionnalité de recherche Vertex est activée (par défaut), vous devez sélectionner l'emplacement multirégional dans lequel stocker vos données de recherche basées sur Vertex AI, c'est-à-dire les données associées à la fonctionnalité Recherche sémantique du hub d'API. Par défaut, l'emplacement multirégional qui inclut la région du hub d'API que vous avez définie à l'étape 1 est sélectionné. Par exemple, si vous sélectionnez us-central1 comme région du hub d'API, l'emplacement multirégional us sera sélectionné par défaut. Toutefois, vous pouvez passer à un autre emplacement multirégional si vous le souhaitez.

      L'option de recherche Vertex active la fonctionnalité de recherche sémantique de Vertex AI du hub d'API. Si vous désélectionnez l'option Activer la fonctionnalité de recherche Vertex, la recherche sémantique est désactivée et le sélecteur multirégional est masqué.

   Remarque : Lorsque cette option est sélectionnée, Vertex Search provisionne automatiquement Vertex AI dans une région Google Cloud qui existe dans la même région multirégionale que la région dans laquelle le hub d'API est hébergé. Par exemple, si vous sélectionnez us-central1 comme région d'hébergement pour le hub d'API, Vertex peut être provisionné dans n'importe quelle région de l'emplacement multirégional us. Par exemple, Vertex peut être provisionné dans us-west1, us-west2, us-central2 ou une autre région de la multirégion US.
   3. Cliquez sur Définir l'emplacement.

   Étape 3 : Enregistrez le projet hôte

   Un projet hôte est un projet Google Cloud de votre organisation Apigee que vous désignez comme projet client pour toutes les ressources du hub d'API. Une seule instance de hub d'API peut être provisionnée par projet hôte.

   Pour utiliser le projet Google Cloud de votre organisation Apigee en tant que projet hôte pour le hub d'API, cliquez sur Suivant.

   Étape 4 : Chiffrement

   Au cours de cette étape, vous pouvez choisir d'utiliser une clé de chiffrement gérée par Google (GMEK) ou une clé de chiffrement gérée par le client (CMEK) définie dans Cloud Key Management Service pour chiffrer les données stockées dans votre instance de hub d'API.

   Pour utiliser une clé de chiffrement gérée par Google, sélectionnez l'option Clé de chiffrement gérée par Google. Si vous sélectionnez cette option, aucune configuration de clé supplémentaire n'est requise.

   Pour utiliser un CMEK existant :

   1. Dans le champ Sélectionner une clé de chiffrement gérée par le client (CMEK), saisissez une clé pour filtrer les résultats ou faites défiler la page pour rechercher votre clé existante. Vous pouvez également saisir l'ID de ressource de la clé pour localiser une clé existante.
   2. Sélectionnez votre clé, puis cliquez sur OK.
   3. Cliquez sur Confirmer.

   Pour créer une clé CMEK :

   1. Cliquez sur Créer une clé. La boîte de dialogue Créer une clé s'affiche.
   2. Dans la section Trousseau de clés, vous pouvez spécifier un trousseau de clés existant ou en créer un nouveau.
      • Pour utiliser un trousseau de clés existant :
        1. Sélectionnez un trousseau de clés existant dans la liste Trousseaux de clés.
        2. Cliquez sur Continuer.
      • Pour créer un nouveau trousseau de clés :
        1. Cliquez sur le bouton Créer un trousseau ou sur Créer un trousseau dans la zone de sélection.
        2. Dans le champ Nom du trousseau, saisissez un nom pour le trousseau de clés.

           Les noms des trousseaux de clés peuvent contenir des lettres, des chiffres, des traits de soulignement (_) et des traits d'union (-). Les trousseaux de clés ne peuvent être ni renommés, ni supprimés.

        3. Sélectionnez un emplacement dans la liste Emplacement du trousseau de clés.

           Cet emplacement est limité à l'emplacement d'hébergement que vous avez choisi à l'étape précédente pour garantir que la clé et les données restent dans la même région.

        4. Cliquez sur Continuer.
   3. Dans la section Clé :
      1. Saisissez un nom pour votre clé dans le champ Nom de la clé.

         Les noms des clés peuvent contenir des lettres, des chiffres, des traits de soulignement (_) et des traits d'union (-). Les clés ne peuvent être ni renommées, ni supprimées.

      2. Sélectionnez un niveau de protection, par exemple Logiciel.
      3. Cliquez sur Continuer.
   4. Dans la section Examen, confirmez les détails que vous avez spécifiés pour la création de clé.

      Si les informations sont correctes, cliquez sur Créer une clé.

      Avertissement : Les clés et les trousseaux de clés ne peuvent pas être supprimés après leur création. Pour en savoir plus, consultez la section Pourquoi ne puis-je pas supprimer des clés ou des trousseaux de clés ?.
   5. Sélectionnez la clé que vous venez de créer dans la zone Choisir une clé de chiffrement gérée par le client.
   6. Cliquez sur Confirmer la clé de chiffrement.

   Étape 5 : Identité du service

   Au cours de cette étape, vous allez créer une identité de service et lui accorder l'accès à la clé de chiffrement gérée par le client que vous avez sélectionnée. Cette clé est utilisée pour chiffrer et déchiffrer les données du hub d'API.

   Pour créer la nouvelle identité de service, cliquez sur Créer une identité de service et accorder des autorisations.

   Apigee crée un compte de service et lui attribue les rôles cloudkms.cryptoKeyEncrypterDecrypter, apihub.admin et apihub.runtimeProjectServiceAgent.

   Créez votre instance de hub d'API

   Cliquez sur Soumettre pour créer votre instance de hub d'API.

   Une fois le provisionnement lancé, la page Finalisation de l'instance du hub d'API s'affiche. Cette étape prend quelques minutes.

   Une fois le provisionnement terminé, la page API du hub d'API s'affiche.

   Remarque : Si vous avez provisionné le hub d'API dans un projet comportant des proxys Apigee, ces proxys sont automatiquement enregistrés dans le hub d'API dans les heures qui suivent le provisionnement du hub d'API. Par exemple, si vous provisionnez le hub d'API dans test-project-1 et que ce projet comporte des proxys Apigee, test-project-1 est automatiquement associé en tant que projet d'exécution, et les proxys de test-project-1 sont enregistrés dans le hub d'API.

   Étapes suivantes

   Félicitations ! Vous avez provisionné le hub d'API.

   Vous êtes maintenant prêt à utiliser le hub d'API :

   • Consultez les rôles et autorisations requis pour utiliser API Hub.
   • Configurez les attributs du hub d'API :
     • Gérer les attributs
     • Guide de démarrage rapide : Créer et modifier des attributs
   • Enregistrez une ressource d'API :
     • Gérer les ressources d'API
     • Guide de démarrage rapide : enregistrer une API
   • Ajoutez une version d'API :
     • Présentation des versions
     • Guide de démarrage rapide : créer une version d'API