Migracja właściwości klasycznego interfejsu do nowego interfejsu Edge

W Apigee Edge dla chmury prywatnej w wersji 4.54.00 klasyczny interfejs użytkownika (komponent edge-ui) został usunięty i nie jest już dostępny. Nowy interfejs Edge (komponent edge-management-ui) jest jedynym interfejsem Edge dla chmury prywatnej.

Nie możesz używać edge-ui w Edge dla chmury prywatnej w wersji 4.54.00. Jeśli interfejs klasyczny został dostosowany przez ustawienie właściwości w pliku /opt/apigee/customer/application/ui.properties, nowy interfejs Edge nie odczyta tego pliku. Po aktualizacji do wersji 4.54.00 musisz ustawić równoważne właściwości w /opt/apigee/customer/application/management-ui.properties.

Na tej stronie znajdziesz listę właściwości klasycznego interfejsu użytkownika udokumentowanych dla ui.properties, odpowiadające im właściwości nowego interfejsu Edge oraz właściwości klasycznego interfejsu użytkownika, które nie są obsługiwane w nowym interfejsie Edge.

Nowy interfejs Edge korzysta z tego samego mechanizmu kodu z konfiguracją (CwC) co inne komponenty Edge. Więcej informacji znajdziesz w artykule Konfigurowanie Edge.

Porównanie konfiguracji klasycznego interfejsu użytkownika i nowego interfejsu Edge

Nowy interfejs Edge zastępuje komponent klasycznego interfejsu, plik właściwości, nazwę usługi, domyślny port i format certyfikatu TLS. Zanim przeniesiesz usługi, zapoznaj się z tabelą poniżej, aby zaktualizować skrypty automatyzacji, reguły zapory sieciowej i pliki TLS:

Ustawienie Klasyczny interfejs użytkownika (wersja 4.53.01 i starsze) Nowy interfejs Edge (4.54.00)
Nazwa komponentu edge-ui edge-management-ui
Plik właściwości /opt/apigee/customer/application/ui.properties /opt/apigee/customer/application/management-ui.properties
Polecenie ponownego uruchomienia apigee-service edge-ui restart apigee-service edge-management-ui restart
Domyślny port 9000 3001
Konfiguracja TLS Plik magazynu kluczy Java (JKS) Pliki certyfikatu i klucza PEM. Zobacz Konfigurowanie TLS w nowym interfejsie Edge.

Ustawianie właściwości nowego interfejsu Edge

Ustaw właściwości konfiguracji nowego interfejsu Edge w pliku /opt/apigee/customer/application/management-ui.properties i uruchom ponownie usługę edge-management-ui, aby zmiany zostały zastosowane.

Aby ustawić usługę dla nowego interfejsu Edge:

  1. Otwórz plik management-ui.properties w edytorze. Jeśli plik nie istnieje, utwórz go: 
    vi /opt/apigee/customer/application/management-ui.properties
  2. Ustaw właściwość. Na przykład: 
    conf_uebe_disableGeoMap=true
  3. Zapisz zmiany.
  4. Upewnij się, że właścicielem pliku jest użytkownik apigee: 
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  5. Ponownie uruchom interfejs New Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart

Podczas ustawiania właściwości nowego interfejsu Edge przestrzegaj tych reguł formatowania:

  • W nazwach właściwości rozróżniana jest wielkość liter. Na przykład conf_uebe_disableGeoMap jest prawidłowym adresem, ale conf_uebe_disablegeomap – nie.
  • Wartości tekstowe umieść w cudzysłowach podwójnych, np.conf_uebe_branding_companyNameShort="My Company".
  • Nie umieszczaj wartości logicznych (true lub false) ani wartości liczbowych w cudzysłowach. Jeśli wartość logiczna lub numeryczna jest ujęta w cudzysłów, interfejs New Edge nie zostanie uruchomiony.

Aby sprawdzić bieżącą wartość właściwości, użyj opcji -search. Na przykład:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \
  configure -search conf_uebe_disableGeoMap

Mapowanie usług w klasycznym interfejsie na usługi w nowym interfejsie Edge

W poniższych tabelach każda obsługiwana właściwość klasycznego interfejsu użytkownika w ui.properties jest mapowana na jej odpowiednik w nowym interfejsie Edge w management-ui.properties. Kolumna Domyślna zawiera wartość domyślną w nowym interfejsie Edge.

Konfigurowanie właściwości funkcji

Zmapuj flagi funkcji klasycznego interfejsu na odpowiednie właściwości conf_uebe_* w management-ui.properties:

Usługa w klasycznym interfejsie Nowa właściwość interfejsu Edge UI Domyślny Uwagi
conf_apigee_apigee.feature.disablegeomap conf_uebe_disableGeoMap false Ustaw na true, aby ukryć mapy geograficzne. W klasycznym interfejsie Edge dla chmury prywatnej mapy geograficzne były domyślnie wyłączone. Jeśli nie masz włączonej agregacji geograficznej, ustaw tę właściwość na true. Zobacz Włączanie agregacji geograficznej i map geograficznych.
conf_apigee_apigee.feature.disablepasswordreset conf_uebe_disablePasswordReset false Ustaw wartość true, aby ukryć link Resetuj hasło na stronie logowania.
conf_apigee-base_apigee.feature.enableforcerangelimit conf_uebe_enableForceRangeLimit true Ustaw wartość false, aby zezwolić na niestandardowe raporty w przypadku zakresu dat dłuższego niż 14 dni.
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses conf_uebe_trace_for_internal_addresses false Ustaw wartość true, aby zezwolić narzędziu do śledzenia na wysyłanie żądań do lokalnych lub wewnętrznych adresów IP.
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses conf_uebe_openapi_for_internal_addresses false Ustaw wartość true, aby zezwolić na importowanie specyfikacji OpenAPI z lokalnych lub wewnętrznych adresów IP.
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses conf_uebe_wsdl_for_internal_addresses false Ustaw wartość true, aby zezwolić na importowanie plików WSDL z lokalnych lub wewnętrznych adresów IP.

Konfigurowanie właściwości sesji i TLS

Zmapuj właściwości limitu czasu sesji i TLS klasycznego interfejsu użytkownika na ich odpowiedniki w nowym interfejsie Edge w management-ui.properties:

Usługa w klasycznym interfejsie Nowa właściwość interfejsu Edge UI Domyślny Uwagi
conf_application_session.maxage conf_uebe_authsessiontimeout 12 (godziny) Czas, po którym sesja użytkownika wygasa po zalogowaniu. Podaj liczbę godzin (np. 12 lub 0.5) albo czas trwania z jednostką h (godziny) lub m (minuty) (np. 24h lub 90m). Wartości 12 i 12h są równoważne. Jednostka d (dni) nie jest obsługiwana. Możesz na przykład zastąpić 1d elementem 24h. Jeśli wartość jest nieprawidłowa, używana jest wartość domyślna (12 godzin) i nie jest zgłaszany błąd. Dotyczy sesji, które korzystają z uwierzytelniania podstawowego.
conf_application_session.secure Nie jest wymagane Nie dotyczy Nowy interfejs Edge automatycznie ustawia flagę Secure w plikach cookie sesji, gdy protokół TLS jest włączony (conf_uebe_usehttps=true) lub gdy protokół TLS kończy się w systemie równoważenia obciążenia (conf_uebe_tlsoffload=true).
conf/application.conf+trustxforwarded conf_uebe_usehttps=true i conf_uebe_tlsoffload=true false Ustaw obie właściwości, gdy zakończenie TLS następuje na systemie równoważenia obciążenia. System równoważenia obciążenia musi przekazywać żądania do nowego interfejsu Edge UI przez HTTP i ustawiać nagłówek X-Forwarded-Proto. Polecenie configure-ssl ustawia te właściwości, gdy MANAGEMENT_UI_SCHEME=https i MANAGEMENT_UI_TLS_OFFLOAD=y. Zobacz Konfigurowanie TLS w nowym interfejsie Edge.
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate conf_uebe_skipverify false Ustaw wartość true tylko wtedy, gdy serwer zarządzania używa certyfikatu podpisanego samodzielnie. Zobacz Konfigurowanie protokołu TLS dla interfejsu API zarządzania Google Analytics.

Konfigurowanie właściwości i szablonów e-maili

Zmapuj właściwości nadawcy e-maila, tematu, marki, adresu URL hosta i wygaśnięcia linku z klasycznego interfejsu użytkownika na nowy interfejs Edge:

Usługa w klasycznym interfejsie użytkownika Nowa właściwość interfejsu Edge UI Domyślny Uwagi
conf_apigee_apigee.mgmt.mailfrom conf_apigee_apigee.mgmt.mailfrom Apigee <sales@apigee.com> lub wartość parametru SMTPMAILFROM określonego podczas instalacji. Brak zmian.
conf_apigee-base_apigee.emails.passwordreset.subject conf_apigee_apigee.emails.passwordReset.subject Password Reset Request Zwróć uwagę na segment właściwości passwordReset zapisany w notacji camelCase.
conf_apigee-base_apigee.emails.useraddedexisting.subject conf_apigee_apigee.emails.userAddedExisting.subject You Have Been Added to an Organization {organization} Zwróć uwagę na segment właściwości userAddedExisting zapisany w notacji camelCase.
conf_apigee-base_apigee.emails.useraddednew.subject conf_apigee_apigee.emails.userAddedNew.subject An Account Has been Created for You at {companyNameShort} Zwróć uwagę na segment właściwości userAddedNew zapisany w notacji camelCase.
conf_apigee_apigee.branding.companynameshort conf_uebe_branding_companyNameShort Apigee Ustawia wartość zmiennej {companyNameShort} w tematach i szablonach e-maili.
conf_apigee_apigee.emails.hosturl conf_apigee_apigee.emails.hosturl Brak Brak zmian. Jeśli nie jest ustawiony, linki do resetowania hasła używają adresu URL interfejsu New Edge, który został określony podczas instalacji, a linki z zaproszeniami użytkowników używają nazwy hosta żądania. Ustaw tę właściwość, jeśli użytkownicy uzyskują dostęp do nowego interfejsu Edge przez system równoważenia obciążenia lub nazwę DNS, na przykład conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com".
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds 600 Dotyczy linków do resetowania hasła i linków z zaproszeniem dla użytkowników.

Nowy interfejs Edge korzysta z wbudowanych szablonów e-maili. Aby używać szablonów dostosowanych do klasycznego interfejsu:

  1. Utwórz katalog /opt/apigee/edge-management-ui/email-templates.
  2. Skopiuj dostosowane pliki password-reset.html, user-added-existing.html i user-added-new.html z katalogu kopii zapasowej utworzonego przed aktualizacją (np. /opt/apigee/customer/backup/) do /opt/apigee/edge-management-ui/email-templates. Nazwy plików szablonów i obiekty zastępcze są takie same jak w klasycznym interfejsie.
  3. Sprawdź, czy katalog i pliki należą do użytkownika apigee.
  4. Ponownie uruchom nowy interfejs Edge.

Więcej informacji znajdziesz w artykule Dostosowywanie szablonów e-maili Edge.

Konfigurowanie właściwości hasła wygenerowanego automatycznie

Mapowanie właściwości haseł wygenerowanych automatycznie w klasycznym interfejsie użytkownika na nowy interfejs Edge:

Usługa w klasycznym interfejsie Nowa właściwość interfejsu Edge UI Domyślny
conf_apigee-base_apigee.forgotPassword.underscore.minimum conf_apigee_apigee.forgotPassword.underscore.minimum 0
conf_apigee-base_apigee.forgotPassword.specialchars.minimum conf_apigee_apigee.forgotPassword.specialchars.minimum 0
conf_apigee-base_apigee.forgotPassword.lowecase.minimum conf_apigee_apigee.forgotPassword.lowecase.minimum 0
conf_apigee-base_apigee.forgotPassword.uppercase.minimum conf_apigee_apigee.forgotPassword.uppercase.minimum 0

Konfigurowanie połączenia z serwerem zarządzania i właściwości wspólnego obiektu tajnego

Zmapuj właściwości połączenia, danych logowania i tajnego klucza aplikacji serwera zarządzania klasycznego interfejsu użytkownika na nowy interfejs Edge:

Usługa w klasycznym interfejsie użytkownika Nowa właściwość interfejsu Edge UI Uwagi
conf_apigee_apigee.mgmt.baseurl mgmt_baseurl URL interfejsu API zarządzania, na przykład https://FQ_domain_name:port/v1. Ta nazwa usługi nie zaczyna się od conf_. Jeśli serwer zarządzania używa certyfikatu podpisanego samodzielnie, ustaw też conf_uebe_skipverify=true.
conf_apigee_apigee.mgmt.credential conf_uebe_mgmtCredential Zaszyfrowane dane logowania administratora systemu. Musisz ponownie zaszyfrować dane logowania dla nowego interfejsu Edge za pomocą ./bin/management-ui --encrypt; zobacz Konfiguracja wymagana w przypadku różnych danych logowania administratora systemu.
conf_apigee_mail.smtp.credential conf_apigee_mail.smtp.credential zaszyfrowane dane logowania SMTP,
conf_application_application.secret conf_uebe_applicationsecret Klucz tajny używany do szyfrowania danych logowania i plików cookie sesji. Generowany w momencie instalacji.

Usuwanie właściwości klasycznego interfejsu, które nie wymagają żadnych działań

Te właściwości klasycznego interfejsu nie mają odpowiednika w nowym interfejsie Edge, ponieważ ich działanie jest zawsze włączone. Nie uwzględniaj tych właściwości w pliku management-ui.properties (i usuń je ze wszystkich skryptów automatycznej konfiguracji):

