Installer la nouvelle expérience périphérique

Edge pour Private Cloud v4.19.01

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

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

  • Activer SAML sur Edge L'expérience New Edge prend uniquement en charge SAML comme sur le mécanisme d'attention.
  • Installez la nouvelle expérience Edge sur son propre nœud. Vous ne pouvez pas l'installer sur un nœud contient d'autres composants Edge, y compris le nœud sur lequel réside l'interface utilisateur Edge existante. Cela empêcherait les utilisateurs de se connecter à l'interface utilisateur Edge classique.

Pour en savoir plus sur l'expérience New Edge, consultez La nouvelle expérience Edge pour Private Cloud.

Présentation de l'installation

Pour installer la nouvelle expérience Edge pour Edge pour le cloud privé, vous effectuer deux processus d'installation différents:

  • Installez l'interface utilisateur Edge de base, appelée shoehorn, et configurez la base Interface utilisateur Edge pour utiliser SAML pour s'authentifier auprès de Edge.
  • Installez la nouvelle expérience Edge et configurez-la pour utiliser SAML pour s'authentifier auprès de Edge. Après avoir installé l'expérience New 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 l'expérience New Edge. The New Edge ne prend en charge que SAML comme mécanisme d'authentification.

    Pour plus d'informations sur l'activation de SAML sur Edge, consultez Compatibilité avec SAML sur Edge pour Private Cloud

  • L'expérience New Edge n'est compatible qu'avec TLS v1.2. Comme vous vous connectez à l'IdP SAML via TLS, votre IdP SAML doit donc prendre en charge TLS v1.2.

  • 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, y compris le nœud sur lequel l'interface utilisateur Edge existante se trouve.

    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.19.01 de l'utilitaire apigee-setup sur au nœud comme décrit dans la section Installer le point de terminaison utilitaire de configuration apigee.
    • Le port 3001 doit être ouvert. Il s'agit du port par défaut utilisé pour les requêtes adressées à l'expérience New Edge. Si vous modifiez le port à l'aide des propriétés décrites ci-dessous, assurez-vous qu'il est ouvert.

Points à prendre en considération avant d'installer la nouvelle version Expérience en périphérie

Comme décrit ci-dessus dans les prérequis, l'expérience New Edge nécessite que vous activiez SAML sur Edge. Cela signifie que l'authentification des utilisateurs est contrôlée par un IdP SAML, dans lequel vous configurez le IdP pour utiliser les adresses e-mail comme ID utilisateur. Tous les utilisateurs de New Edge Experience doivent donc enregistré auprès de l'IdP SAML.

L'interface utilisateur classique Edge, l'interface utilisateur par défaut que vous avez installée avec Edge pour le cloud privé, ne n'exigent pas SAML. Elle peut utiliser l'authentification SAML ou l'authentification de base. Vous pouvez donc:

  • Activer la prise en charge SAML sur Edge et à la fois dans l'interface utilisateur classique et dans l'expérience New Edge.

    Dans ce scénario, tous les utilisateurs de l'interface utilisateur classique et de la nouvelle expérience Edge sont enregistrés dans l'IdP SAML. Pour en savoir plus sur l'ajout de nouveaux utilisateurs à l'IdP SAML, consultez Enregistrez de nouveaux utilisateurs Edge.

  • Activer la prise en charge SAML sur Edge, mais laisser l'authentification de base activée. L'expérience New Edge utilise SAML et l'UI classique utilisent 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 informations d’identification sont stockées dans la base de données Edge OpenLDAP. Les utilisateurs de la nouvelle expérience Edge sont enregistré dans l'IdP SAML et se connecter avec SAML.

    Cependant, un utilisateur de l'interface utilisateur classique ne peut pas se connecter à l'expérience New Edge tant que vous n'avez pas ajouté cette à l'IdP SAML, comme décrit dans Enregistrer un nouveau périphérique utilisateurs.

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

