Установите новый пользовательский интерфейс Edge

В этом документе описывается установка Edge UI для Apigee Edge for Private Cloud. Edge UI — это новое поколение пользовательского интерфейса для Edge.

Предпосылки

Чтобы опробовать новый пользовательский интерфейс Edge в установке Apigee Edge for Private Cloud, необходимо:

  • Установите Edge UI на отдельный узел. Его нельзя установить на узел, содержащий другие компоненты Edge, включая узел, на котором находится существующий Classic UI. В противном случае пользователи не смогут войти в Classic UI.

    Узел Edge UI должен соответствовать следующим требованиям:

    • ЯВА 1.8
    • 4 ГБ оперативной памяти
    • 2-ядерный
    • 60 ГБ дискового пространства
    • Сначала необходимо установить на узле версию 4.53.01 утилиты apigee-setup как описано в разделе Установка утилиты Edge apigee-setup .
    • Порт 3001 должен быть открыт. Это порт по умолчанию, используемый для запросов к Edge UI. Если вы изменяете порт с помощью свойств, описанных в файле конфигурации нового UE , убедитесь, что порт открыт.
  • Включите внешний IDP на Edge. Edge UI поддерживает SAML или LDAP в качестве механизма аутентификации.
  • (Только SAML IDP) Edge UI поддерживает только TLS версии 1.2. Поскольку подключение к SAML IDP осуществляется по TLS, при использовании SAML ваш IDP должен поддерживать TLS версии 1.2.

Дополнительную информацию об Edge UI см. в статье Новый Edge UI для частного облака .

Обзор установки

В общих чертах процесс установки Edge UI для Apigee Edge for Private Cloud выглядит следующим образом:

  • Добавьте новый узел в свой кластер
  • Войдите в новый узел
  • Загрузите утилиту apigee-setup
  • Создайте файл конфигурации и измените его, используя свои настройки.
  • Запустите утилиту apigee-setup
  • Войдите в систему и протестируйте новый UE.

При запуске на новом узле утилита apigee-setup :

  • Устанавливает базовый классический пользовательский интерфейс , называемый shoehorn , и настраивает классический пользовательский интерфейс на использование внешнего IDP для аутентификации в Edge.
  • Устанавливает новый Edge UI и настраивает Edge UI для использования внешнего IDP для аутентификации в Edge.

Что следует учесть перед установкой нового Edge UI

Как описано выше в разделе «Предварительные условия», для работы Edge UI требуется включить внешний IDP в Edge. Это означает, что аутентификация пользователей контролируется IDP, который настраивается на использование адресов электронной почты в качестве идентификатора пользователя. Поэтому все пользователи Edge UI должны быть зарегистрированы в IDP.

Классический пользовательский интерфейс, пользовательский интерфейс по умолчанию, установленный вместе с Apigee Edge для частного облака, не требует внешнего IDP. Он может использовать как IDP, так и базовую аутентификацию. Это означает, что вы можете:

  • Включите поддержку внешнего IDP в Edge, а также в классическом пользовательском интерфейсе и пользовательском интерфейсе Edge.

    В этом сценарии все пользователи Classic UI и Edge UI регистрируются в IDP. Информацию о добавлении новых пользователей в IDP см. в разделе Регистрация новых пользователей Edge .

  • Включите поддержку внешнего IDP в Edge, но оставьте базовую аутентификацию включённой. Edge UI использует IDP, а Classic UI по-прежнему использует базовую аутентификацию.

    В этом сценарии все пользователи Classic UI входят в систему с базовыми учётными данными аутентификации, которые хранятся в базе данных Edge SymasLDAP. Пользователи Edge UI регистрируются в IDP и входят в систему, используя SAML или LDAP.

    Однако пользователь классического пользовательского интерфейса не сможет войти в пользовательский интерфейс Edge, пока вы не добавите этого пользователя в IDP, как описано в разделе Регистрация новых пользователей Edge .

Изменения конфигурации установки по сравнению с предыдущими выпусками

Обратите внимание на следующие изменения в процедуре установки по сравнению с бета-версиями Edge UI.

Новый файл конфигурации Edge UI

Следующий файл конфигурации содержит всю информацию, необходимую для установки и настройки нового интерфейса Edge. Вы можете использовать один и тот же файл конфигурации для установки и настройки как интерфейса Shoehorn/Classic, так и интерфейса Edge.

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

Установить Edge UI

После создания и изменения файла конфигурации вы можете установить новый Edge UI на этот новый узел.

Чтобы установить Edge UI:

  1. Добавьте новый узел в ваш кластер.
  2. Войдите в новый узел как администратор.
  3. Установите на узел утилиту apigee-setup версии 4.53.01, как описано в разделе Установка утилиты Edge apigee-setup .
  4. Очистите всю кэшированную информацию с помощью Yum, выполнив следующую команду:
    sudo yum clean all
  5. Создайте файл конфигурации, как описано в разделе Файл конфигурации нового пользовательского интерфейса Edge, и убедитесь, что он принадлежит пользователю «apigee»:
    chown apigee:apigee configFile

    Обязательно внесите следующие изменения в файл конфигурации:

    • Измените значение свойства MANAGEMENT_UI_SSO_CSRF_SECRET в файле конфигурации на ваш секрет CSRF.
    • Настройте Edge для использования одного из следующих вариантов (новый пользовательский интерфейс Edge требует внешнего IDP):
      • САМЛ
      • LDAP

      Для получения дополнительной информации см. Обзор аутентификации внешних IDP .

  6. Настройте внешний IDP, указав пользователей, которым вы хотите предоставить доступ к Edge UI. Подробнее см. в разделе Регистрация новых пользователей Edge .
  7. На новом узле выполните следующую команду:
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

    Утилита apigee-setup устанавливает классический пользовательский интерфейс. Поверх классического пользовательского интерфейса установщик затем устанавливает Edge UI.

  8. Войдите в Edge UI, открыв следующий URL-адрес в браузере:
    http://new_edge_UI_IP:3001

    Где new_edge_UI_IP — IP-адрес узла, на котором размещен новый Edge UI.

    Edge запросит у вас внешние учетные данные IDP.

  9. Введите свои учетные данные.

    Откроется новый интерфейс Edge UI. Сведения об использовании Edge UI см. в статье Новый интерфейс Edge UI для частного облака .

    Если пользовательский интерфейс Edge не отображается, убедитесь, что порт 3001 открыт для внешних подключений.

Удалить новый пользовательский интерфейс

Чтобы удалить новый пользовательский интерфейс с узла, необходимо удалить как новый Edge UI, так и базовый Classic UI ( shoehorn ), который был установлен на узле во время процесса установки пользовательского интерфейса.

Чтобы удалить новый Edge UI:

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

Чтобы удалить базовый классический пользовательский интерфейс ( shoehorn ):

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

Чтобы удалить все компоненты Edge из узла:

  1. Остановите все службы Edge, работающие на машине:
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. Очистите кэш yum:
    sudo yum clean all
  3. Удалите все RPM-пакеты Apigee:
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. Удалить корневой каталог установки:
    sudo rm -rf /opt/apigee