Installer la nouvelle interface utilisateur Edge

Ce document explique comment installer l'interface utilisateur Edge pour Apigee Edge pour le cloud privé. L'interface utilisateur Edge est la nouvelle génération d'interface utilisateur pour Edge.

Prérequis

Pour essayer la nouvelle interface utilisateur Edge dans une installation Apigee Edge pour le cloud privé, vous devez :

  • Installez l'interface utilisateur Edge sur son propre nœud. Vous ne pouvez pas l'installer sur un nœud contenant d'autres composants Edge, y compris le nœud sur lequel réside l'UI classique existante. Cela empêchera les utilisateurs de se connecter à l'UI classique.

    Le nœud de l'UI Edge doit répondre aux exigences suivantes :

    • JAVA 1.8
    • 4 Go de RAM
    • 2 cœurs
    • 60 Go d'espace disque
    • Vous devez d'abord installer la version 4.53.01 de l'utilitaire apigee-setup sur le nœud, comme décrit dans Installer l'utilitaire apigee-setup Edge.
    • Le port 3001 doit être ouvert. Il s'agit du port par défaut utilisé pour les requêtes adressées à l'interface utilisateur Edge. Si vous modifiez le port à l'aide des propriétés décrites dans Nouveau fichier de configuration UE, assurez-vous que le port est ouvert.
  • Activez un IDP externe sur Edge. L'interface utilisateur Edge est compatible avec SAML ou LDAP comme mécanisme d'authentification.
  • (Fournisseur d'identité SAML uniquement) L'interface utilisateur Edge n'est compatible qu'avec TLS v1.2. Étant donné que vous vous connectez à l'IdP SAML via TLS, si vous utilisez SAML, votre IdP doit donc être compatible avec TLS v1.2.

Pour en savoir plus sur l'UI Edge, consultez La nouvelle UI Edge pour le cloud privé.

Présentation de l'installation

Globalement, le processus d'installation de l'interface utilisateur Edge pour Apigee Edge pour Private Cloud est le suivant :

  • Ajouter un nœud à votre cluster
  • Se connecter au nouveau nœud
  • Télécharger l'utilitaire apigee-setup
  • Créez un fichier de configuration et modifiez-le avec vos paramètres.
  • Exécuter l'utilitaire apigee-setup
  • Se connecter et tester la nouvelle UE

Lorsqu'il est exécuté sur le nouveau nœud, l'utilitaire apigee-setup :

  • Installe l'interface utilisateur classique de base, appelée shoehorn, et configure l'interface utilisateur classique pour qu'elle utilise un IdP externe pour l'authentification avec Edge.
  • Installe la nouvelle interface utilisateur Edge et la configure pour qu'elle utilise votre fournisseur d'identité externe pour l'authentification avec Edge.

Éléments à prendre en compte avant d'installer la nouvelle interface utilisateur Edge

Comme décrit ci-dessus dans les conditions préalables, l'interface utilisateur Edge nécessite que vous activiez un IdP externe sur Edge. Cela signifie que l'authentification des utilisateurs est contrôlée par le fournisseur d'identité, où vous la configurez pour qu'elle utilise les adresses e-mail comme ID utilisateur. Tous les utilisateurs de l'interface utilisateur Edge doivent donc être enregistrés dans le fournisseur d'identité.

L'UI classique, l'UI par défaut que vous avez installée avec Apigee Edge pour le cloud privé, ne nécessite pas d'IdP externe. Il peut utiliser un IdP ou l'authentification de base. Vous pouvez donc :

  • Activez la compatibilité avec les fournisseurs d'identité externes sur Edge, ainsi que sur l'ancienne et la nouvelle interface utilisateur.

    Dans ce scénario, tous les utilisateurs de l'UI classique et de l'UI Edge sont enregistrés dans le fournisseur d'identité. Pour savoir comment ajouter des utilisateurs à l'IdP, consultez Enregistrer de nouveaux utilisateurs Edge.

  • Activez la compatibilité avec les IdP externes sur Edge, mais laissez l'authentification de base activée. L'interface utilisateur Edge utilise l'IdP, tandis que l'interface utilisateur classique utilise toujours l'authentification de base.

    Dans ce scénario, tous les utilisateurs de l'UI classique se connectent avec des identifiants d'authentification de base, où leurs identifiants sont stockés dans la base de données Edge SymasLDAP. Les utilisateurs de l'interface utilisateur Edge sont enregistrés dans le fournisseur d'identité et se connectent à l'aide de SAML ou LDAP.

    Toutefois, un utilisateur de l'UI classique ne peut pas se connecter à l'UI Edge tant que vous ne l'avez pas ajouté au fournisseur d'identité, comme décrit dans Enregistrer de nouveaux utilisateurs Edge.

Modifications de la configuration de l'installation par rapport aux versions précédentes

Tenez compte des modifications suivantes apportées à la procédure d'installation par rapport aux versions bêta de l'interface utilisateur Edge.

Nouveau fichier de configuration de l'interface utilisateur Edge

Le fichier de configuration suivant contient toutes les informations nécessaires pour installer et configurer la nouvelle interface utilisateur Edge. Vous pouvez utiliser le même fichier de configuration pour installer et configurer l'interface utilisateur shoehorn/Classic et l'interface utilisateur Edge.

# IP of the Edge Management Server.
# This node also hosts the Apigee SSO module and the current, or Classic, UI.
IP1=management_server_IP

# IP of the Edge UI node.
IP2=edge_UI_server_IP

# Edge sys admin credentials.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=your_password    # If omitted, you are prompted for it.

# Edge Management Server information.
APIGEE_PORT_HTTP_MS=8080
MSIP=$IP1
MS_SCHEME=http

#
# Edge UI configuration.
#

# Enable the Edge UI.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the Edge UI.
# The management UI port must be open for requests to the Edge UI
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Set to 'OPDK' to specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the Edge UI.
MANAGEMENT_UI_SCHEME=http

# Location of Edge UI.
MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=YOUR_CSRF_SECRET
# Duration of CSRF token.
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
# Defaults to 8760 hours, or 365 days.
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=8760

## SSO configuration for the Edge UI.
MANAGEMENT_UI_SSO_ENABLED=y

# Only required if MANAGEMENT_UI_SSO_ENABLED is 'y'
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y

MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=your_client_sso_secret

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the Edge UI.
SHOEHORN_SCHEME=http
SHOEHORN_IP=$MANAGEMENT_UI_IP
SHOEHORN_PORT=9000

#
# Edge Classic UI configuration.
# Some settings are for the Classic UI, but are still required to configure the Edge UI.
#

# These settings assume that Classic UI is installed on the Management Server.
CLASSIC_UI_IP=$MSIP
CLASSIC_UI_PORT=9000
CLASSIC_UI_SCHEME=http
EDGEUI_PUBLIC_URIS=$CLASSIC_UI_SCHEME://$CLASSIC_UI_IP:$CLASSIC_UI_PORT

# Information about publicly accessible URL for Classic UI.
EDGEUI_SSO_REGISTERED_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS

# Enable SSO
EDGEUI_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso.
# The default client name is 'edgeui'.
# Apigee recommends that you use the same settings as you used
# when enabling your IDP on the Classic UI.
EDGEUI_SSO_CLIENT_NAME=edgeui
# Oauth client password using uppercase, lowercase, number, and special chars.
EDGEUI_SSO_CLIENT_SECRET=ssoClient123
# If set, existing EDGEUI client will deleted and new one will be created.
EDGEUI_SSO_CLIENT_OVERWRITE=y

# Apigee SSO Component configuration
# Externally accessible IP or DNS of Edge SSO module.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on the Apigee SSO module.
# If Apigee SSO uses a self-signed cert, you must also set MANAGEMENT_UI_SKIP_VERIFY to "y".
SSO_PUBLIC_URL_SCHEME=http
# MANAGEMENT_UI_SKIP_VERIFY=y
# SSO admin credentials as set when you installed Apigee SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=your_sso_admin_secret

#
##      SSO Configuration (define external IDP)           #
#
# Use one of the following configuration blocks to        #
# define your IDP settings:                               #
#  - SAML configuration properties                        #
#  - LDAP Direct Binding configuration properties         #
#  - LDAP Indirect Binding configuration properties       #

INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect)

