Migrer les propriétés de l'interface utilisateur classique vers la nouvelle interface utilisateur Edge

Dans Apigee Edge for Private Cloud 4.54.00, l'UI classique (le composant edge-ui) est supprimée et n'est plus disponible. La nouvelle interface utilisateur Edge (le composant edge-management-ui) est la seule interface utilisateur pour Edge pour Private Cloud.

Vous ne pouvez pas utiliser edge-ui dans Edge pour le cloud privé 4.54.00. Si vous avez personnalisé l'UI classique en définissant des propriétés dans /opt/apigee/customer/application/ui.properties, la nouvelle UI Edge ne lit pas ce fichier. Après la mise à niveau vers la version 4.54.00, vous devez définir les propriétés équivalentes dans /opt/apigee/customer/application/management-ui.properties.

Cette page liste les propriétés de l'UI classique documentées pour ui.properties, les propriétés équivalentes pour la nouvelle UI Edge et les propriétés de l'UI classique qui ne sont pas compatibles avec la nouvelle UI Edge.

La nouvelle interface utilisateur Edge utilise le même mécanisme de code avec configuration (CwC) que les autres composants Edge. Pour en savoir plus, consultez Configurer Edge.

Comparer les configurations de l'ancienne interface utilisateur et de la nouvelle interface utilisateur Edge

La nouvelle interface utilisateur Edge remplace le composant de l'ancienne interface utilisateur, le fichier de propriétés, le nom du service, le port par défaut et le format du certificat TLS. Consultez le tableau suivant pour mettre à jour vos scripts d'automatisation, vos règles de pare-feu et vos fichiers TLS avant de migrer vos propriétés :

Paramètre UI classique (4.53.01 et versions antérieures) Nouvelle interface utilisateur Edge (4.54.00)
Nom du composant edge-ui edge-management-ui
Fichier de propriétés /opt/apigee/customer/application/ui.properties /opt/apigee/customer/application/management-ui.properties
Commande de redémarrage apigee-service edge-ui restart apigee-service edge-management-ui restart
Port par défaut 9000 3001
Configuration TLS Fichier Java Keystore (JKS) Fichiers de certificat et de clé PEM. Consultez Configurer TLS pour la nouvelle interface utilisateur Edge.

Définir les propriétés de la nouvelle interface utilisateur Edge

Définissez les propriétés de configuration de la nouvelle interface utilisateur Edge dans /opt/apigee/customer/application/management-ui.properties et redémarrez le service edge-management-ui pour que vos modifications prennent effet.

Pour définir une propriété pour la nouvelle interface utilisateur Edge :

  1. Ouvrez le fichier management-ui.properties dans un éditeur. Si le fichier n'existe pas, créez-le : 
    vi /opt/apigee/customer/application/management-ui.properties
  2. Définissez la propriété. Exemple : 
    conf_uebe_disableGeoMap=true
  3. Enregistrez les modifications.
  4. Assurez-vous que le fichier appartient à l'utilisateur apigee : 
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  5. Redémarrez la nouvelle interface utilisateur Edge : 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart

Suivez ces règles de mise en forme lorsque vous définissez des propriétés pour la nouvelle interface utilisateur Edge :

  • Les noms de propriétés sont sensibles à la casse. Par exemple, conf_uebe_disableGeoMap est accepté, mais conf_uebe_disablegeomap ne l'est pas.
  • Placez les valeurs de chaîne entre guillemets doubles (par exemple, conf_uebe_branding_companyNameShort="My Company").
  • Ne mettez pas les valeurs booléennes (true ou false) ni les valeurs numériques entre guillemets. Si une valeur booléenne ou numérique est placée entre guillemets, la nouvelle interface utilisateur Edge ne démarre pas.

Pour vérifier la valeur actuelle d'une propriété, utilisez l'option -search. Exemple :

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \
  configure -search conf_uebe_disableGeoMap

Mapper les propriétés de l'UI classique vers la nouvelle UI Edge

Les tableaux suivants établissent une correspondance entre chaque propriété de l'interface utilisateur classique compatible dans ui.properties et sa propriété équivalente dans la nouvelle interface utilisateur Edge dans management-ui.properties. La colonne Par défaut affiche la valeur par défaut dans la nouvelle interface utilisateur Edge.

Configurer les propriétés de la fonctionnalité

Mappez les flags de fonctionnalité de l'UI classique aux propriétés conf_uebe_* correspondantes dans management-ui.properties :

