Publier une API à partir d'un nom de domaine

OpenAPI | gRPC

Cette page explique comment diffuser une API à partir d'un domaine personnalisé dont vous êtes le propriétaire, par exemple example.com.

À la place de votre propre nom de domaine, vous pouvez utiliser un nom de domaine géré par Google. Pour plus d'informations, consultez la section Utiliser un domaine géré par Google.

Avant de commencer

• Obtenez un nom de domaine auprès d'un service d'enregistrement de noms de domaine, si vous n'en possédez pas encore un pour votre API.
• Validez la propriété du domaine.
• Nommez le nom d'hôte de votre API avec votre nom de domaine.
• Si vous utilisez SSL avec votre domaine, obtenez et importez votre certificat SSL.
• Déployez l'API et Extensible Service Proxy (ESP).

Configurer le projet API pour utiliser votre nom de domaine

Suivez les instructions fournies dans l'onglet approprié.

App Engine

Pour indiquer au projet d'API d'utiliser votre domaine validé, suivez les instructions fournies dans la section Ajouter un domaine personnalisé pour votre application.

Compute Engine

La méthode recommandée pour publier une API à partir d'instances Compute Engine consiste à utiliser un équilibreur de charge sur un groupe d'instances. Vous devez réserver une adresse IP externe pour le nom de domaine et utiliser cette adresse IP externe pour l'équilibreur de charge.

Pour publier l'API à partir d'un nom de domaine, procédez comme suit :

1. Réservez au moins une adresse IP externe statique dans votre projet:
   

   Accéder à la page "Adresses IP externes"

1. Attribuez le nom de votre choix à l'adresse IP réservée.
2. Pour le champ Type, cliquez sur Global.
3. Pour le champ Associé à, cliquez sur Aucun. Vous associerez l'adresse IP à un équilibreur de charge ultérieurement.
2. Accédez au compte de votre fournisseur de domaine et modifiez les paramètres du domaine. Vous devez créer un enregistrement A contenant le nom de l'API, par exemple myapi.example.com, avec l'adresse IP externe dans son champ de données.
3. Créez un groupe d'instances incluant les instances qui exécutent votre API et Extensible Service Proxy (ESP:
   )

   Accéder à la page "Créer un groupe d'instances"

1. Attribuez le nom de votre choix au groupe et ajoutez une description.
2. Dans la liste Zone, cliquez sur la zone utilisée par votre instance d'API.
3. Dans la liste Définition d'instance, cliquez sur Sélectionner des instances existantes.
4. Dans le champ Instances de VM, ajoutez l'instance de VM exécutant l'API.
5. Cliquez sur Créer.
4. Créez et configurez un équilibreur de charge HTTP(S) :
   

   Accéder à la page "Créer un équilibreur de charge HTTP(S)"

1. Cliquez sur Définir un service backend > Créer ou sélectionner un service backend.
   
