В Apigee Edge для Private Cloud 4.54.00 классический интерфейс (компонент edge-ui) удален и больше не доступен. Новый интерфейс Edge (компонент edge-management-ui) – единственный интерфейс для Edge for Private Cloud.
Вы не можете использовать edge-ui в Edge для Private Cloud 4.54.00. Если вы настроили классический интерфейс, задав свойства в файле /opt/apigee/customer/application/ui.properties, новый интерфейс Edge не будет считывать этот файл. После обновления до версии 4.54.00 вам нужно будет задать эквивалентные свойства в /opt/apigee/customer/application/management-ui.properties.
На этой странице перечислены свойства классического интерфейса, описанные в документации по ui.properties, эквивалентные свойства нового интерфейса Edge и свойства классического интерфейса, которые не поддерживаются в новом интерфейсе Edge.
В новом интерфейсе Edge используется тот же код с механизмом конфигурации (CwC), что и в других компонентах Edge. Подробнее о том, как настроить Edge…
Сравнение конфигураций классического и нового интерфейсов Edge
В новом интерфейсе Edge заменены компонент классического интерфейса, файл свойств, название сервиса, порт по умолчанию и формат сертификата TLS. Прежде чем переносить ресурсы, ознакомьтесь с таблицей ниже и обновите скрипты автоматизации, правила брандмауэра и файлы TLS.
| Параметр | Классический интерфейс (версия 4.53.01 и более ранние) | Новый интерфейс Edge (4.54.00) |
|---|---|---|
| Название компонента | edge-ui |
edge-management-ui |
| Файл свойств | /opt/apigee/customer/application/ui.properties |
/opt/apigee/customer/application/management-ui.properties
|
| Команда перезапуска | apigee-service edge-ui restart |
apigee-service edge-management-ui restart |
| Порт по умолчанию | 9000 | 3001 |
| Конфигурация TLS | Файл хранилища ключей Java (JKS) | Файлы сертификата и ключа в формате PEM. Подробнее о том, как настроить TLS для нового интерфейса Edge… |
Как задать свойства для нового интерфейса Edge
Задайте свойства конфигурации New Edge UI в файле /opt/apigee/customer/application/management-ui.properties и перезапустите сервис edge-management-ui, чтобы изменения вступили в силу.
Чтобы задать свойство для нового интерфейса Edge UI, выполните следующие действия:
-
Откройте файл
management-ui.propertiesв редакторе. Если файла нет, создайте его:vi /opt/apigee/customer/application/management-ui.properties
-
Задайте свойство. Пример:
conf_uebe_disableGeoMap=true
- Сохраните изменения.
-
Убедитесь, что владельцем файла является пользователь
apigee:chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
-
Перезапустите новый интерфейс Edge:
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart
При настройке свойств для нового интерфейса Edge UI следуйте этим правилам форматирования:
-
В названиях свойств учитывается регистр. Например,
conf_uebe_disableGeoMap– допустимое значение, аconf_uebe_disablegeomap– нет. -
Строковые значения заключайте в двойные кавычки, например
conf_uebe_branding_companyNameShort="My Company". -
Не заключайте логические значения (
trueилиfalse) или числовые значения в кавычки. Если логическое или числовое значение заключено в кавычки, новый интерфейс Edge не запустится.
Чтобы проверить текущее значение свойства, используйте параметр -search. Пример:
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \ configure -search conf_uebe_disableGeoMap
Сопоставление свойств классического интерфейса со свойствами нового интерфейса Edge
В таблицах ниже показано, как свойства классического интерфейса в ui.properties соотносятся со свойствами нового интерфейса Edge в management-ui.properties. В столбце Default (По умолчанию) указано значение по умолчанию в новом интерфейсе Edge.
Как настроить свойства функции
Сопоставьте флаги функций классического интерфейса с соответствующими свойствами conf_uebe_* в management-ui.properties:
| Ресурс с классическим интерфейсом | Новое свойство пользовательского интерфейса Edge | По умолчанию | Примечания |
|---|---|---|---|
conf_apigee_apigee.feature.disablegeomap |
conf_uebe_disableGeoMap |
false |
Чтобы скрыть географические карты, задайте значение true. В классическом интерфейсе Edge для частного облака географические карты были отключены по умолчанию. Если вы не включили агрегирование по местоположению, задайте для этого свойства значение true. Подробнее о том, как включить агрегирование по местоположению и географические карты…
|
conf_apigee_apigee.feature.disablepasswordreset |
conf_uebe_disablePasswordReset |
false |
Установите значение true, чтобы скрыть ссылку Сбросить пароль на странице входа.
|
conf_apigee-base_apigee.feature.enableforcerangelimit
|
conf_uebe_enableForceRangeLimit |
true |
Установите значение false, чтобы разрешить специальные отчеты за период более 14 дней.
|
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses
|
conf_uebe_trace_for_internal_addresses |
false |
Установите значение true, чтобы разрешить инструменту трассировки отправлять запросы на локальные или внутренние IP-адреса.
|
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses
|
conf_uebe_openapi_for_internal_addresses |
false |
Установите значение true, чтобы разрешить импорт спецификаций OpenAPI с локальных или внутренних IP-адресов.
|
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses
|
conf_uebe_wsdl_for_internal_addresses |
false |
Установите значение true, чтобы разрешить импорт файлов WSDL с локальных или внутренних IP-адресов.
|
Настройка свойств сеанса и TLS
Сопоставьте время ожидания сеанса и свойства TLS в классическом интерфейсе с их эквивалентами в новом интерфейсе Edge в management-ui.properties:
| Ресурс с классическим интерфейсом | Новое свойство пользовательского интерфейса Edge | По умолчанию | Примечания |
|---|---|---|---|
conf_application_session.maxage |
conf_uebe_authsessiontimeout |
12 (часов) |
Время, по истечении которого сеанс пользователя после входа в систему завершается. Укажите количество часов (например, 12 или 0.5) или длительность с единицей измерения h (часы) или m (минуты), например 24h или 90m. Значения 12 и 12h эквивалентны. Единица измерения d (дней) не поддерживается. Например, замените 1d на 24h. Если значение недопустимо, используется значение по умолчанию (12 часов) и не сообщается об ошибке. Применяется к сеансам, в которых используется базовая аутентификация.
|
conf_application_session.secure |
Не требуется | Неприменимо |
Новый интерфейс Edge автоматически устанавливает флаг Secure для файлов cookie сеанса, когда включен протокол TLS (conf_uebe_usehttps=true) или когда TLS завершается на балансировщике нагрузки (conf_uebe_tlsoffload=true).
|
conf/application.conf+trustxforwarded |
conf_uebe_usehttps=true и conf_uebe_tlsoffload=true
|
false |
Задайте оба свойства, если трафик TLS не идет дальше балансировщика нагрузки. Балансировщик нагрузки должен пересылать запросы в новый интерфейс Edge по протоколу HTTP и задавать заголовок X-Forwarded-Proto. Команда configure-ssl задает эти свойства, когда MANAGEMENT_UI_SCHEME=https и MANAGEMENT_UI_TLS_OFFLOAD=y. Подробнее о том, как настроить TLS для нового интерфейса Edge…
|
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate
|
conf_uebe_skipverify |
false |
Установите значение true, только если сервер управления использует самозаверяющий сертификат. Подробнее о том, как настроить TLS для Management API…
|
Настройка свойств и шаблонов электронных писем
Сопоставьте свойства отправителя, темы, брендинга, URL хоста и срока действия ссылки в классическом интерфейсе со свойствами в новом интерфейсе Edge:
| Ресурс с классическим интерфейсом | Новое свойство пользовательского интерфейса Edge | По умолчанию | Примечания |
|---|---|---|---|
conf_apigee_apigee.mgmt.mailfrom |
conf_apigee_apigee.mgmt.mailfrom |
Apigee <sales@apigee.com> или значение SMTPMAILFROM, указанное при установке.
|
Без изменений. |
conf_apigee-base_apigee.emails.passwordreset.subject
|
conf_apigee_apigee.emails.passwordReset.subject |
Password Reset Request |
Обратите внимание на сегмент свойства passwordReset в формате camelCase. |
conf_apigee-base_apigee.emails.useraddedexisting.subject
|
conf_apigee_apigee.emails.userAddedExisting.subject |
You Have Been Added to an Organization {organization}
|
Обратите внимание на сегмент свойства userAddedExisting, написанный в стиле camelCase.
|
conf_apigee-base_apigee.emails.useraddednew.subject |
conf_apigee_apigee.emails.userAddedNew.subject |
An Account Has been Created for You at {companyNameShort}
|
Обратите внимание на сегмент свойства userAddedNew в формате camelCase. |
conf_apigee_apigee.branding.companynameshort |
conf_uebe_branding_companyNameShort |
Apigee |
Задает значение для плейсхолдера {companyNameShort} в темах и шаблонах писем.
|
conf_apigee_apigee.emails.hosturl |
conf_apigee_apigee.emails.hosturl |
Нет |
Без изменений. Если значение не задано, в ссылках для сброса пароля используется URL нового интерфейса Edge, указанный при установке, а в ссылках для приглашения пользователей – имя хоста запроса. Задайте это свойство, если пользователи получают доступ к новому интерфейсу Edge через балансировщик нагрузки или DNS-имя, например conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com".
|
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds
|
conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds
|
600 |
Применяется к ссылкам для сброса пароля и приглашения пользователей. |
В новом интерфейсе Edge используются встроенные шаблоны электронных писем. Чтобы использовать шаблоны, настроенные для классического интерфейса:
-
Создайте каталог
/opt/apigee/edge-management-ui/email-templates. -
Скопируйте из каталога резервных копий, созданного до обновления (например,
/opt/apigee/customer/backup/), в каталог/opt/apigee/edge-management-ui/email-templatesфайлыpassword-reset.html,user-added-existing.htmlиuser-added-new.html. Названия файлов шаблонов и плейсхолдеры такие же, как и в классическом интерфейсе. -
Убедитесь, что каталог и файлы принадлежат пользователю
apigee. - Перезапустите новый интерфейс Edge.
Подробнее о настройке шаблонов электронных писем Edge…
Настройте свойства автоматически создаваемых паролей
Сопоставьте автоматически созданные свойства пароля классического интерфейса с новым интерфейсом Edge:
| Классический интерфейс | Новое свойство пользовательского интерфейса Edge | По умолчанию |
|---|---|---|
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 |
Как настроить подключение к серверу управления и свойства общего секрета
Сопоставьте свойства подключения, учетных данных и секрета приложения сервера управления классическим пользовательским интерфейсом с новым пользовательским интерфейсом Edge:
| Классический интерфейс | Новое свойство пользовательского интерфейса Edge | Примечания |
|---|---|---|
conf_apigee_apigee.mgmt.baseurl |
mgmt_baseurl |
URL API управления, например https://FQ_domain_name:port/v1. Название этого свойства не начинается с conf_. Если сервер управления использует самозаверяющий сертификат, также задайте значение conf_uebe_skipverify=true.
|
conf_apigee_apigee.mgmt.credential |
conf_uebe_mgmtCredential |
Зашифрованные учетные данные sysadmin. Вам нужно снова зашифровать учетные данные для New Edge UI с помощью ./bin/management-ui --encrypt. Подробнее о том,
как настроить разные учетные данные системного администратора…
|
conf_apigee_mail.smtp.credential |
conf_apigee_mail.smtp.credential |
Зашифрованные учетные данные SMTP. |
conf_application_application.secret |
conf_uebe_applicationsecret |
Секрет, используемый для шифрования учетных данных и файлов cookie сеанса. Создано во время установки. |
Удаление свойств классического интерфейса, для которых не требуется никаких действий
У следующих свойств классического интерфейса нет эквивалентов в новом интерфейсе Edge, поскольку они всегда включены. Не включайте эти свойства в management-ui.properties (и удалите их из всех скриптов автоматической настройки):
| Классический интерфейс | Поведение в новом интерфейсе Edge |
|---|---|
conf_apigee_apigee.feature.expireSessionCookiesInternally
|
Срок действия сеанса всегда проверяется на сервере. |
conf_apigee_apigee.feature.trackSessionCookies |
Информация о сеансе всегда хранится в памяти сервера. Если вы используете несколько экземпляров New Edge UI за балансировщиком нагрузки, настройте балансировщик нагрузки на использование закрепленных сеансов. |
Удаление неподдерживаемых свойств классического интерфейса
Следующие свойства классического интерфейса не поддерживаются и не имеют аналогов в новом интерфейсе Edge: Не добавляйте эти свойства в элемент management-ui.properties и удалите их из всех автоматизированных скриптов конфигурации:
| Ресурс с классическим интерфейсом | Описание |
|---|---|
conf_apigee_apigee.feature.apitimeout,
conf_apigee_play.ws.timeout.idle,
conf_apigee_play.ws.timeout.connection
|
Время ожидания для вызовов Management API нельзя настроить в новом интерфейсе Edge. |
conf_application_http.proxyhost,
conf_application_http.proxyport,
conf_application_http.proxyuser,
conf_application_http.proxypassword
|
Новый интерфейс Edge не поддерживает прямой прокси-сервер для запросов инструмента трассировки. |
conf_apigee-base_apigee.feature.enableconsentbanner,
conf_apigee-base_apigee.consentbanner.buttoncaption,
conf_apigee-base_apigee.consentbanner.body
|
Баннер с запросом согласия не поддерживается в новом интерфейсе Edge. |
conf_apigee-base_apigee.feature.apiproxypaginationenabled,
conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize
|
В новом интерфейсе Edge список прокси-серверов API всегда загружается на страницах. Размер страницы настроить нельзя. |
conf_logger_settings_application_log_level,
conf_logger_settings_play_log_level,
conf_application_logger.application
|
В новом интерфейсе Edge уровень ведения журнала не настраивается. Файлы журнала записываются в каталог /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
|
Новый интерфейс Edge не работает на виртуальной машине Java. Настройки памяти Java не применяются. |
Пример переноса
В примере ниже сравниваются файл ui.properties из классического интерфейса и эквивалентный файл management-ui.properties из нового интерфейса Edge.
Классический интерфейс, /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"
Новый интерфейс 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"
Обратите внимание, что логическое значение true не заключено в кавычки, а время ожидания сеанса 1d заменено на 24.
После сохранения файла перезапустите New Edge UI:
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart
Контрольный список
Чтобы завершить переход на новый интерфейс Edge в Apigee Edge для частного облака 4.54.00, воспользуйтесь следующим контрольным списком:
-
Перед обновлением создайте резервную копию
/opt/apigee/customer/application/ui.propertiesи всех настроенных шаблонов писем из/opt/apigee/edge-ui/email-templates. -
Добавьте сопоставленные свойства в
/opt/apigee/customer/application/management-ui.properties, не заключая логические или числовые значения в кавычки, и опустите неподдерживаемые свойства классического интерфейса. -
Скопируйте настроенные шаблоны писем из резервного каталога в
/opt/apigee/edge-management-ui/email-templates. -
Повторно зашифровать учетные данные системного администратора с помощью
./bin/management-ui --encrypt, если вы задалиconf_uebe_mgmtCredential. -
Назначьте владельцем файла пользователя
apigee:apigeeи перезапуститеedge-management-ui.