Propriété de l'UI classique Nouvelle propriété de l'UI Edge Par défaut Remarques
conf_apigee_apigee.feature.disablegeomap conf_uebe_disableGeoMap false Définissez cette option sur true pour masquer les cartes géographiques. Dans l'UI classique d'Edge for Private Cloud, les cartes géographiques étaient désactivées par défaut. Si vous n'avez pas activé l'agrégation géographique, définissez cette propriété sur true. Consultez Activer l'agrégation géographique et les cartes géographiques.
conf_apigee_apigee.feature.disablepasswordreset conf_uebe_disablePasswordReset false Définissez cette option sur true pour masquer le lien Réinitialiser le mot de passe sur la page de connexion.
conf_apigee-base_apigee.feature.enableforcerangelimit conf_uebe_enableForceRangeLimit true Définissez la valeur sur false pour autoriser les rapports personnalisés pour une période de plus de 14 jours.
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses conf_uebe_trace_for_internal_addresses false Définissez cette option sur true pour autoriser l'outil Trace à envoyer des requêtes à des adresses IP locales ou internes.
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses conf_uebe_openapi_for_internal_addresses false Définissez la valeur sur true pour autoriser l'importation de spécifications OpenAPI à partir d'adresses IP locales ou internes.
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses conf_uebe_wsdl_for_internal_addresses false Définissez cette option sur true pour autoriser l'importation de fichiers WSDL à partir d'adresses IP locales ou internes.

Configurer les propriétés de session et TLS

Mappez le délai avant expiration de la session et les propriétés TLS de l'UI classique avec leurs équivalents dans la nouvelle UI Edge dans management-ui.properties :

Propriété de l'UI classique Nouvelle propriété de l'UI Edge Par défaut Remarques
conf_application_session.maxage conf_uebe_authsessiontimeout 12 (heures) Délai après lequel une session utilisateur expire après la connexion. Spécifiez un nombre d'heures (par exemple, 12 ou 0.5) ou une durée avec l'unité h (heures) ou m (minutes) (par exemple, 24h ou 90m). Les valeurs 12 et 12h sont équivalentes. L'unité d (jours) n'est pas acceptée. Par exemple, remplacez 1d par 24h. Si la valeur n'est pas valide, la valeur par défaut de 12 heures est utilisée et aucune erreur n'est signalée. S'applique aux sessions qui utilisent l'authentification de base.
conf_application_session.secure Aucune requise Non applicable La nouvelle interface utilisateur Edge définit automatiquement l'option Secure sur les cookies de session lorsque TLS est activé (conf_uebe_usehttps=true) ou lorsque TLS se termine sur un équilibreur de charge (conf_uebe_tlsoffload=true).
conf/application.conf+trustxforwarded conf_uebe_usehttps=true et conf_uebe_tlsoffload=true false Définissez les deux propriétés lorsque TLS se termine sur un équilibreur de charge. L'équilibreur de charge doit transférer les requêtes vers la nouvelle interface utilisateur Edge via HTTP et définir l'en-tête X-Forwarded-Proto. La commande configure-ssl définit ces propriétés lorsque MANAGEMENT_UI_SCHEME=https et MANAGEMENT_UI_TLS_OFFLOAD=y. Consultez Configurer TLS pour la nouvelle interface utilisateur Edge.
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate conf_uebe_skipverify false Définissez cette option sur true uniquement si le serveur de gestion utilise un certificat autosigné. Consultez la section Configurer TLS pour l'API de gestion.

Configurer les propriétés et les modèles d'e-mail

Mappez les propriétés de l'expéditeur, de l'objet, de l'image de marque, de l'URL de l'hôte et de l'expiration du lien de l'e-mail de l'interface utilisateur classique vers la nouvelle interface utilisateur Edge :