2. Indiquez le nom et la description de votre choix pour cette configuration de service backend.
3. Dans le champ Protocol, sélectionnez le protocole à utiliser via l'équilibreur de charge, HTTP ou HTTPS.
4. Dans la liste Instance group (Groupe d'instances), cliquez sur votre groupe d'instances.
5. Dans le champ Port Numbers (Numéros de port), entrez 8080.
6. Cliquez sur Health check (Vérification d'état) pour configurer les vérifications d'état :
• Saisissez un nom pour la configuration de la vérification de l'état.
• Attribuez le port 8080.
• Pour accepter les valeurs par défaut restantes, cliquez sur Enregistrer.
7. Pour l'instant, acceptez les valeurs par défaut pour le reste de la configuration. Vous pourrez toujours apporter des modifications plus tard si nécessaire, telles que des ports supplémentaires.
8. Vous n'avez pas besoin de définir quoi que ce soit dans les règles d'hôte et de chemin d'accès ; vous pouvez tout transférer à votre API backend en utilisant les filtres Sans correspondance par défaut. Cela signifie que tout le trafic dans l'équilibreur de charge est dirigé vers l'API sur le port 8080 (le port par défaut) comme défini dans les étapes précédentes.
9. Cliquez sur Configuration du frontend.
   
• Dans le champ Protocol, sélectionnez le protocole à utiliser via l'équilibreur de charge, HTTP ou HTTPS.
• Dans la liste IP, cliquez sur l'adresse IP externe que vous avez créée précédemment.
• Pour le protocole HTTPS, vous devez utiliser SSL. Dans la liste Certificate (Certificat), cliquez sur le certificat souhaité.
• Si vous souhaitez utiliser un autre protocole, cliquez sur Add frontend IP and port (Ajouter une adresse IP et un port frontend), puis spécifiez le protocole, la même adresse IP externe et un autre port.
10. Pour créer l’équilibreur de charge entièrement configuré, cliquez sur Créer. Si le bouton Créer n'est pas activé, vérifiez les composants que vous venez de configurer. Une coche doit apparaître à côté de chacun des composants de configuration. S'il manque une coche, cela signifie que vous n'avez pas terminé la configuration.
11. Une fois que vos modifications DNS se sont propagées, les requêtes sont envoyées à votre API à l'aide de l'équilibreur de charge.
Remarque : Si les requêtes n'atteignent pas le backend de votre API, vérifiez les règles de pare-feu de votre projet pour vous assurer que vos instances peuvent accepter le trafic sur le port ESP 8080 par défaut. Pour plus d'informations, consultez la section Pare-feu.

GKE

Pour diffuser une API sur un domaine pour Google Kubernetes Engine (GKE), vous devez exposer ESP en tant que service, en utilisant l'adresse IP externe renvoyée pour les paramètres DNS de votre domaine. Sachez que GKE effectue automatiquement l’équilibrage de charge.

Pour exposer votre API en tant que service, procédez comme suit :

1. Si vous n'en avez pas déjà un, configurez un service Kubernetes pour les backends d'API. Créez un fichier de configuration de service service.yaml avec un contenu semblable à celui-ci :

               apiVersion: v1
               kind: Service
               metadata:
                 name: echo
               spec:
                 ports:
                 - port: 80
                   targetPort: 8081
                   protocol: TCP
                 selector:
                   app: echo-app
                 type: LoadBalancer
                 

• Modifiez le libellé selector pour qu'il corresponde aux libellés de backend (app: echo-app dans cet exemple).
• Assurez-vous que targetPort correspond au port utilisé par ESP configuré dans vos backends d'API. ESP utilise le port 8081 par défaut.
2. Déployez le service Kubernetes :
   

               kubectl apply -f service.yaml
               

3. Affichez l'adresse IP externe attribuée à votre service exposé :
   

               kubectl get services
               

   Vous devriez obtenir une adresse EXTERNAL-IP semblable à celle-ci :
   

               NAME         CLUSTER-IP     EXTERNAL-IP      PORT(S)    AGE
               hello-node   10.X.XXX.202   10X.XXX.XX.123   8080/TCP   1m
         

   Remarque : Il faut un certain temps pour que l'API soit exposée en tant que service, et l'adresse IP externe n'est visible qu'à la fin de ce processus. Vous vous devrez peut-être exécuter kubectl get services plusieurs fois avant de voir l'adresse IP.
4. Convertissez l'adresse IP externe générée, qui est éphémère, en adresse statique.
   

   Accéder à la page "Adresses IP externes"

1. Sélectionnez votre adresse IP externe dans la liste.
2. Dans la liste Type, cliquez sur Statique.
5. Accédez au compte de votre fournisseur de domaine et modifiez les paramètres du domaine. Vous devez créer un enregistrement A contenant le nom de l'API, par exemple myapi.example.com, avec l'adresse IP externe dans son champ de données.

Étape suivante

• Publier plusieurs API à partir d'un domaine