Zainstaluj nowy interfejs Edge

Ten dokument opisuje, jak zainstalować interfejs Edge dla Apigee Edge dla Private Cloud. Interfejs Edge to nowa generacja interfejsu użytkownika Edge.

Wymagania wstępne

Aby wypróbować nowy interfejs użytkownika Edge w instalacji Apigee Edge do Private Cloud, musisz:

  • Zainstaluj interfejs użytkownika Edge w osobnym węźle. Nie możesz go zainstalować w węźle zawierającym inne komponenty Edge, w tym w węźle, w którym znajduje się istniejący klasyczny interfejs użytkownika. Jeśli to zrobisz, użytkownicy nie będą mogli zalogować się w klasycznym interfejsie.

    Węzeł interfejsu użytkownika Edge musi spełniać te wymagania:

    • JAVA 1.8
    • 4 GB pamięci RAM
    • 2-rdzeniowy
    • 60 GB miejsca na dysku
    • Najpierw musisz zainstalować w węźle wersję 4.52.01 narzędzia apigee-setup zgodnie z opisem w sekcji Instalowanie narzędzia Edge apigee-setup.
    • Port 3001 musi być otwarty. To jest domyślny port używany do obsługi żądań wysyłanych do interfejsu Edge. Jeśli zmienisz port za pomocą właściwości opisanych w sekcji Nowy plik konfiguracji UE, upewnij się, że port jest otwarty.
  • Włącz zewnętrznego dostawcę tożsamości w Edge. Interfejs Edge obsługuje SAML lub LDAP jako mechanizm uwierzytelniania.
  • (Tylko dostawca tożsamości SAML) Interfejs Edge obsługuje tylko TLS 1.2. Jeśli łączysz się z dostawcą tożsamości SAML przez TLS, jeśli używasz SAML, dostawca tożsamości musi obsługiwać TLS 1.2.

Więcej informacji o interfejsie Edge znajdziesz w artykule Nowy interfejs Edge dla Private Cloud.

Omówienie instalacji

Ogólnie proces instalacji interfejsu Edge dla Apigee Edge dla Private Cloud wygląda tak:

  • Dodaj do klastra nowy węzeł
  • Zaloguj się w nowym węźle
  • Pobierz narzędzie apigee-setup
  • Tworzenie pliku konfiguracji i modyfikowanie go w ustawieniach
  • Uruchom narzędzie apigee-setup
  • Zaloguj się i przetestuj nowe UE

W przypadku uruchomienia w nowym węźle narzędzie apigee-setup:

  • Instaluje podstawowy klasyczny interfejs użytkownika o nazwie shoehorn i konfiguruje klasyczny interfejs do uwierzytelniania w Edge przy użyciu zewnętrznego dostawcy tożsamości.
  • Instaluje nowy interfejs użytkownika Edge i konfiguruje interfejs Edge w taki sposób, aby używał zewnętrznego dostawcy tożsamości do uwierzytelniania w Edge.

Uwagi do rozważenia przed zainstalowaniem nowego interfejsu użytkownika Edge

Jak opisano powyżej w wymaganiach wstępnych, interfejs użytkownika Edge wymaga włączenia zewnętrznego dostawcy tożsamości w Edge. Oznacza to, że uwierzytelnianie użytkownika jest kontrolowane przez dostawcę tożsamości, jeśli skonfigurujesz je tak, aby używać adresów e-mail jako identyfikatorów użytkownika. Dlatego wszyscy użytkownicy interfejsu Edge muszą być zarejestrowani u dostawcy tożsamości.

Klasyczny interfejs, domyślny interfejs zainstalowany przez Ciebie za pomocą Apigee Edge dla Private Cloud, nie wymaga zewnętrznego dostawcy tożsamości. Może korzystać z uwierzytelniania dostawcy tożsamości lub uwierzytelniania podstawowego. Oznacza to, że możesz:

  • Włącz zewnętrzną obsługę dostawcy tożsamości w przeglądarce Edge oraz w klasycznym interfejsie użytkownika i interfejsie Edge.

    W takiej sytuacji wszyscy użytkownicy klasycznego interfejsu użytkownika i interfejsu Edge są zarejestrowani u dostawcy tożsamości. Informacje o dodawaniu nowych użytkowników do dostawcy tożsamości znajdziesz w artykule o rejestrowaniu nowych użytkowników Edge.

  • Włącz zewnętrzną obsługę dostawcy tożsamości w Edge, ale pozostaw włączone uwierzytelnianie podstawowe. Interfejs Edge używa dostawcy tożsamości, a klasyczny interfejs nadal używa uwierzytelniania podstawowego.

    W tym scenariuszu wszyscy użytkownicy klasycznego interfejsu użytkownika logują się za pomocą podstawowych danych uwierzytelniających, gdzie ich dane logowania są przechowywane w bazie danych Edge OpenLDAP. Użytkownicy interfejsu Edge są zarejestrowani u dostawcy tożsamości i logują się przy użyciu SAML lub LDAP.

    Użytkownik klasycznego interfejsu użytkownika nie może jednak zalogować się w interfejsie użytkownika Edge, dopóki nie dodasz go do dostawcy tożsamości zgodnie z opisem w sekcji Rejestrowanie nowych użytkowników Edge.