Tenez compte des modifications suivantes apportées à la procédure d'installation à partir de la version bêta de l'expérience New Edge.

Modifications de la configuration d'installation par rapport à Edge 4.18.05

La version 4.19.01 de la nouvelle expérience Edge contient les modifications suivantes apportées au de configuration à partir de la version Edge 4.18.05:

Type de modification Propriétés concernées
Supprimée 
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

Cette propriété a une valeur prédéfinie de 0,5 (30 minutes) et ne peut pas être modifiée.
Ajouté Vous pouvez désormais utiliser des propriétés pour activer TLS dans l'expérience New Edge. Pour en savoir plus, consultez Configuration de TLS pour la nouvelle expérience Edge.

Modifications de la configuration d'installation par rapport à Edge 4.18.01

La version 4.19.01 de la nouvelle expérience Edge contient les modifications suivantes apportées au de configuration à partir de la version Edge 4.18.01:

Type de modification Propriétés concernées
Ajouté 
# Shoehorn UI configurations.
SHOEHORN_SCHEME
SHOEHORN_IP
SHOEHORN_PORT

# Classic UI configurations.
CLASSIC_UI_SCHEME
CLASSIC_UI_IP
CLASSIC_UI_PORT

# Information about Edge SSO module.
MANAGEMENT_UI_SKIP_VERIFY
Supprimée 
ROUTES_SHOEHORN
ROUTES_CLASSICUI
Remplacée 
MANAGEMENT_UI_USE_HTTPS
Remplacée par: 
MANAGEMENT_UI_SCHEME

Fichier de configuration de l'installation

Le fichier de configuration contient toutes les informations nécessaires à l'installation et à la configuration de la nouvelle Expérience en périphérie Vous pouvez utiliser le même fichier de configuration pour installer et configurer les deux et l'expérience New 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

#
# New Edge experience configuration.
#

# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the New Edge experience.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
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=CHANGE_TO_YOUR_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 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

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the New Edge experience.
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 New Edge experience.
#

# 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 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".
SSO_PUBLIC_URL_SCHEME=http
# MANAGEMENT_UI_SKIP_VERIFY=y
# 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 (corne d'eau)

Vous devez installer l'interface utilisateur Edge de base, appelée shoehorn, avant de pouvoir installer la nouvelle Expérience en périphérie

Pour installer l'interface utilisateur de base:

  1. Installez la version 4.19.01 de l'utilitaire apigee-setup sur le nœud en tant que décrit dans la section Installer le package Edge apigee-setup utilitaire.
  2. Clean Yum: 
    sudo yum clean all
  3. Créez le fichier de configuration tel que décrit ci-dessus et assurez-vous qu'il appartient à "apigee" utilisateur: 
    chown apigee:apigee configFile

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

  4. Modifiez la valeur de la propriété MANAGEMENT_UI_SSO_CSRF_SECRET dans la configuration à votre secret CSRF.
  5. Installez la version Chausse-pied de l'interface utilisateur Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. Configurez l'interface utilisateur Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. Activez SAML sur l'interface utilisateur Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

Installer l'expérience New Edge

Après avoir installé l'interface utilisateur Edge de base, vous pouvez ensuite installer et configurer New Edge expérience.

Pour installer l'expérience New Edge:

  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 d'installation.

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

    où newEdgeExperienceIP est l'adresse IP du nœud hébergeant le nœud l'expérience New Edge. Vous êtes invité à saisir vos identifiants SAML. Après avoir saisi votre les identifiants, l'expérience New Edge s'affiche.

  6. Découvrez le nouveau Edge Experience pour le cloud privé pour en savoir plus, y compris les liens pour des informations sur l'utilisation de l'expérience New Edge.

Désinstaller l'expérience New Edge

Pour désinstaller l'expérience New Edge:

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

Pour désinstaller l'interface utilisateur Edge de base (corne d'eau):

/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 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 d'installation: 
    sudo rm -rf /opt/apigee