Propriété de l'UI classique Nouvelle propriété de l'UI Edge Par défaut Remarques
conf_apigee_apigee.mgmt.mailfrom conf_apigee_apigee.mgmt.mailfrom Apigee <sales@apigee.com> ou la valeur de SMTPMAILFROM spécifiée au moment de l'installation Non modifié.
conf_apigee-base_apigee.emails.passwordreset.subject conf_apigee_apigee.emails.passwordReset.subject Password Reset Request Notez le segment de propriété passwordReset en camelCase.
conf_apigee-base_apigee.emails.useraddedexisting.subject conf_apigee_apigee.emails.userAddedExisting.subject You Have Been Added to an Organization {organization} Notez le segment de propriété userAddedExisting en camelCase.
conf_apigee-base_apigee.emails.useraddednew.subject conf_apigee_apigee.emails.userAddedNew.subject An Account Has been Created for You at {companyNameShort} Notez le segment de propriété userAddedNew en camelCase.
conf_apigee_apigee.branding.companynameshort conf_uebe_branding_companyNameShort Apigee Définit la valeur de l'espace réservé {companyNameShort} dans les objets et les modèles d'e-mails.
conf_apigee_apigee.emails.hosturl conf_apigee_apigee.emails.hosturl Aucun Non modifié. Si cette option n'est pas définie, les liens de réinitialisation du mot de passe utilisent l'URL de la nouvelle interface utilisateur Edge spécifiée au moment de l'installation, et les liens d'invitation des utilisateurs utilisent le nom d'hôte de la requête. Définissez cette propriété si les utilisateurs accèdent à la nouvelle interface utilisateur Edge via un équilibreur de charge ou un nom DNS, par exemple conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com".
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds 600 S'applique aux liens de réinitialisation du mot de passe et aux liens d'invitation des utilisateurs.

La nouvelle interface utilisateur Edge utilise des modèles d'e-mails intégrés. Pour utiliser les modèles que vous avez personnalisés pour l'ancienne interface utilisateur :

  1. Créez le répertoire /opt/apigee/edge-management-ui/email-templates.
  2. Copiez vos fichiers password-reset.html, user-added-existing.html et user-added-new.html personnalisés depuis le répertoire de sauvegarde que vous avez créé avant la mise à jour (par exemple, /opt/apigee/customer/backup/) vers /opt/apigee/edge-management-ui/email-templates. Les noms de fichiers et les espaces réservés des modèles sont les mêmes que dans l'ancienne interface utilisateur.
  3. Assurez-vous que le répertoire et les fichiers appartiennent à l'utilisateur apigee.
  4. Redémarrez la nouvelle interface utilisateur Edge.

Pour en savoir plus, consultez Personnaliser les modèles d'e-mails Edge.

Configurer les propriétés du mot de passe généré automatiquement

Mappez les propriétés de mot de passe générées automatiquement de l'UI classique vers la nouvelle UI Edge :

Propriété de l'UI classique Nouvelle propriété de l'UI Edge Par défaut
conf_apigee-base_apigee.forgotPassword.underscore.minimum conf_apigee_apigee.forgotPassword.underscore.minimum 0
conf_apigee-base_apigee.forgotPassword.specialchars.minimum conf_apigee_apigee.forgotPassword.specialchars.minimum 0
conf_apigee-base_apigee.forgotPassword.lowecase.minimum conf_apigee_apigee.forgotPassword.lowecase.minimum 0
conf_apigee-base_apigee.forgotPassword.uppercase.minimum conf_apigee_apigee.forgotPassword.uppercase.minimum 0

Configurer la connexion au serveur de gestion et les propriétés du secret partagé

Mappez les propriétés de connexion, d'identifiants et de secret d'application du serveur de gestion de l'UI classique de Map vers la nouvelle UI Edge :

Propriété de l'UI classique Nouvelle propriété de l'interface utilisateur Edge Remarques
conf_apigee_apigee.mgmt.baseurl mgmt_baseurl URL de l'API Management, par exemple https://FQ_domain_name:port/v1. Ce nom de propriété ne commence pas par conf_. Si le serveur de gestion utilise un certificat autosigné, définissez également conf_uebe_skipverify=true.
conf_apigee_apigee.mgmt.credential conf_uebe_mgmtCredential Identifiants sysadmin chiffrés. Vous devez chiffrer à nouveau les identifiants pour la nouvelle interface utilisateur Edge à l'aide de ./bin/management-ui --encrypt. Pour en savoir plus, consultez Configuration requise pour différents identifiants d'administrateur système.
conf_apigee_mail.smtp.credential conf_apigee_mail.smtp.credential Identifiants SMTP chiffrés.
conf_application_application.secret conf_uebe_applicationsecret Secret utilisé pour chiffrer les identifiants et les cookies de session. Généré au moment de l'installation.

Supprimer les propriétés de l'UI classique qui ne nécessitent aucune action

Les propriétés suivantes de l'UI classique n'ont pas d'équivalent dans la nouvelle UI Edge, car le comportement est toujours activé. N'incluez pas ces propriétés dans management-ui.properties (et supprimez-les de tous les scripts de configuration automatisés) :

