Neue Edge-Benutzeroberfläche installieren

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

Voraussetzungen

Wenn Sie die neue Edge-UI in einer Installation von Apigee Edge für eine Private Cloud testen möchten, müssen Sie:

  • Installieren Sie die Edge-Benutzeroberfläche 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 klassische UI befindet. Andernfalls können sich Nutzer nicht mehr in der klassischen Benutzeroberfläche anmelden.

    Der Knoten der Edge-UI muss die folgenden Anforderungen erfüllen:

    • JAVA 1.8
    • 4 GB RAM
    • 2-Kerne
    • 60 GB Speicherplatz
    • Sie müssen zuerst die Version 4.52.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 Edge-Benutzeroberfläche verwendet wird. Wenn Sie den Port mithilfe der unter Neue UE-Konfigurationsdatei beschriebenen Attribute ändern, muss der Port offen sein.
  • Aktivieren Sie einen externen IdP in Edge. Die Edge-UI unterstützt SAML oder LDAP als Authentifizierungsmechanismus.
  • (Nur SAML-IdP) Die Edge-UI unterstützt nur TLS v1.2. Da Sie eine Verbindung zum SAML-IdP über TLS herstellen, muss Ihr IdP bei Verwendung von SAML TLS v1.2 unterstützen.

Weitere Informationen zur Edge-Benutzeroberfläche finden Sie unter Die neue Edge-Benutzeroberfläche für die Private Cloud.

Installation

Auf übergeordneter Ebene wird die Edge-Benutzeroberfläche für Apigee Edge für Private Cloud folgendermaßen installiert:

  • Neuen Knoten zum Cluster hinzufügen
  • Beim neuen Knoten anmelden
  • apigee-setup-Dienstprogramm herunterladen
  • Konfigurationsdatei erstellen und mit Ihren Einstellungen ändern
  • apigee-setup-Dienstprogramm ausführen
  • Anmelden und auf neuer UE testen

Bei Ausführung auf dem neuen Knoten führt das Dienstprogramm apigee-setup folgende Schritte aus:

  • Installiert die klassische Basis-UI namens shoehorn und konfiguriert die klassische UI so, dass ein externer IdP zur Authentifizierung bei Edge verwendet wird.
  • Installiert die neue Edge-Benutzeroberfläche und konfiguriert die Edge-Benutzeroberfläche so, dass Ihr externer IdP zur Authentifizierung bei Edge verwendet wird.

Überlegungen vor der Installation der neuen Edge-UI

Wie oben in den Voraussetzungen beschrieben, erfordert die Edge-Benutzeroberfläche, dass Sie einen externen IdP auf Edge aktivieren. Das bedeutet, dass die Nutzerauthentifizierung vom IdP gesteuert wird. Dort konfigurieren Sie ihn so, dass E-Mail-Adressen als Nutzer-ID verwendet werden. Alle Edge-UI-Nutzer müssen daher beim IdP registriert sein.

Die klassische UI, die Standard-UI, die Sie mit Apigee Edge für Private Cloud installiert haben, erfordert keinen externen IdP. Sie kann entweder einen IdP oder eine Basisauthentifizierung verwenden. Sie haben also folgende Möglichkeiten:

  • Aktivieren Sie die Unterstützung externer IdPs in Edge sowie in der klassischen und der Edge-Benutzeroberfläche.

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

  • Aktivieren Sie die Unterstützung externer IdPs in Edge, lassen Sie aber die Basisauthentifizierung aktiviert. Die Edge-UI verwendet den IdP und die klassische UI weiterhin die Basisauthentifizierung.

    In diesem Szenario melden sich alle Nutzer der klassischen UI mit Anmeldedaten der Basisauthentifizierung an, wobei ihre Anmeldedaten in der Edge OpenLDAP-Datenbank gespeichert sind. Edge-UI-Nutzer sind im IdP registriert und melden sich entweder über SAML oder LDAP an.

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

Änderungen der Installationskonfiguration aus früheren Releases

