New Edge Experience installieren

Edge for Private Cloud v4.19.01

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

Wenn Sie die neue Edge-Umgebung in einer Edge for Private Cloud-Installation ausprobieren möchten, müssen Sie Folgendes tun:

  • Aktivieren Sie SAML in Edge. Die neue Edge-Umgebung unterstützt nur SAML als Authentifizierungsmechanismus.
  • Installieren Sie die neue Edge-Umgebung auf einem eigenen Knoten. Sie können es 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 Nutzer nicht mehr in der klassischen Edge-Benutzeroberfläche anmelden können.

Weitere Informationen zur neuen Edge-Umgebung finden Sie unter Neue Edge-Umgebung für Private Cloud.

Installation

Wenn Sie die neue Edge-Umgebung für Edge for Private Cloud installieren möchten, führen Sie zwei verschiedene Installationsprozesse aus:

  • Installieren Sie die Edge-Basis-UI, die als shoehorn bezeichnet wird, und konfigurieren Sie die Edge-Basis-UI für die Verwendung von SAML zur Authentifizierung bei Edge.
  • Installieren Sie die neue Edge-Umgebung und konfigurieren Sie sie so, dass SAML für die Authentifizierung bei Edge verwendet wird. Nach der Installation der neuen Edge-Umgebung können Sie sich anmelden und mit Edge arbeiten.

Voraussetzungen für die Installation

  • Sie müssen SAML in Edge aktivieren, bevor Sie die neue Edge-Umgebung installieren. Die neue Edge-Umgebung unterstützt nur SAML als Authentifizierungsmechanismus.

    Informationen zum Aktivieren von SAML in Edge finden Sie unter SAML in Edge for Private Cloud unterstützen.

  • Die neue Edge-Umgebung unterstützt nur TLS v1.2. Da Sie über TLS eine Verbindung zum SAML-IdP herstellen, muss Ihr SAML-IdP TLS v1.2 unterstützen.

  • Sie müssen die neue Edge-Umgebung 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-Core
    • 60 GB Speicherplatz
    • Sie müssen zuerst die Version 4.19.01 des Dienstprogramms apigee-setup auf dem Knoten installieren, wie unter Edge-Dienstprogramm „apigee-setup“ installieren beschrieben.
    • Port 3001 muss geöffnet sein. Dies ist der Standardport für Anfragen an die neue Edge-Umgebung. Wenn Sie den Port mit den unten beschriebenen Attributen ändern, muss dieser Port geöffnet sein.

Überlegungen vor der Installation der neuen Edge-Umgebung

Wie oben in den Voraussetzungen beschrieben, müssen Sie für die neue Edge-Umgebung SAML in Edge aktivieren. Das bedeutet, dass die Nutzerauthentifizierung von einem SAML-IdP gesteuert wird, wobei Sie den SAML-IdP so konfigurieren, dass E-Mail-Adressen als Nutzer-ID verwendet werden. Alle Nutzer der neuen Edge-Umgebung müssen daher im SAML-IdP registriert sein.

Die klassische Edge-Benutzeroberfläche, die Standard-Benutzeroberfläche, die Sie mit Edge for Private Cloud installiert haben, erfordert kein SAML. Es kann entweder SAML oder die Standardauthentifizierung verwendet werden. Das bedeutet, dass Sie Folgendes tun können:

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

    In diesem Szenario sind alle Nutzer der klassischen UI und der neuen Edge-Umgebung 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, lassen Sie aber die Standardauthentifizierung aktiviert. Die neue Edge-Umgebung verwendet SAML und die klassische Benutzeroberfläche verwendet weiterhin die Basisauthentifizierung.

    In diesem Szenario melden sich alle Nutzer der klassischen UI mit einfachen Authentifizierungsdaten an, wobei ihre Anmeldedaten in der Edge OpenLDAP-Datenbank gespeichert werden. Nutzer der neuen Edge-Umgebung sind im SAML-IdP registriert und melden sich mit SAML an.

    Ein Nutzer der klassischen Benutzeroberfläche kann sich jedoch erst in der neuen Edge-Umgebung anmelden, wenn Sie ihn dem SAML-IdP hinzugefügt haben, wie unter Neue Edge-Nutzer registrieren beschrieben.

Änderungen an der Installationskonfiguration gegenüber früheren Releases

Beachten Sie die folgenden Änderungen am Installationsverfahren aus der Betaversion der neuen Edge-Umgebung.

Änderungen der Installationskonfiguration ab Edge 4.18.05

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

Art der Änderung Betroffene Unterkünfte
Entfernt 
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

Diese Property hat einen vordefinierten Wert von 0,5 (30 Minuten) und kann nicht geändert werden.
Hinzugefügt Sie können jetzt Attribute verwenden, um TLS in der neuen Edge-Umgebung zu aktivieren. Weitere Informationen finden Sie unter TLS für die neue Edge-Umgebung konfigurieren.

Änderungen der Installationskonfiguration ab Edge 4.18.01

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

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

Installationskonfigurationsdatei

Die Konfigurationsdatei enthält alle Informationen, die für die Installation und Konfiguration der neuen Edge-Umgebung erforderlich sind. Sie können dieselbe Konfigurationsdatei verwenden, um sowohl die Basis-UI als auch die neue Edge-Umgebung zu installieren und zu konfigurieren.

Hier ist eine Beispielkonfigurationsdatei:

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

Edge-Basis-UI installieren (Shoehorn)

Sie müssen die Edge-Basis-UI mit dem Namen shoehorn installieren, bevor Sie die neue Edge-Umgebung 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 „apigee-setup“ installieren beschrieben.
  2. Yum bereinigen: 
    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 Konfigurationsdatei, die oben unter Konfigurationsdatei für die Installation beschrieben wird.

  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-Benutzeroberfläche: 
    /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

Neue Edge-Umgebung installieren

Nachdem Sie die Edge-Basis-UI installiert haben, können Sie die neue Edge-Umgebung installieren und konfigurieren.

So installieren Sie die neue Edge-Umgebung:

  1. Installieren Sie die neue Edge-Umgebung: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Wechseln Sie in das Verzeichnis edge-management-ui: 
    cd /opt/apigee/edge-management-ui
  3. Konfigurieren Sie die neue Edge-Umgebung: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    Dabei ist configFile die Konfigurationsdatei, die oben unter Konfigurationsdatei für die Installation beschrieben wird.

  4. SAML in der neuen Edge-Umgebung aktivieren: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. Melden Sie sich in der neuen Edge-Umgebung an, indem Sie die folgende URL in einem Browser öffnen: 
    http://newEdgeExperienceIP:3001

    Dabei ist newEdgeExperienceIP die IP-Adresse des Knotens, auf dem die neue Edge-Umgebung gehostet wird. Sie werden aufgefordert, Ihre SAML-Anmeldedaten einzugeben. Nachdem Sie Ihre Anmeldedaten eingegeben haben, wird die neue Edge-Umgebung angezeigt.

  6. Weitere Informationen, einschließlich Links zu Informationen zur Verwendung der neuen Edge-Umgebung, finden Sie unter Die neue Edge-Umgebung für Private Cloud.

Neue Edge-Umgebung deinstallieren

So deinstallieren Sie die neue Edge-Umgebung:

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

So deinstallieren Sie die Edge-Basis-UI (shoehorn):

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

So entfernen Sie Edge vollständig vom Knoten:

  1. Beenden Sie alle Edge-Dienste, die auf dem Computer ausgeführt werden: 
    /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 Stammverzeichnis der Installation: 
    sudo rm -rf /opt/apigee