Personnaliser votre domaine

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

Consultez la documentation d' Apigee Edge.

Lorsque vous créez un portail des développeurs, par défaut, vous fournissez un exemple de nom de domaine Apigee pour accéder à votre portail en ligne au format suivant :

https://orgname-portalname.apigee.io

orgname est le nom de l'organisation et portalname est défini à l'aide du nom du portail converti en minuscules, sans espaces ni tirets.

Avant de lancer un portail des développeurs, il est recommandé de fournir votre propre nom de domaine personnalisé. Voici par exemple une alternative couramment utilisée :

https://developers.example.com

Pour en savoir plus sur l'utilisation d'un domaine personnalisé avec un fournisseur d'identité SAML, consultez la section Utiliser un domaine personnalisé avec le fournisseur d'identité SAML.

Procédure à suivre pour personnaliser votre domaine

Pour personnaliser votre nom de domaine, procédez comme suit :

  1. Enregistrez votre nom de domaine
  2. Créez un certificat TLS pour votre domaine personnalisé. Vous aurez besoin du certificat pour créer l'équilibreur de charge.
  3. Déterminez le nom d'hôte par défaut de votre portail.
  4. Créez un groupe de points de terminaison du réseau (NEG) Internet afin de définir le point de terminaison backend sur votre portail intégré pour l'équilibreur de charge.
  5. Créez un équilibreur de charge qui pointe vers le NEG Internet et réserve l'adresse IP pour vos requêtes client entrantes.
  6. Configurez le domaine personnalisé sur votre portail
  7. Mettez à jour votre DNS afin de créer un enregistrement pour l'hébergeur de domaine personnalisé.

Étape 1 : Enregistrer votre nom de domaine

Si vous devez enregistrer un nouveau domaine, de nombreux sites populaires d'enregistrement de domaine sont disponibles, tels que Google Domains. Le choix du site d'enregistrement de domaine vous appartient.

Lorsque vous décidez du nom de domaine, gardez à l'esprit que les URL lisibles et conviviales sont des facteurs essentiels pour améliorer le référencement naturel, comme décrit dans la section Mettre en œuvre le référencement naturel (SEO).

Étape 2 : Créer un certificat TLS pour votre domaine personnalisé

Créez un certificat TLS pour votre domaine personnalisé à l'aide de l'outil de votre choix, par exemple avec Let's Encrypt. Pour en savoir plus, consultez les pages suivantes :

Étape 3 : Déterminer le nom d'hôte par défaut de votre portail

Pour déterminer le nom d'hôte par défaut de votre portail, procédez comme suit :

  1. Dans l'interface utilisateur Apigee, sélectionnez Publier > Portails dans la barre de navigation latérale. La liste des portails s'affiche.
  2. Copiez le contenu du champ Emplacement du portail pour lequel vous souhaitez créer un domaine personnalisé. Élément de portail avec le champ Emplacement en surbrillance

    Vous aurez besoin de cette valeur à l'étape suivante.

Étape 4 : Créer un NEG Internet

Pour cette étape, vous allez créer un groupe de points de terminaison du réseau (NEG) Internet afin de définir le point de terminaison backend sur votre portail intégré pour l'équilibreur de charge. Pour en savoir plus, consultez la Présentation des groupes de points de terminaison du réseau Internet.

  1. Dans Google Cloud Console, accédez à la page Tableau de bord et sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Tableau de bord"

  2. Dans le navigateur, sélectionnez Compute Engine > Groupes de points de terminaison du réseau.

  3. Cliquez sur Créer un groupe de points de terminaison du réseau.

  4. Configurez les champs suivants :

    Champ Valeur
    Nom Saisissez un nom pour le NEG Internet.
    Type de groupe de points de terminaison du réseau Sélectionnez Groupe de points de terminaison du réseau (Internet).
    Nouveau point de terminaison du réseau
  5. Vous pouvez conserver les valeurs par défaut des autres champs.

  6. Cliquez sur Create (Créer).

Le NEG Internet est créé.

Étape 5 : Créer un équilibreur de charge

Créez un équilibreur de charge qui pointe vers le NEG Internet et réserve l'adresse IP pour vos requêtes client entrantes.

