Installer la nouvelle expérience Edge (bêta)

Edge for Private Cloud v4.18.01

Ce document explique comment installer la version bêta de la nouvelle expérience Edge pour Edge for Private Cloud. La nouvelle expérience Edge est l'interface utilisateur de nouvelle génération pour Edge.

Pour essayer la nouvelle expérience Edge dans une installation Edge for Private Cloud, vous devez :

  • Activez SAML sur Edge. La nouvelle interface Edge n'accepte que SAML comme mécanisme d'authentification.
  • Installez la nouvelle expérience Edge sur son propre nœud. Vous ne pouvez pas l'installer sur un nœud contenant d'autres composants Edge.

Pour en savoir plus sur la nouvelle interface Edge, consultez La nouvelle interface Edge pour Private Cloud.

Présentation de l'installation

Pour installer la version bêta de la nouvelle expérience Edge pour Edge for Private Cloud, vous devez effectuer deux processus d'installation différents :

  • Installez l'interface utilisateur Edge de base, appelée shoehorn, et configurez-la pour qu'elle utilise SAML pour s'authentifier auprès d'Edge.
  • Installez la nouvelle expérience Edge et configurez-la pour utiliser SAML pour l'authentification avec Edge. Après avoir installé la nouvelle expérience Edge, vous pouvez vous connecter et l'utiliser pour travailler avec Edge.

Conditions requises pour l'installation

  • Vous devez activer SAML sur Edge avant d'installer la nouvelle expérience Edge. La nouvelle interface Edge n'est compatible qu'avec SAML comme mécanisme d'authentification.

    Remarque : Dans un environnement hors production, vous pouvez laisser l'authentification de base activée sur Edge afin que les utilisateurs de l'UI classique et de l'API Edge puissent toujours utiliser l'authentification de base.

    Pour en savoir plus sur l'activation de SAML sur Edge, consultez Prendre en charge SAML sur Edge pour Private Cloud.
  • Vous devez installer la nouvelle expérience Edge sur son propre nœud. Vous ne pouvez pas l'installer sur un nœud contenant d'autres composants Edge. Le nœud 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.18.01 de l'utilitaire apigee-setup sur le nœud, comme décrit dans Installer l'utilitaire apigee-setup d'Edge.

Éléments à prendre en compte avant d'installer la nouvelle expérience Edge

Comme décrit ci-dessus dans les conditions préalables, la nouvelle expérience Edge nécessite l'activation de SAML sur Edge. Cela signifie que l'authentification des utilisateurs est contrôlée par un IdP SAML, que vous configurez pour utiliser les adresses e-mail comme ID utilisateur. Tous les utilisateurs de la nouvelle expérience Edge doivent donc être enregistrés dans le fournisseur d'identité SAML.

L'UI classique d'Edge, l'UI par défaut que vous avez installée avec Edge pour Private Cloud, ne nécessite pas SAML. Il peut utiliser l'authentification SAML ou l'authentification de base. Vous pouvez donc :

  • Activez la compatibilité SAML sur Edge, ainsi que sur l'UI classique et la nouvelle expérience Edge.

    Dans ce scénario, tous les utilisateurs de l'interface utilisateur classique et de la nouvelle expérience Edge sont enregistrés dans le fournisseur d'identité SAML. Pour en savoir plus sur l'ajout d'utilisateurs au fournisseur d'identité SAML, consultez la section Enregistrer de nouveaux utilisateurs Edge.
  • Activez la compatibilité SAML sur Edge, mais laissez l'authentification de base activée. La nouvelle expérience Edge utilise SAML, 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 OpenLDAP d'Edge. Les utilisateurs de la nouvelle expérience Edge sont enregistrés dans le fournisseur d'identité SAML et se connectent à l'aide de SAML.

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

Fichier de configuration de l'installation

Le fichier de configuration contient toutes les informations nécessaires pour installer et configurer la nouvelle expérience Edge. Vous pouvez utiliser le même fichier de configuration pour installer et configurer l'UI de base et la nouvelle expérience Edge.

Voici un exemple de fichier de configuration :

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

# IP of the New Edge experience node.
IP2=22.222.222.222 

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

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

