Instalowanie nowego środowiska Edge (beta)

Edge dla chmury prywatnej w wersji 4.18.05

Ten dokument opisuje, jak zainstalować wersję beta nowego środowiska Edge dla Edge for Private Cloud. Nowe środowisko Edge to interfejs Edge nowej generacji.

Aby wypróbować nowe środowisko Edge w instalacji Edge dla chmury prywatnej, musisz:

  • Włącz SAML w Edge. Nowe środowisko Edge obsługuje tylko mechanizm uwierzytelniania SAML.
  • Zainstaluj nowe środowisko Edge na osobnym węźle. Nie można go zainstalować na węźle zawierającym inne komponenty Edge.

Więcej informacji o nowym środowisku Edge znajdziesz w artykule o nowym środowisku Edge w chmurze prywatnej.

Omówienie instalacji

Aby zainstalować wersję beta nowego środowiska Edge dla Edge dla chmury prywatnej, musisz wykonać 2 różne procesy instalacji:

  • Zainstaluj podstawowy interfejs Edge UI o nazwie shoehorn i skonfiguruj go tak, aby używał SAML do uwierzytelniania w Edge.
  • Zainstaluj nowe środowisko Edge i skonfiguruj je tak, aby używało SAML do uwierzytelniania w Edge. Po zainstalowaniu nowego środowiska Edge możesz się zalogować i używać go do pracy z Edge.

Wymagania wstępne instalacji

  • Przed zainstalowaniem nowego środowiska Edge musisz włączyć SAML w Edge. Nowe środowisko Edge obsługuje tylko mechanizm uwierzytelniania SAML.

    Informacje o włączaniu SAML w Edge znajdziesz w artykule Obsługa SAML w Edge dla chmury prywatnej.

  • Nowe środowisko Edge musisz zainstalować na osobnym węźle. Nie można go zainstalować na węźle, który zawiera inne komponenty Edge. Węzeł musi spełniać te wymagania:
    • JAVA 1.8
    • 4 GB pamięci RAM,
    • 2-rdzeniowy
    • 60 GB miejsca na dysku,
    • Najpierw musisz zainstalować na węźle wersję 4.18.05 narzędzia apigee-setup zgodnie z opisem w artykule Instalowanie narzędzia apigee-setup w Edge.

Co należy wziąć pod uwagę przed zainstalowaniem nowego środowiska Edge

Jak opisano powyżej w wymaganiach wstępnych, nowe środowisko Edge wymaga włączenia SAML w Edge. Oznacza to, że uwierzytelnianie użytkowników jest kontrolowane przez dostawcę tożsamości SAML, który jest skonfigurowany tak, aby używać adresów e-mail jako identyfikatorów użytkowników. Wszyscy użytkownicy nowego środowiska Edge muszą być zarejestrowani u dostawcy tożsamości SAML.

Klasyczny interfejs Edge, czyli domyślny interfejs zainstalowany z Edge for Chmura prywatna, nie wymaga SAML. Może używać uwierzytelniania SAML lub podstawowego. Oznacza to, że możesz:

  • Włącz obsługę SAML w Edge oraz w klasycznym interfejsie i nowym środowisku Edge.

    W tym scenariuszu wszyscy użytkownicy klasycznego interfejsu i nowego środowiska Edge są zarejestrowani u dostawcy tożsamości SAML. Informacje o dodawaniu nowych użytkowników do dostawcy tożsamości SAML znajdziesz w artykule Rejestrowanie nowych użytkowników Edge.

  • Włącz obsługę SAML w Edge, ale pozostaw włączone uwierzytelnianie podstawowe. Nowe środowisko Edge korzysta z SAML, a klasyczny interfejs użytkownika nadal używa uwierzytelniania podstawowego.

    W tym scenariuszu wszyscy użytkownicy klasycznego interfejsu logują się przy użyciu podstawowych danych uwierzytelniających, które są przechowywane w bazie danych Edge OpenLDAP. Użytkownicy nowego środowiska Edge są zarejestrowani u dostawcy tożsamości SAML i logują się przy użyciu SAML.

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

Zmiany konfiguracji instalacji od wersji Edge 4.18.01

Wersja Edge 4.18.05 nowego środowiska Edge zawiera te zmiany w pliku konfiguracji w porównaniu z wersją Edge 4.18.01. Te właściwości są szczegółowo opisane w następnej sekcji:

Typ zmiany Usługi, których dotyczy problem
Dodane
# 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
Usunięta
ROUTES_SHOEHORN
ROUTES_CLASSICUI
Wymieniono
MANAGEMENT_UI_USE_HTTPS
Zastąpione przez:
MANAGEMENT_UI_SCHEME

Plik konfiguracji instalacji

Plik konfiguracji zawiera wszystkie informacje niezbędne do zainstalowania i skonfigurowania nowego środowiska Edge. Możesz użyć tego samego pliku konfiguracji, aby zainstalować i skonfigurować zarówno podstawowy interfejs użytkownika, jak i nowe środowisko Edge.

Poniżej znajduje się przykładowy plik konfiguracji:

# 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.
# This release does not support TLS.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=http://$IP2:3001
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=secret222
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=24
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS=0.5

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

# The first two properties use the same values as the New Edge experience.
SHOEHORN_SCHEME=$MANAGEMENT_UI_SCHEME
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"

Instalowanie podstawowego interfejsu Edge (shoehorn)

Zanim zainstalujesz nowe środowisko Edge, musisz zainstalować podstawowy interfejs Edge, który nazywa się shoehorn.

Aby zainstalować podstawowy interfejs:

  1. Zainstaluj wersję 4.18.05 narzędzia apigee-setup w węźle zgodnie z opisem w artykule Instalowanie narzędzia Edge apigee-setup.
  2. Wyczyść Yum:
    sudo yum clean all
  3. Utwórz plik konfiguracji zgodnie z opisem powyżej i upewnij się, że jego właścicielem jest użytkownik „apigee”:
    chown apigee:apigee configFile

    gdzie configFile to plik konfiguracji opisany powyżej w sekcji Plik konfiguracji instalacji.

  4. Zainstaluj wersję Shoehorn interfejsu Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  5. Skonfiguruj interfejs Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  6. Włącz SAML w interfejsie Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

Instalowanie nowego środowiska Edge

Po zainstalowaniu podstawowego interfejsu Edge możesz zainstalować i skonfigurować nowe środowisko Edge.

Aby zainstalować nowe środowisko Edge:

  1. Zainstaluj nowe środowisko Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. Przejdź do katalogu edge-management-ui:
    cd /opt/apigee/edge-management-ui
  3. Skonfiguruj nowe środowisko Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    gdzie configFile to plik konfiguracji opisany powyżej w sekcji Plik konfiguracji instalacji.

  4. Włącz SAML w nowym środowisku Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. Zaloguj się w nowym środowisku Edge, otwierając w przeglądarce ten adres URL:
    http://newEdgeExperienceIP:3001

    gdzie newEdgeExperienceIP to adres IP węzła, na którym działa nowe środowisko Edge. Pojawi się prośba o podanie danych logowania SAML. Po wpisaniu danych logowania pojawi się nowe środowisko Edge.

  6. Więcej informacji, w tym linki do informacji o korzystaniu z nowego środowiska Edge, znajdziesz w artykule Nowe środowisko Edge dla chmury prywatnej (beta).

Odinstalowywanie nowego środowiska Edge

Aby odinstalować nowe środowisko Edge:

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

Aby odinstalować podstawowy interfejs Edge (shoehorn):

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

Aby całkowicie usunąć Edge z węzła:

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