Démarrer la configuration

  1. Dans Google Cloud Console, accédez à la page Équilibrage de charge.

    Accéder à la page "Équilibrage de charge"

  2. Cliquez sur Créer un équilibreur de charge.
  3. Dans le champ Type d'équilibreur de charge, sélectionnez Équilibreur de charge d'application (HTTP/HTTPS), puis cliquez sur Suivant.
  4. Pour Public ou interne, sélectionnez Public (externe), puis cliquez sur Suivant.
  5. Pour Déploiement mondial ou dans une seule région, sélectionnez Recommandé pour les charges de travail à l'échelle mondiale, puis cliquez sur Suivant.
  6. Pour Génération de l'équilibreur de charge, sélectionnez Équilibreur de charge d'application externe global, puis cliquez sur Suivant.
  7. Cliquez sur Configurer.

Configurer l'équilibreur de charge

  1. Cliquez sur chaque catégorie et configurez l'équilibreur de charge comme décrit dans le tableau suivant.

    Catégorie Étapes
    Configuration de l'interface

    Réservez l'adresse IP pour les requêtes entrantes de vos clients puis importez le certificat TLS créé à l'étape 2 : Créer un certificat TLS :

    1. Dans la section Créer un équilibreur de charge d'application externe global, placez votre curseur sur Configuration du frontend, puis cliquez sur la flèche.
    2. Saisissez un nom pour le frontend dans le champ Nom.
    3. Dans le menu déroulant Protocole, sélectionnez HTTPS.
    4. Dans le menu déroulant Adresse IP, sélectionnez Créer une adresse IP.
      La boîte de dialogue "Réserver une nouvelle adresse IP statique" s'affiche.
    5. Saisissez un nom pour l'adresse IP statique dans le champ Nom.
    6. Si vous le souhaitez, saisissez une description.
    7. Cliquez sur Réserver.
    8. Enregistrez l'adresse IP réservée afin de l'utiliser lors de la configuration de l'enregistrement DNS.
    9. Sélectionnez Créer un certificat dans le menu déroulant Certificat.
      La fenêtre "Créer un certificat" s'ouvre.
    10. Saisissez un nom pour le nouveau certificat dans le champ Nom.
    11. Sélectionnez Importer mon certificat sous Créer un certificat.
    12. Importez les détails de votre certificat TLS, y compris la clé publique, la chaîne de certificats et la clé privée.
    13. Cliquez sur Create (Créer).
    14. Cliquez sur Terminé pour créer les nouveaux IP et port frontend.
    Configuration du backend

    Configurez le backend pour diriger le trafic entrant vers le NEG Internet créé à l'Étape 4 : Créer un groupe de points de terminaison du réseau Internet :

    1. Dans la section Créer un équilibreur de charge d'application externe global, placez votre curseur sur Configuration du backend, puis cliquez sur la flèche.
    2. Dans la section Services de backend et buckets backend, sélectionnez Services de backend > Créer un service backend dans le menu déroulant.
      La fenêtre "Créer un service de backend" s'ouvre.
    3. Saisissez un nom dans le champ Nom.
    4. Sélectionnez Groupe de points de terminaison du réseau Internet dans le menu déroulant Type de backend.
    5. Sélectionnez HTTPS comme protocole.
    6. Dans la section Nouveau backend, sélectionnez le NEG Internet que vous avez créé à l'étape 4 : Créer un groupe de points de terminaison du réseau (NEG) Internet dans le menu déroulant Groupe de points de terminaison du réseau Internet puis cliquez surOK.
    7. Décochez la case Activer Cloud CDN.
    8. Vous pouvez conserver toutes les autres valeurs par défaut.
    9. Cliquez sur Créer.
    Règles d'hôte et de chemin d'accès

    Configurez les règles d'hôte et de chemin d'accès pour déterminer la manière dont votre trafic est dirigé :

    1. Dans la section Créer un équilibreur de charge d'application externe global, placez votre curseur sur Règles d'hôte et de chemin d'accès, puis cliquez sur la flèche.
    2. Cliquez sur Règle d'hôte et de chemin d'accès avancée (redirection et réécriture d'URL) sous Mode.
    3. Dans la section Nouvelle règle d'hôte et de chemin d'accès :
      1. Sélectionnez Router le trafic vers un backend unique dans le menu déroulant Action.
      2. Développez la section Action complémentaire (réécriture d'URL).
      3. Saisissez le nom de domaine par défaut que vous avez copié à l'étape 3 : Déterminer le nom d'hôte par défaut de votre portail dans le champ Réécriture de l'hôte.
      4. Sélectionnez le service de backend que vous avez configuré dans le menu déroulant Backend.
      5. Cliquez sur OK.
  2. Cliquez sur Créer sur la page Créer un équilibreur de charge d'application externe global.

Étape 6 : Configurer le domaine personnalisé sur votre portail

Pour configurer le domaine personnalisé sur votre portail, procédez comme suit :

  1. Dans l'interface utilisateur Apigee, sélectionnez Publier > Portails dans la barre de navigation latérale.
    La liste des portails s'affiche.
  2. Sélectionnez votre portail dans la liste.
  3. Sélectionnez Paramètres sur la page de destination ou dans le menu déroulant de la barre de navigation supérieure.
  4. Cliquez sur l'onglet Domains (Domaines).
  5. Saisissez votre nom de domaine personnalisé dans le champ Domaine.
  6. Cliquez sur Activer.

Vérifiez que lorsque vous accédez au domaine personnalisé dans un navigateur, vous êtes dirigé vers votre portail intégré.

Consultez également les articles Modifier un domaine personnalisé et Désactiver un domaine personnalisé.

Étape 7 : Mettre à jour votre DNS

Dans votre système DNS, créez un enregistrement pour l'hôte de domaine personnalisé.

Pour créer une zone Cloud DNS, suivez les étapes décrites dans la section Gérer les zones. Assurez-vous de configurer les champs suivants, comme décrit ci-dessous :

Champ Description
Type de zone Sélectionnez Publique.
Nom de zone Saisissez un nom pertinent pour la zone. Par exemple : mycompany-zone
Nom DNS Saisissez le suffixe pour la zone à l'aide d'un nom de domaine vous appartenant. Par exemple : mycompany.com

Après avoir créé une zone, sur la page "Détails de la zone", cliquez sur Ajouter un jeu d'enregistrements et suivez les étapes décrites dans la section Gérer les enregistrements. Assurez-vous de configurer les champs suivants, comme décrit ci-dessous :

Champ Description
Nom DNS Spécifiez le préfixe pour votre nom DNS. Le suffixe que vous avez défini pour la zone Cloud DNS s'affiche également, mais n'est pas modifiable. Par exemple : developers.mycompany.com
Type d'enregistrement de ressource Sélectionnez A (valeur par défaut).
Valeur TTL Définissez la valeur souhaitée ou conservez la valeur 5 (par défaut).
Unité de valeur TTL Définissez la valeur souhaitée ou conservez la valeur minutes (par défaut).
Adresse IPv4 Saisissez l'adresse IP externe que vous avez réservée lors de la création de l'équilibreur de charge.

Modifier un domaine personnalisé sur votre portail

Pour modifier un domaine personnalisé sur votre portail, procédez comme suit :

  1. Dans l'interface utilisateur Apigee, sélectionnez Publier > Portails dans la barre de navigation latérale.
    La liste des portails s'affiche.
  2. Sélectionnez votre portail dans la liste.
  3. Sélectionnez Paramètres dans le menu déroulant de la barre de navigation supérieure ou sur la page de destination.
  4. Cliquez sur l'onglet Domaines.
  5. Modifiez les informations du domaine personnalisé.
  6. Cliquez sur Enregistrer.

Désactiver un domaine personnalisé sur votre portail

Pour désactiver un nom de domaine personnalisé sur votre portail, procédez comme suit :

  1. Dans l'interface utilisateur Apigee, sélectionnez Publier > Portails dans la barre de navigation latérale. La liste des portails s'affiche.
  2. Sélectionnez votre portail dans la liste.
  3. Sélectionnez Paramètres dans le menu déroulant de la barre de navigation supérieure ou sur la page de destination.
  4. Cliquez sur l'onglet Domaines.
  5. Cliquez sur Désactiver.
  6. Cliquez sur Désactiver dans l'invite pour confirmer l'opération.

Le domaine personnalisé est désactivé et les champs sont effacés.