New Edge Experience installieren

Edge for Private Cloud Version 4.19.01

In diesem Dokument wird beschrieben, wie Sie die New Edge-Umgebung für Edge für die Private Cloud installieren. New Edge ist die Benutzeroberfläche der nächsten Generation für Edge.

Wenn Sie New Edge in einer Edge for Private Cloud-Installation testen möchten, müssen Sie:

  • Aktivieren Sie SAML on Edge. New Edge unterstützt nur SAML als Authentifizierungsmechanismus.
  • Installieren Sie New Edge auf einem eigenen Knoten. Sie können sie nicht auf einem Knoten installieren, der andere Edge-Komponenten enthält, einschließlich des Knotens, auf dem sich die vorhandene Edge-Benutzeroberfläche befindet. Dies führt dazu, dass sich Benutzer nicht mehr bei der klassischen Edge-Benutzeroberfläche anmelden können.

Weitere Informationen zu New Edge finden Sie unter The New Edge Experience for Private Cloud.

Installation

Zum Installieren von New Edge für Edge für die Private Cloud führen Sie zwei verschiedene Installationsverfahren aus:

  • Installieren Sie die Basis-Edge-Benutzeroberfläche namens Schuhhorn und konfigurieren Sie die Basis-Edge-Benutzeroberfläche so, dass SAML zur Authentifizierung bei Edge verwendet wird.
  • Installieren Sie New Edge und konfigurieren Sie es so, dass SAML zur Authentifizierung bei Edge verwendet wird. Nachdem Sie New Edge installiert haben, können Sie sich anmelden und es für die Arbeit mit Edge verwenden.

Voraussetzungen für die Installation

  • Sie müssen SAML in Edge aktivieren, bevor Sie New Edge installieren. New Edge unterstützt nur SAML als Authentifizierungsmechanismus.

    Informationen zum Aktivieren von SAML on Edge finden Sie unter Unterstützung von SAML on Edge für Private Cloud.

  • New Edge unterstützt nur TLS v1.2. Da Sie über TLS eine Verbindung zum SAML-IdP herstellen, muss dieser daher TLS v1.2 unterstützen.

  • Sie müssen New Edge auf einem eigenen Knoten installieren. Sie können sie nicht auf einem Knoten installieren, der andere Edge-Komponenten enthält, einschließlich des Knotens, auf dem sich die vorhandene Edge-Benutzeroberfläche befindet.

    Der Knoten muss die folgenden Anforderungen erfüllen:

    • JAVA 1.8
    • 4 GB RAM
    • 2-Kern
    • 60 GB Speicherplatz
    • Sie müssen zuerst die Version 4.19.01 des Dienstprogramms apigee-setup auf dem Knoten installieren, wie unter Edge-Dienstprogramm für Apigee-Setup installieren beschrieben.
    • Port 3001 muss offen sein. Dies ist der Standardport, der für Anfragen an die New Edge verwendet wird. Wenn Sie den Port mithilfe der unten beschriebenen Attribute ändern, muss er offen sein.

Überlegungen vor der Installation von New Edge

Wie oben unter „Voraussetzungen“ beschrieben, müssen Sie für New Edge SAML on Edge aktivieren. Das bedeutet, dass die Nutzerauthentifizierung von einem SAML-IdP gesteuert wird, bei dem Sie den SAML-IdP so konfigurieren, dass E-Mail-Adressen als Nutzer-ID verwendet werden. Alle Nutzer von New Edge Experience müssen daher im SAML-IdP registriert sein.

Die klassische Edge-Benutzeroberfläche, die Standard-UI, die Sie mit Edge für die private Cloud installiert haben, erfordert kein SAML. Dabei kann entweder die SAML- oder die Basisauthentifizierung verwendet werden. Sie haben also folgende Möglichkeiten:

  • Aktivieren Sie die SAML-Unterstützung in Edge und sowohl in der klassischen Benutzeroberfläche als auch in New Edge.

    In diesem Szenario werden alle Nutzer der klassischen UI und von New Edge im SAML-IdP registriert. Informationen zum Hinzufügen neuer Nutzer zum SAML-IdP finden Sie unter Neue Edge-Nutzer registrieren.

  • Aktivieren Sie die SAML-Unterstützung in Edge, aber lassen Sie die Basisauthentifizierung aktiviert. New Edge verwendet SAML und die klassische Benutzeroberfläche weiterhin die Basisauthentifizierung.

    In diesem Szenario melden sich alle Nutzer der klassischen UI mit Anmeldedaten für die Basisauthentifizierung an, wobei ihre Anmeldedaten in der Edge-OpenLDAP-Datenbank gespeichert werden. Nutzer von New Edge Experience werden im SAML-IdP registriert und melden sich über SAML an.

    Nutzer der klassischen UI können sich jedoch erst bei New Edge anmelden, wenn Sie diesen Nutzer dem SAML-IdP hinzugefügt haben, wie unter Neue Edge-Nutzer registrieren beschrieben.

