Instalowanie nowej wersji Edge

Edge for Private Cloud w wersji 4.19.01

Ten dokument opisuje, jak zainstalować nowe środowisko Edge dla Edge dla Private Cloud. Nowa wersja Edge to nowa generacja interfejsu użytkownika Edge.

.

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

  • Włącz SAML w przeglądarce Edge. Nowa wersja Edge obsługuje tylko SAML jako mechanizm uwierzytelniania.
  • Zainstaluj nowe środowisko Edge w własnym węźle. Nie możesz zainstalować go w węźle zawierającym inne komponenty Edge, w tym w węźle, w którym znajduje się istniejący interfejs użytkownika Edge. Jeśli to zrobisz, użytkownicy nie będą mogli zalogować się w klasycznym interfejsie użytkownika Edge.

Więcej informacji o nowym środowisku Edge znajdziesz w artykule The New Edge Experience for Private Cloud (Nowa usługa Edge dla Private Cloud).

Omówienie instalacji

Aby zainstalować nowe środowisko Edge dla chmury Private Cloud, wykonaj 2 różne procesy instalacji:

  • Zainstaluj podstawowy interfejs Edge o nazwie shoehorn i skonfiguruj podstawowy interfejs Edge do uwierzytelniania SAML w Edge.
  • Zainstaluj nową wersję Edge i skonfiguruj ją tak, aby używała 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

  • Zanim zainstalujesz nowe środowisko Edge, musisz włączyć SAML w Edge. Usługa New Edge obsługuje tylko mechanizm uwierzytelniania SAML.

    Informacje o włączaniu SAML w Edge znajdziesz w artykule o obsłudze SAML w Edge for Private Cloud.

  • Nowa wersja Edge obsługuje tylko protokół TLS 1.2. Ponieważ łączysz się z dostawcą tożsamości SAML przez protokół TLS, dostawca tożsamości SAML musi obsługiwać protokół TLS 1.2.

  • Musisz zainstalować nowe środowisko Edge w osobnym węźle. Nie możesz zainstalować go w węźle zawierającym inne komponenty Edge, w tym w węźle, w którym znajduje się istniejący interfejs użytkownika 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ć w węźle narzędzie apigee-setup w wersji 4.19.01 zgodnie z opisem w sekcji Instalowanie narzędzia Edge apigee-setup.
    • Port 3001 musi być otwarty. To jest domyślny port używany w przypadku żądań wysyłanych do nowej wersji Edge. Jeśli zmienisz port, korzystając z opisanych poniżej właściwości, upewnij się, że jest on otwarty.

Uwagi do rozważenia przed zainstalowaniem nowego środowiska Edge

Jak opisano powyżej w wymaganiach wstępnych, środowisko nowej wersji Edge wymaga włączenia SAML w tej przeglądarce. Oznacza to, że uwierzytelnianie użytkownika jest kontrolowane przez dostawcę tożsamości SAML, gdzie możesz skonfigurować dostawcę tożsamości SAML tak, aby używał adresów e-mail jako identyfikatora użytkownika. Dlatego wszyscy użytkownicy nowej wersji Edge muszą być zarejestrowani u dostawcy tożsamości SAML.

Klasyczny interfejs Edge (domyślny interfejs zainstalowany przez Ciebie przy użyciu Edge dla chmury Private Cloud) nie wymaga SAML. Może używać uwierzytelniania SAML lub uwierzytelniania podstawowego. Oznacza to, że możesz:

  • Włącz obsługę SAML w przeglądarce Edge oraz zarówno w klasycznym interfejsie, jak i w nowej wersji Edge.

    W tym scenariuszu wszyscy użytkownicy klasycznego interfejsu użytkownika 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 o rejestrowaniu nowych użytkowników Edge.

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

    W tym scenariuszu wszyscy użytkownicy klasycznej wersji UI logują się za pomocą podstawowych danych uwierzytelniających, gdzie ich dane logowania są przechowywane w bazie danych Edge OpenLDAP. Użytkownicy nowego środowiska Edge są zarejestrowani u dostawcy tożsamości SAML i logują się za pomocą SAML.

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

Zmiany w konfiguracji instalacji z poprzednich wersji

Pamiętaj o następujących zmianach w procedurze instalacji dostępnej w wersji beta nowego środowiska Edge.

Zmiany w konfiguracji instalacji z wersji Edge 4.18.05

Nowa wersja Edge 4.19.01 zawiera te zmiany w pliku konfiguracji z wersji Edge 4.18.05:

Typ zmiany Właściwości, których to dotyczy
Usunięta 
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

Ta właściwość ma wstępnie zdefiniowaną wartość 0,5 (30 minut) i nie można jej zmienić.
Dodane W nowej wersji Edge możesz teraz włączyć TLS za pomocą właściwości. Więcej informacji znajdziesz w artykule Konfigurowanie protokołu TLS w nowej wersji Edge.

Zmiany w konfiguracji instalacji z wersji Edge 4.18.01

Nowa wersja Edge 4.19.01 zawiera te zmiany w pliku konfiguracji z wersji Edge 4.18.01:

Typ zmiany Właściwości, których to dotyczy
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
Zastąpienie 
MANAGEMENT_UI_USE_HTTPS
Zastąpione przez: 
MANAGEMENT_UI_SCHEME

Plik konfiguracji instalacyjnej

Plik konfiguracji zawiera wszystkie informacje niezbędne do zainstalowania i skonfigurowania nowego środowiska Edge. Za pomocą tego samego pliku konfiguracji możesz zainstalować i skonfigurować zarówno podstawowy interfejs, jak i nowy interfejs Edge.

Przykładowy plik konfiguracji znajduje się poniżej:

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

Instalowanie podstawowego interfejsu użytkownika Edge (klaksonu)

Zanim zainstalujesz nowe środowisko Edge, musisz zainstalować podstawowy interfejs użytkownika Edge o nazwie shoehorn.

Aby zainstalować podstawowy interfejs:

  1. Zainstaluj w węźle narzędzie apigee-setup w wersji 4.19.01 zgodnie z opisem w sekcji Instalowanie narzędzia Edge apigee-setup.
  2. Czyste Mniam: 
    sudo yum clean all
  3. Utwórz plik konfiguracyjny w sposób opisany powyżej i upewnij się, że należy on do użytkownika „apigee”: 
    chown apigee:apigee configFile

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

  4. Zmień wartość właściwości MANAGEMENT_UI_SSO_CSRF_SECRET w pliku konfiguracyjnym na obiekt tajny CSRF.
  5. Zainstaluj wersję Shoehorn interfejsu użytkownika Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. Skonfiguruj interfejs Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. Włącz SAML w interfejsie Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

Zainstaluj nową wersję Edge

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

Aby zainstalować nową wersję Edge:

  1. Zainstaluj nową wersję 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 instalacyjnej.

  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 nowej wersji Edge, otwierając ten adres URL w przeglądarce: 
    http://newEdgeExperienceIP:3001

    gdzie newEdgeExperienceIP to adres IP węzła hostującego 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 na stronie The New Edge Experience for Private Cloud (Nowa usługa Edge dla Private Cloud).

Odinstalowywanie nowej wersji Edge

Aby odinstalować nową wersję Edge:

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

Aby odinstalować podstawowy interfejs Edge (shehorn):

/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 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ń główny katalog instalacji: 
    sudo rm -rf /opt/apigee