Propriété de l'UI classique Comportement dans la nouvelle interface utilisateur Edge
conf_apigee_apigee.feature.expireSessionCookiesInternally L'expiration de la session est toujours validée sur le serveur.
conf_apigee_apigee.feature.trackSessionCookies Les informations de session sont toujours stockées dans la mémoire du serveur. Si vous utilisez plusieurs instances de la nouvelle interface utilisateur Edge derrière un équilibreur de charge, configurez l'équilibreur de charge pour qu'il utilise des sessions persistantes.

Supprimer les propriétés de l'UI classique non compatibles

Les propriétés suivantes de l'UI classique ne sont pas compatibles et n'ont pas d'équivalent dans la nouvelle UI Edge. N'incluez pas ces propriétés dans management-ui.properties (et supprimez-les de tous les scripts de configuration automatisés) :

Propriété de l'UI classique Description
conf_apigee_apigee.feature.apitimeout, conf_apigee_play.ws.timeout.idle, conf_apigee_play.ws.timeout.connection Le délai avant expiration des appels d'API de gestion n'est pas configurable dans la nouvelle interface utilisateur Edge.
conf_application_http.proxyhost, conf_application_http.proxyport, conf_application_http.proxyuser, conf_application_http.proxypassword La nouvelle interface utilisateur Edge n'est pas compatible avec un proxy de transfert pour les requêtes de l'outil Trace.
conf_apigee-base_apigee.feature.enableconsentbanner, conf_apigee-base_apigee.consentbanner.buttoncaption, conf_apigee-base_apigee.consentbanner.body La bannière de consentement n'est pas compatible avec la nouvelle interface utilisateur Edge.
conf_apigee-base_apigee.feature.apiproxypaginationenabled, conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize Dans la nouvelle UI Edge, la liste des proxys d'API est toujours chargée dans les pages. La taille de la page n'est pas configurable.
conf_logger_settings_application_log_level, conf_logger_settings_play_log_level, conf_application_logger.application Le niveau de journalisation n'est pas configurable dans la nouvelle interface utilisateur Edge. Les fichiers journaux sont écrits dans /opt/apigee/var/log/edge-management-ui.
bin_setenv_min_mem, bin_setenv_max_mem, bin_setenv_meta_space_size, bin_setenv_ext_jvm_opts La nouvelle UI Edge ne s'exécute pas dans une machine virtuelle Java. Les paramètres de mémoire Java ne s'appliquent pas.

Examiner un exemple de migration

L'exemple suivant compare un fichier ui.properties de l'interface utilisateur classique au fichier management-ui.properties équivalent pour la nouvelle interface utilisateur Edge.

UI classique, /opt/apigee/customer/application/ui.properties :

conf_apigee_apigee.feature.disablegeomap=false
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses="true"
conf_application_session.maxage="1d"
conf_apigee-base_apigee.emails.passwordreset.subject="Reset your My Company password"
conf_apigee_apigee.branding.companynameshort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

Nouvelle UI Edge, /opt/apigee/customer/application/management-ui.properties :

conf_uebe_disableGeoMap=false
conf_uebe_trace_for_internal_addresses=true
conf_uebe_authsessiontimeout=24
conf_apigee_apigee.emails.passwordReset.subject="Reset your My Company password"
conf_uebe_branding_companyNameShort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

Notez que la valeur booléenne true n'est pas entourée de guillemets et que le délai avant expiration de la session 1d est remplacé par 24.

Après avoir enregistré le fichier, redémarrez la nouvelle interface utilisateur Edge :

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart

Checklist récapitulative

Utilisez la checklist suivante pour migrer vers la nouvelle interface utilisateur Edge dans Apigee Edge pour le cloud privé 4.54.00 :

  1. Sauvegardez /opt/apigee/customer/application/ui.properties et tous les modèles d'e-mails personnalisés de /opt/apigee/edge-ui/email-templates avant la mise à niveau.
  2. Ajoutez des propriétés mappées à /opt/apigee/customer/application/management-ui.properties sans mettre entre guillemets les valeurs booléennes ou numériques, et omettez les propriétés de l'UI classique non compatibles.
  3. Copiez les modèles d'e-mails personnalisés de votre répertoire de sauvegarde vers /opt/apigee/edge-management-ui/email-templates.
  4. Rechiffrez les identifiants de l'administrateur système avec ./bin/management-ui --encrypt si vous avez défini conf_uebe_mgmtCredential.
  5. Définissez la propriété du fichier sur apigee:apigee et redémarrez edge-management-ui.