Änderungen an der Installationskonfiguration vorheriger Releases

Beachten Sie die folgenden Änderungen bezüglich des Installationsvorgangs aus der Betaversion von New Edge.

Änderungen an der Installationskonfiguration von Edge 4.18.05

Die Version Edge 4.19.01 der New Edge-Version enthält die folgenden Änderungen an der Konfigurationsdatei aus der Version Edge 4.18.05:

Art der Änderung Betroffene Unterkünfte
Entfernt 
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

Diese Eigenschaft hat den vordefinierten Wert von 0,5 (30 Minuten) und kann nicht geändert werden.
Hinzugefügt Sie können TLS jetzt mithilfe von Attributen in New Edge aktivieren. Weitere Informationen finden Sie unter TLS für die neue Edge-Umgebung konfigurieren.

Änderungen an der Installationskonfiguration von Edge 4.18.01

Die Version Edge 4.19.01 der New Edge-Version enthält die folgenden Änderungen an der Konfigurationsdatei aus der Version Edge 4.18.01:

Art der Änderung Betroffene Unterkünfte
Hinzugefügt 
# 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
Entfernt 
ROUTES_SHOEHORN
ROUTES_CLASSICUI
Ersetzt 
MANAGEMENT_UI_USE_HTTPS
Ersetzt durch: 
MANAGEMENT_UI_SCHEME

Konfigurationsdatei für die Installation

Die Konfigurationsdatei enthält alle Informationen, die zum Installieren und Konfigurieren der New Edge-Erfahrung erforderlich sind. Sie können dieselbe Konfigurationsdatei verwenden, um sowohl die Basis-UI als auch die New Edge-Umgebung zu installieren und zu konfigurieren.

Hier ein Beispiel für eine Konfigurationsdatei:

# 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"

Installieren Sie die Basis-Edge-Benutzeroberfläche (Schuhhorn)

Sie müssen die Basis-Edge-Benutzeroberfläche (shoehorn) installieren, bevor Sie New Edge installieren können.

So installieren Sie die Basis-UI:

  1. Installieren Sie die Version 4.19.01 des Dienstprogramms apigee-setup auf dem Knoten, wie unter Edge-Dienstprogramm für Apigee-Setup installieren beschrieben.
  2. Sauberkeit: 
    sudo yum clean all
  3. Erstellen Sie die Konfigurationsdatei wie oben beschrieben und achten Sie darauf, dass sie dem Nutzer „apigee“ gehört: 
    chown apigee:apigee configFile

    Dabei ist configFile die oben unter Konfigurationsdatei der Installation beschriebene Konfigurationsdatei.

  4. Ändern Sie den Wert des Attributs MANAGEMENT_UI_SSO_CSRF_SECRET in der Konfigurationsdatei in Ihr CSRF-Secret.
  5. Installieren Sie die Shoehorn-Version der Edge-Benutzeroberfläche: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. Konfigurieren Sie die Edge-UI: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. Aktivieren Sie SAML in der Edge-Benutzeroberfläche: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

New Edge installieren

Nach der Installation der Basis-Edge-Benutzeroberfläche können Sie die neue Edge-Benutzeroberfläche installieren und konfigurieren.

So installieren Sie New Edge:

  1. Installieren Sie New Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Wechseln Sie zum Verzeichnis edge-management-ui: 
    cd /opt/apigee/edge-management-ui
  3. Konfigurieren Sie New Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    Dabei ist configFile die oben unter Konfigurationsdatei der Installation beschriebene Konfigurationsdatei.

  4. Aktivieren Sie SAML in New Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. Melden Sie sich in New Edge an. Öffnen Sie dazu die folgende URL in einem Browser: 
    http://newEdgeExperienceIP:3001

    Dabei ist newEdgeExperienceIP die IP-Adresse des Knotens, auf dem die New Edge-Umgebung gehostet wird. Sie werden aufgefordert, Ihre SAML-Anmeldedaten einzugeben. Nach der Eingabe Ihrer Anmeldedaten wird New Edge angezeigt.

  6. Weitere Informationen finden Sie unter The New Edge Experience for Private Cloud, einschließlich Links für Informationen zur Verwendung von New Edge.

New Edge deinstallieren

So deinstallieren Sie New Edge:

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

So deinstallieren Sie die Basis-Edge-Benutzeroberfläche (Schuhhorn):

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

So entfernen Sie Edge vollständig aus dem Knoten:

  1. Beenden Sie alle auf dem Computer ausgeführten Edge-Dienste: 
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. Leeren Sie den Yum-Cache: 
    sudo yum clean all
  3. Entfernen Sie alle Apigee-RPMs: 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. Entfernen Sie das Installationsstammverzeichnis: 
    sudo rm -rf /opt/apigee