# URLs for the different UIs.
# URL of classic Edge UI.
ROUTES_CLASSICUI="http://$IP1:9000"
# URL of New Edge experience.
ROUTES_SHOEHORN="http://$IP2:9000"

# New Edge experience configuration.
# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Access port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_APP_ENV=OPDK
MANAGEMENT_UI_IP=$IP2
# Disable TLS on the New Edge experience.
# This release does not support TLS.
MANAGEMENT_UI_USE_HTTPS=n

# SSO configuration for the New Edge experience.
MANAGEMENT_UI_SSO_ENABLED=y
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y
MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=secret111

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=http://$IP2:3001
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=secret222
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=24
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS=0.5

# Edge SSO configuration.
# Some settings are for the classic UI, 
# but are still required to configure the New Edge experience.
# Enable SSO.
EDGEUI_SSO_ENABLED=y

# Information about Classic UI
EDGEUI_PUBLIC_URIS=http://$IP1:9000
# Information about publicly accessible URL for Classic UI.
EDGEUI_SSO_REGISTERED_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS
# 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 SAML on the classic Edge 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

# Information about Edge SSO module.
# 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 Edge SSO module.
# If Edge SSO uses a self-signed cert, you must also set MANAGEMENT_UI_SKIP_VERIFY to "y".
# MANAGEMENT_UI_SKIP_VERIFY=y
SSO_PUBLIC_URL_SCHEME=http
# SSO admin credentials as set when you installed Edge SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

# Required SMTP information.
SKIP_SMTP=n       # Skip now and configure later by specifying "y".
SMTPHOST=smtp.gmail.com
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
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 de base (shoehorn)

Vous devez installer l'interface utilisateur Edge de base, appelée shoehorn, avant de pouvoir installer la nouvelle expérience Edge.

Pour installer l'UI de base :

  1. Installez la version 4.18.01 de l'utilitaire apigee-setup sur le nœud, comme décrit dans Installer l'utilitaire apigee-setup d'Edge.
  2. Nettoyez Yum : 
    > sudo yum clean all
  3. Créez le fichier de configuration comme décrit ci-dessus et assurez-vous qu'il appartient à l'utilisateur "apigee" : 
    > chown apigee:apigee configFile

    où configFile est le fichier de configuration décrit ci-dessus dans Fichier de configuration de l'installation.

  4. Installez la version Shoehorn de l'interface utilisateur Edge : 
    > /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  5. Configurez l'interface utilisateur Edge : 
    > /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  6. Activez SAML sur l'interface utilisateur Edge : 
    > /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

Installer la nouvelle expérience Edge

Après avoir installé l'interface utilisateur Edge de base, vous pouvez installer et configurer la nouvelle interface utilisateur Edge.

Pour installer la nouvelle expérience Edge, procédez comme suit :

  1. Installez la nouvelle expérience Edge : 
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Accédez au répertoire edge-management-ui : 
    > cd /opt/apigee/edge-management-ui
  3. Configurez la nouvelle expérience Edge : 
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    où configFile est le fichier de configuration décrit ci-dessus dans Fichier de configuration de l'installation.

  4. Activez SAML sur la nouvelle expérience Edge : 
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. Connectez-vous à la nouvelle expérience Edge en ouvrant l'URL suivante dans un navigateur : 
    http://newEdgeExperienceIP:3001

    où newEdgeExperienceIP est l'adresse IP du nœud hébergeant la nouvelle expérience Edge. Vous serez invité à saisir vos identifiants SAML. Après avoir saisi vos identifiants, la nouvelle interface Edge s'affiche.

  6. Pour en savoir plus, consultez La nouvelle expérience Edge pour Private Cloud (bêta), qui inclut des liens vers des informations sur l'utilisation de la nouvelle expérience Edge.

Désinstaller la nouvelle expérience Edge

Pour désinstaller la nouvelle expérience Edge :

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

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

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

Pour supprimer complètement Edge du nœud :

  1. Arrêtez tous les services Edge exécutés 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-|baas)")
  4. Supprimez le répertoire racine de l'installation : 
    > sudo rm -rf /opt/apigee