## SMTP Configuration (required)
#
SKIP_SMTP=n       # Skip now and configure later by specifying "y".
SMTPHOST=smtp.gmail.com
SMTPUSER=your@email.com
SMTPPASSWORD=your_email_password
SMTPSSL=y
SMTPPORT=465      # If no SSL, use a different port, such as 25.
SMTPMAILFROM="My Company myco@company.com"

Installer l'interface utilisateur Edge

Après avoir créé et modifié le fichier de configuration, vous pouvez installer la nouvelle interface utilisateur Edge sur ce nouveau nœud.

Pour installer l'UI Edge :

  1. Ajoutez un nœud à votre cluster.
  2. Connectez-vous au nouveau nœud en tant qu'administrateur.
  3. Installez la version 4.53.01 de l'utilitaire apigee-setup sur le nœud, comme décrit dans Installer l'utilitaire Edge apigee-setup.
  4. Nettoyez toutes les informations mises en cache avec Yum en exécutant la commande suivante : 
    sudo yum clean all
  5. Créez le fichier de configuration comme décrit dans Nouveau fichier de configuration de l'interface utilisateur Edge et assurez-vous qu'il appartient à l'utilisateur "apigee" : 
    chown apigee:apigee configFile

    Veillez à apporter les modifications suivantes au fichier de configuration :

    • Modifiez la valeur de la propriété MANAGEMENT_UI_SSO_CSRF_SECRET dans le fichier de configuration en la remplaçant par votre secret CSRF.
    • Configurez Edge pour qu'il utilise l'un des éléments suivants (la nouvelle interface utilisateur Edge nécessite un IdP externe) :
      • SAML
      • LDAP

      Pour en savoir plus, consultez Présentation de l'authentification des IdP externes.

  6. Configurez votre IdP externe avec les utilisateurs auxquels vous souhaitez accorder l'accès à l'interface utilisateur Edge. Pour en savoir plus, consultez Enregistrer de nouveaux utilisateurs Edge.
  7. Sur le nouveau nœud, exécutez la commande suivante : 
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

    L'utilitaire apigee-setup installe l'UI classique. En plus de l'UI classique, le programme d'installation installe ensuite l'UI Edge.

  8. Connectez-vous à l'interface utilisateur Edge en ouvrant l'URL suivante dans un navigateur : 
    http://new_edge_UI_IP:3001

    Où new_edge_UI_IP est l'adresse IP du nœud hébergeant la nouvelle interface utilisateur Edge.

    Edge vous invite à saisir les identifiants de votre fournisseur d'identité externe.

  9. Saisissez vos identifiants.

    La nouvelle interface utilisateur Edge s'affiche. Pour savoir comment utiliser l'interface utilisateur Edge, consultez La nouvelle interface utilisateur Edge pour le cloud privé.

    Si l'interface utilisateur Edge ne s'affiche pas, assurez-vous que le port 3001 est ouvert aux connexions externes.

Désinstaller la nouvelle interface utilisateur

Pour désinstaller la nouvelle UI de son nœud, vous devez désinstaller à la fois la nouvelle UI Edge et l'UI classique de base (shoehorn) qui a été installée sur le nœud lors du processus d'installation de l'UI.

Pour désinstaller la nouvelle interface utilisateur Edge :

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

Pour désinstaller l'UI classique de base (shoehorn) :

/opt/apigee/apigee-service/bin/apigee-service edge-ui uninstall

Pour supprimer tous les composants Edge du nœud :

  1. Arrêtez tous les services Edge en cours d'exécution sur la machine : 
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. Videz le cache yum : 
    sudo yum clean all
  3. Supprimez tous les RPM Apigee : 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. Supprimez le répertoire racine de l'installation : 
    sudo rm -rf /opt/apigee