Beachten Sie die folgenden Änderungen am Installationsverfahren aus den Betaversionen der Edge-Benutzeroberfläche.

Neue Konfigurationsdatei für Edge-UI

Die folgende Konfigurationsdatei enthält alle Informationen, die zum Installieren und Konfigurieren der neuen Edge-UI erforderlich sind. Sie können dieselbe Konfigurationsdatei verwenden, um sowohl die Shoehorn-/klassische UI als auch die Edge-UI zu installieren und zu konfigurieren.

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

Installieren Sie die Edge-Benutzeroberfläche

Nachdem Sie die Konfigurationsdatei erstellt und geändert haben, können Sie die neue Edge-UI auf diesem neuen Knoten installieren.

So installieren Sie die Edge-Benutzeroberfläche:

  1. Fügen Sie dem Cluster einen neuen Knoten hinzu.
  2. Melden Sie sich beim neuen Knoten als Administrator an.
  3. Installieren Sie die Version 4.52.01 des Dienstprogramms apigee-setup auf dem Knoten, wie unter Edge-Dienstprogramm apigee-setup installieren beschrieben.
  4. Bereinigen Sie alle im Cache gespeicherten Informationen mit Yum. Führen Sie dazu den folgenden Befehl aus: 
    sudo yum clean all
  5. Erstellen Sie die Konfigurationsdatei wie unter Neue Edge-UI-Konfigurationsdatei beschrieben und achten Sie darauf, dass sie dem Nutzer „apigee“ gehört: 
    chown apigee:apigee configFile

    Nehmen Sie an der Konfigurationsdatei die folgenden Änderungen vor:

    • Ändern Sie den Wert des Attributs MANAGEMENT_UI_SSO_CSRF_SECRET in der Konfigurationsdatei in Ihr CSRF-Secret.
    • Konfigurieren Sie Edge für eine der folgenden Optionen (für die neue Edge-Benutzeroberfläche ist ein externer IdP erforderlich):
      • SAML
      • LDAP

      Weitere Informationen finden Sie unter Übersicht über die Authentifizierung externer IdPs.

  6. Konfigurieren Sie Ihren externen IdP mit den Nutzern, die Zugriff auf die Edge-Benutzeroberfläche haben sollen. Weitere Informationen finden Sie unter Neue Edge-Nutzer registrieren.
  7. Führen Sie auf dem neuen Knoten den folgenden Befehl aus: 
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

    Das Dienstprogramm apigee-setup installiert die klassische Benutzeroberfläche. Auf der klassischen Benutzeroberfläche installiert das Installationsprogramm dann die Edge-Benutzeroberfläche.

  8. Melden Sie sich bei der Edge-Benutzeroberfläche an. Öffnen Sie dazu die folgende URL in einem Browser: 
    http://new_edge_UI_IP:3001

    Dabei ist new_edge_UI_IP die IP-Adresse des Knotens, auf dem die neue Edge-UI gehostet wird.

    Edge fordert Sie auf, Ihre externen IdP-Anmeldedaten einzugeben.

  9. Geben Sie Ihre Anmeldedaten ein.

    Die neue Edge-Benutzeroberfläche wird angezeigt. Informationen zum Verwenden der Edge-Benutzeroberfläche finden Sie unter Die neue Edge-Benutzeroberfläche für die Private Cloud.

    Wenn die Edge-Benutzeroberfläche nicht angezeigt wird, achten Sie darauf, dass Port 3001 für externe Verbindungen geöffnet ist.

Neue Benutzeroberfläche deinstallieren

Zum Deinstallieren der neuen UI auf dem Knoten müssen Sie sowohl die neue Edge-UI als auch die klassische Basis-UI (shoehorn) deinstallieren, die während der UI-Installation auf dem Knoten installiert wurde.

So deinstallieren Sie die neue Edge-Benutzeroberfläche:

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

So deinstallieren Sie die klassische Basis-UI (Schuhhorn):

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

So entfernen Sie alle Edge-Komponenten aus dem 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 Installationsstammverzeichnis: 
    sudo rm -rf /opt/apigee