Usługa w klasycznym interfejsie Działanie w nowym interfejsie Edge
conf_apigee_apigee.feature.expireSessionCookiesInternally Wygaśnięcie sesji jest zawsze sprawdzane na serwerze.
conf_apigee_apigee.feature.trackSessionCookies Informacje o sesji są zawsze przechowywane w pamięci serwera. Jeśli używasz wielu instancji nowego interfejsu Edge za systemem równoważenia obciążenia, skonfiguruj system równoważenia obciążenia tak, aby korzystał z sesji trwałych.

Usuwanie nieobsługiwanych właściwości klasycznego interfejsu

Te właściwości klasycznego interfejsu nie są obsługiwane i nie mają odpowiedników w nowym interfejsie Edge. Nie uwzględniaj tych właściwości w management-ui.properties (i usuń je ze wszystkich zautomatyzowanych skryptów konfiguracyjnych):

Usługa w klasycznym interfejsie Opis
conf_apigee_apigee.feature.apitimeout, conf_apigee_play.ws.timeout.idle, conf_apigee_play.ws.timeout.connection W nowym interfejsie Edge nie można skonfigurować limitu czasu wywołań interfejsu Management API.
conf_application_http.proxyhost, conf_application_http.proxyport, conf_application_http.proxyuser, conf_application_http.proxypassword Nowy interfejs Edge nie obsługuje serwera proxy przekierowującego żądania narzędzia śledzenia.
conf_apigee-base_apigee.feature.enableconsentbanner, conf_apigee-base_apigee.consentbanner.buttoncaption, conf_apigee-base_apigee.consentbanner.body Baner z prośbą o zgodę na przetwarzanie danych nie jest obsługiwany w nowym interfejsie Edge.
conf_apigee-base_apigee.feature.apiproxypaginationenabled, conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize W nowym interfejsie Edge lista serwerów proxy interfejsu API jest zawsze wczytywana na stronach. Rozmiaru strony nie można konfigurować.
conf_logger_settings_application_log_level, conf_logger_settings_play_log_level, conf_application_logger.application Poziomu logów nie można skonfigurować w nowym interfejsie Edge. Pliki dziennika są zapisywane w folderze /opt/apigee/var/log/edge-management-ui.
bin_setenv_min_mem, bin_setenv_max_mem, bin_setenv_meta_space_size, bin_setenv_ext_jvm_opts Interfejs New Edge nie działa na maszynie wirtualnej Javy. Ustawienia pamięci Javy nie mają zastosowania.

Przykład migracji

W poniższym przykładzie porównano plik ui.properties klasycznego interfejsu użytkownika z odpowiednim plikiem management-ui.properties nowego interfejsu Edge.

Klasyczny interfejs: /opt/apigee/customer/application/ui.properties

conf_apigee_apigee.feature.disablegeomap=false
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses="true"
conf_application_session.maxage="1d"
conf_apigee-base_apigee.emails.passwordreset.subject="Reset your My Company password"
conf_apigee_apigee.branding.companynameshort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

Nowy interfejs Edge, /opt/apigee/customer/application/management-ui.properties:

conf_uebe_disableGeoMap=false
conf_uebe_trace_for_internal_addresses=true
conf_uebe_authsessiontimeout=24
conf_apigee_apigee.emails.passwordReset.subject="Reset your My Company password"
conf_uebe_branding_companyNameShort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

Zwróć uwagę, że wartość logiczna true nie jest ujęta w cudzysłów, a limit czasu sesji 1d jest zastąpiony wartością 24.

Po zapisaniu pliku uruchom ponownie nowy interfejs Edge:

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

Lista kontrolna podsumowania

Skorzystaj z poniższej listy kontrolnej, aby przeprowadzić migrację do nowego interfejsu Edge w Apigee Edge dla chmury prywatnej 4.54.00:

  1. Przed uaktualnieniem utwórz kopię zapasową /opt/apigee/customer/application/ui.properties i wszystkich dostosowanych szablonów e-maili z /opt/apigee/edge-ui/email-templates.
  2. Dodaj zmapowane właściwości do /opt/apigee/customer/application/management-ui.properties bez ujmowania wartości logicznych i liczbowych w cudzysłów i pomiń nieobsługiwane właściwości klasycznego interfejsu.
  3. Skopiuj dostosowane szablony e-maili z katalogu kopii zapasowej do /opt/apigee/edge-management-ui/email-templates.
  4. Ponownie zaszyfruj dane logowania administratora systemu za pomocą ./bin/management-ui --encrypt, jeśli ustawisz conf_uebe_mgmtCredential.
  5. Ustaw własność pliku na apigee:apigee i uruchom ponownie edge-management-ui.