Zmiany konfiguracji instalacji w stosunku do poprzednich wersji

Pamiętaj o poniższych zmianach w procedurze instalacji w wersjach beta interfejsu użytkownika Edge.

Nowy plik konfiguracji interfejsu Edge

Ten plik konfiguracji zawiera wszystkie informacje niezbędne do zainstalowania i skonfigurowania nowego interfejsu użytkownika Edge. Do zainstalowania i skonfigurowania interfejsu obuwia/klasycznego oraz Edge możesz użyć tego samego pliku konfiguracji.

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

Instalowanie interfejsu użytkownika Edge

Po utworzeniu i zmodyfikowaniu pliku konfiguracji możesz zainstalować w nim nowy interfejs użytkownika Edge.

Aby zainstalować interfejs Edge:

  1. Dodaj do klastra nowy węzeł.
  2. Zaloguj się w nowym węźle jako administrator.
  3. Zainstaluj w węźle wersję 4.52.01 narzędzia apigee-setup zgodnie z opisem w sekcji Instalowanie narzędzia Edge apigee-setup.
  4. Wyczyść wszystkie informacje z pamięci podręcznej w Yum, wykonując to polecenie: 
    sudo yum clean all
  5. Utwórz plik konfiguracji zgodnie z opisem w sekcji Nowy plik konfiguracji interfejsu użytkownika Edge i upewnij się, że należy on do użytkownika „apigee”: 
    chown apigee:apigee configFile

    Pamiętaj, aby wprowadzić te zmiany w pliku konfiguracji:

    • Zmień wartość właściwości MANAGEMENT_UI_SSO_CSRF_SECRET w pliku konfiguracji na swój obiekt tajny CSRF.
    • Skonfiguruj Edge tak, aby używał jednej z tych opcji (nowy interfejs użytkownika Edge wymaga zewnętrznego dostawcy tożsamości):
      • SAML
      • LDAP

      Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania zewnętrznych dostawców tożsamości.

  6. Skonfiguruj zewnętrznego dostawcę tożsamości przy użyciu użytkowników, którzy mają mieć dostęp do interfejsu Edge. Więcej informacji znajdziesz w artykule o rejestrowaniu nowych użytkowników Edge.
  7. W nowym węźle wykonaj to polecenie: 
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

    Narzędzie apigee-setup instaluje klasyczny interfejs użytkownika. Instalator instaluje następnie interfejs Edge na górze klasycznego interfejsu użytkownika.

  8. Zaloguj się w interfejsie użytkownika Edge, otwierając w przeglądarce ten adres URL: 
    http://new_edge_UI_IP:3001

    Gdzie new_edge_UI_IP to adres IP węzła hostującego nowy interfejs użytkownika Edge.

    Edge poprosi o podanie zewnętrznych danych logowania dostawcy tożsamości.

  9. Wpisz swoje dane logowania.

    Pojawi się nowy interfejs Edge. Informacje o korzystaniu z interfejsu Edge znajdziesz w artykule Nowy interfejs Edge dla Private Cloud.

    Jeśli interfejs Edge nie jest wyświetlany, upewnij się, że port 3001 jest otwarty dla połączeń zewnętrznych.

Odinstaluj nowy interfejs użytkownika

Aby odinstalować nowy interfejs użytkownika z węzła, musisz odinstalować zarówno nowy interfejs Edge, jak i podstawowy klasyczny interfejs użytkownika (shoehorn), które były zainstalowane w węźle podczas procesu instalacji UI.

Aby odinstalować nowy interfejs Edge:

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

Aby odinstalować podstawowy interfejs klasyczny (shhoehorn):

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

Aby usunąć z węzła wszystkie komponenty Edge:

  1. Zatrzymaj wszystkie usługi Edge uruchomione na komputerze: 
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. Wyczyść pamięć podręczną yum: 
    sudo yum clean all
  3. Usuń wszystkie RPM Apigee: 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. Usuń katalog główny instalacji: 
    sudo rm -rf /opt/apigee